Interface IssueTabPanel
- All Known Subinterfaces:
IssueTabPanel2
- All Known Implementing Classes:
AbstractIssueTabPanel
,AbstractIssueTabPanel2
,ReferenceIssueTabPanel
@PublicSpi
public interface IssueTabPanel
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:
-
Method Summary
Modifier and TypeMethodDescriptiongetActions
(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.
-
Method Details
-
init
-
getActions
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
IssueAction.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:
- A List of
IssueAction
objects.
-
showPanel
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.
-