com.atlassian.jira.plugin.browsepanel

Interface TabPanel<D extends TabPanelModuleDescriptor,C extends BrowseContext>

All Known Subinterfaces:

ComponentTabPanel, ProjectTabPanel, VersionTabPanel

All Known Implementing Classes:

AbstractProjectTabPanel, GenericProjectTabPanel, GenericTabPanel, GenericTabPanel, GenericVersionsProjectTabPanel, ReferenceProjectTabPanel

@PublicSpi
public interface TabPanel<D extends TabPanelModuleDescriptor,C extends BrowseContext>

Unified interface for all fragment-based tab panels.

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
String	getHtml(C ctx) Used to render the tab.
void	init(D descriptor) Initialize the tab panel panel with the plugins ProjectTabPanelModuleDescriptor.
boolean	showPanel(C ctx) Determine whether or not to show this.

Method Detail

init

void init(D descriptor)

Initialize the tab panel panel with the plugins ProjectTabPanelModuleDescriptor. This is usually used for rendering velocity views.

Parameters:

descriptor - the descriptor for this module as defined in the plugin xml descriptor.

getHtml

String getHtml(C ctx)

Used to render the tab.

Parameters:

ctx - The current context the tab is rendering in.

Returns:

Escaped string with the required html.

showPanel

boolean showPanel(C ctx)

Determine whether or not to show this.

Parameters:

ctx - The current context the tab is rendering in.

Returns:

True if the conditions are right to display tab, otherwise false.