Summary: Methods | [Expand All]
public interface

WebPanelRenderer

com.atlassian.plugin.web.renderer.WebPanelRenderer
Known Indirect Subclasses

Class Overview

This interface allows the plugin system to be extended by adding new renderers for new markup formats. Currently the atlassian-template-renderer project provides a velocity implementation.

See Also
  • {@link com.atlassian.plugin.web.descriptors.WebPanelRendererModuleDescriptor#getModule()}

Summary

Public Methods
String getResourceType()
void render(String templateName, Plugin plugin, Map<String, Object> context, Writer writer)
Renders the template to the writer.
String renderFragment(String fragment, Plugin plugin, Map<String, Object> context)
Renders the fragment using the given context and adding I18nResolver and WebResourceManager.

Public Methods

public String getResourceType ()

Returns
  • the name of the resource type supported by this renderer. <resource> elements defined in plugin descriptors to be rendered by this renderer should specify this String as their type attribute.

public void render (String templateName, Plugin plugin, Map<String, Object> context, Writer writer)

Renders the template to the writer.

Parameters
templateName file name of the template to render
plugin the context plugin. Used, for example, to resolve templates and other resources from the classpath via getClassLoader()
context Map of objects to make available in the template rendering process
writer where to write the rendered template
Throws
RendererException thrown if there is an internal exception when rendering the template
IOException thrown if there is a problem reading the template file or writing to the writer

public String renderFragment (String fragment, Plugin plugin, Map<String, Object> context)

Renders the fragment using the given context and adding I18nResolver and WebResourceManager.

Parameters
fragment template fragment to render
plugin the context plugin. Used, for example, to resolve templates and other resources from the classpath via getClassLoader()
context Map of objects to make available in the template rendering process
Returns
  • rendered template
Throws
RendererException thrown if there is an internal exception when rendering the template