com.atlassian.plugin.web.model
Class AbstractWebPanel

java.lang.Object
  com.atlassian.plugin.web.model.AbstractWebPanel

All Implemented Interfaces:

WebPanel

Direct Known Subclasses:

EmbeddedTemplateWebPanel, ResourceTemplateWebPanel

public abstract class AbstractWebPanel
extends Object
implements WebPanel

Since:

2.5.0

Field Summary

protected Plugin

plugin

Constructor Summary

protected

AbstractWebPanel(PluginAccessor pluginAccessor)

Method Summary

protected WebPanelRenderer	getRenderer()
void	setPlugin(Plugin plugin)
void	setResourceType(String resourceType)
void	writeHtml(Writer writer, Map<String,Object> context) Default implementation of WebPanel.writeHtml(java.io.Writer, java.util.Map) that delegates to WebPanel.getHtml(java.util.Map).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.web.model.WebPanel

getHtml

Field Detail

plugin

protected Plugin plugin

Constructor Detail

AbstractWebPanel

protected AbstractWebPanel(PluginAccessor pluginAccessor)

Method Detail

setPlugin

public void setPlugin(Plugin plugin)

setResourceType

public void setResourceType(String resourceType)

writeHtml

public void writeHtml(Writer writer,
                      Map<String,Object> context)
               throws IOException

Default implementation of WebPanel.writeHtml(java.io.Writer, java.util.Map) that delegates to WebPanel.getHtml(java.util.Map). This method is provided for backwards compatibility with pre-2.11 implementations of WebPanel. Panels SHOULD be upgraded to support this method natively for performance reasons.

Specified by:

writeHtml in interface WebPanel

Parameters:

writer - the writer to append the panel output to

context - the contextual information that can be used during rendering. Context elements are not standardized and are application-specific, so refer to your application's documentation to learn what is available.

Throws:

IOException

getRenderer

protected final WebPanelRenderer getRenderer()