Summary: Methods | [Expand All]
@PublicSpi public interface

TabPanel

com.atlassian.jira.plugin.browsepanel.TabPanel<D extends com.atlassian.jira.plugin.TabPanelModuleDescriptor, C extends com.atlassian.jira.project.browse.BrowseContext>
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Unified interface for all fragment-based tab panels.

Summary

Public Methods
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.

Public Methods

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