com.atlassian.plugin.web.renderer
Interface WebPanelRenderer

All Known Implementing Classes:

StaticWebPanelRenderer

public interface WebPanelRenderer

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.

Since:

2.5.0

See Also:

com.atlassian.plugin.web.descriptors.WebPanelRendererModuleDescriptor#getModule()}

Method Summary

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) Deprecated. since 2.11. Use renderFragment(java.io.Writer, String, com.atlassian.plugin.Plugin, java.util.Map) instead. Method no longer used inside the atlassian-plugins-webfragment module.
void	renderFragment(Writer writer, String fragment, Plugin plugin, Map<String,Object> context) Renders the fragment using the given context and adding I18nResolver and WebResourceManager, writing the output to the provided writer.

Method Detail

getResourceType

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.

render

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

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 Plugin.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

renderFragment

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

Deprecated. since 2.11. Use renderFragment(java.io.Writer, String, com.atlassian.plugin.Plugin, java.util.Map) instead. Method no longer used inside the atlassian-plugins-webfragment module.

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 Plugin.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

renderFragment

void renderFragment(Writer writer,
                    String fragment,
                    Plugin plugin,
                    Map<String,Object> context)
                    throws RendererException,
                           IOException

Renders the fragment using the given context and adding I18nResolver and WebResourceManager, writing the output to the provided writer.

Parameters:

writer - the writer to append the output to

fragment - template fragment to render

plugin - the context plugin. Used, for example, to resolve templates and other resources from the classpath via Plugin.getClassLoader()

context - Map of objects to make available in the template rendering process

Throws:

RendererException - thrown if there is an internal exception when rendering the template

IOException - if there is some problem writing to the supplied writer

Since:

2.11