@PublicSpi public interface

IssueTabPanel

com.atlassian.jira.plugin.issuetabpanel.IssueTabPanel
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

This is the SPI for the issue-tabpanel JIRA module type. Issue tab panels allow plugins to display their content in the JIRA view issue screen. Examples of issue tab panels include the "Comment", "Work Log", and the "Source" tabs.

Plugins that target JIRA 5.0 and onwards probably want to implement IssueTabPanel2 or IssueTabPanel3 instead, especially if they need to support AJAX loading of the tab contents.

This plugin type is documented online.

See Also

Summary

Public Methods
List<IssueAction> getActions(Issue issue, ApplicationUser remoteUser)
Return a list of issue actions in the order that you want them to be displayed.
void init(IssueTabPanelModuleDescriptor descriptor)
boolean showPanel(Issue issue, ApplicationUser remoteUser)
Whether or not to show this tab panel to the given User for the given Issue.

Public Methods

public List<IssueAction> getActions (Issue issue, ApplicationUser remoteUser)

Return a list of issue actions in the order that you want them to be displayed.

Note that for the 'all' tab, they will be displayed in order according to the value returned by getTimePerformed().

The user that is viewing the tab can affect which objects are shown, as well as which operations are available on each.

Parameters
issue The Issue that the objects belong to.
remoteUser The user viewing this tab.
Returns

public void init (IssueTabPanelModuleDescriptor descriptor)

public boolean showPanel (Issue issue, ApplicationUser remoteUser)

Whether or not to show this tab panel to the given User for the given Issue.

Parameters
issue The Issue.
remoteUser The viewing user.
Returns
  • true if we should show this tab panel to the given User for the given Issue.