public abstract class

AbstractFragmentBasedTabPanel

extends Object
implements TabPanel<D extends AbstractTabPanelModuleDescriptor, C extends BrowseContext>
java.lang.Object
   ↳ com.atlassian.jira.plugin.browsepanel.AbstractFragmentBasedTabPanel<D extends com.atlassian.jira.plugin.AbstractTabPanelModuleDescriptor, C extends com.atlassian.jira.project.browse.BrowseContext, F extends com.atlassian.jira.plugin.projectpanel.fragment.ProjectTabPanelFragment>
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract base for TabPanel implementers to extend. This looks after the layout of all the fragments on the page and delegates content to the ProjectTabPanelFragment.

Summary

Fields
protected D extends AbstractTabPanelModuleDescriptor moduleDescriptor
Public Constructors
AbstractFragmentBasedTabPanel()
Public Methods
String createEmptyContent()
Create content for when there ae no fragments shown.
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 context)
Determine whether or not to show this.
Protected Methods
abstract List<F> getLeftColumnFragments(C ctx)
List<MenuFragment> getMenuFragments()
abstract List<F> getRightColumnFragments(C ctx)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.plugin.browsepanel.TabPanel

Fields

protected D extends AbstractTabPanelModuleDescriptor moduleDescriptor

Public Constructors

public AbstractFragmentBasedTabPanel ()

Public Methods

public String createEmptyContent ()

Create content for when there ae no fragments shown.

Returns
  • the html for the empty content.

public 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.

public 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.

public boolean showPanel (C context)

Determine whether or not to show this.

Parameters
context The current context the tab is rendering in.
Returns
  • True if the conditions are right to display tab, otherwise false.

Protected Methods

protected abstract List<F> getLeftColumnFragments (C ctx)

Parameters
ctx the browse context
Returns
  • a list of fragments to be displayed in the left column of the project tab panel

protected List<MenuFragment> getMenuFragments ()

Returns
  • a list of fragments to be displayed in the menu section of the panel

protected abstract List<F> getRightColumnFragments (C ctx)

Parameters
ctx the browse context
Returns
  • a list of fragments to be displayed in the right column of the project tab panel