com.atlassian.jira.plugin.browsepanel
Interface TabPanel<D extends AbstractTabPanelModuleDescriptor,C extends BrowseContext>

All Known Subinterfaces:
ComponentTabPanel, ProjectTabPanel, VersionTabPanel
All Known Implementing Classes:
AbstractFragmentBasedComponentTabPanel, AbstractFragmentBasedTabPanel, AbstractFragmentBasedVersionTabPanel, AbstractProjectTabPanel, ChangeLogProjectTabPanel, ChangeLogTabPanel, ComponentsProjectTabPanel, ComponentsVersionsProjectTabPanel, GenericProjectTabPanel, GenericTabPanel, GenericTabPanel, GenericVersionsProjectTabPanel, ImportantProjectTabPanel, IssuesComponentTabPanel, IssuesProjectTabPanel, IssuesVersionTabPanel, LabelsHeatmapProjectTabPanel, PopularIssuesProjectTabPanel, PopularIssuesTabPanel, PopularIssuesTabPanel, RoadMapProjectTabPanel, RoadMapTabPanel, SummaryComponentTabPanel, SummaryProjectTabPanel, SummaryVersionTabPanel, VersionsProjectTabPanel

public interface TabPanel<D extends AbstractTabPanelModuleDescriptor,C extends BrowseContext>

Unified interface for all fragment-based tab panels.

Since:
v4.0

Method Summary
 java.lang.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

java.lang.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.


Copyright © 2002-2010 Atlassian. All Rights Reserved.