com.atlassian.plugin.web.model
Interface WebPanel

All Known Implementing Classes:

AbstractWebPanel, EmbeddedTemplateWebPanel, ResourceTemplateWebPanel

public interface WebPanel

The module that is responsive for providing the raw content for a Web Panel. Whatever is returned by getHtml(java.util.Map) is inserted into the host application's page, so it has to be valid HTML.

Since:

2.5.0

See Also:

DefaultWebPanelModuleDescriptor.getModule()

Method Summary

java.lang.String

getHtml(java.util.Map<java.lang.String,java.lang.Object> context) Returns the HTML that will be placed in the host application's page.

Method Detail

getHtml

java.lang.String getHtml(java.util.Map<java.lang.String,java.lang.Object> context)

Returns the HTML that will be placed in the host application's page.

Parameters:

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.

Returns:

the HTML that will be placed in the host application's page.