public interface WebPanelRenderer
WebPanelRendererModuleDescriptor.getModule()| Modifier and Type | Method and Description |
|---|---|
String |
getResourceType() |
void |
render(String templateName,
com.atlassian.plugin.Plugin plugin,
Map<String,Object> context,
Writer writer)
Renders the template to the writer.
|
String |
renderFragment(String fragment,
com.atlassian.plugin.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,
com.atlassian.plugin.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. |
String getResourceType()
<resource> elements defined in plugin
descriptors to be rendered by this renderer should specify this String as their type attribute.void render(String templateName, com.atlassian.plugin.Plugin plugin, Map<String,Object> context, Writer writer) throws RendererException, IOException
templateName - file name of the template to renderplugin - 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 processwriter - where to write the rendered templateRendererException - thrown if there is an internal exception when rendering the templateIOException - thrown if there is a problem reading the template file or writing to the writerString renderFragment(String fragment, com.atlassian.plugin.Plugin plugin, Map<String,Object> context) throws RendererException
renderFragment(java.io.Writer, String, com.atlassian.plugin.Plugin, java.util.Map)
instead. Method no longer used inside the atlassian-plugins-webfragment module.fragment using the given context and adding I18nResolver and WebResourceManager.fragment - template fragment to renderplugin - 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 processRendererException - thrown if there is an internal exception when rendering the templatevoid renderFragment(Writer writer, String fragment, com.atlassian.plugin.Plugin plugin, Map<String,Object> context) throws RendererException, IOException
fragment using the given context and adding I18nResolver and WebResourceManager, writing the output to the provided writer.writer - the writer to append the output tofragment - template fragment to renderplugin - 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 processRendererException - thrown if there is an internal exception when rendering the templateIOException - if there is some problem writing to the supplied writerCopyright © 2018 Atlassian. All rights reserved.