Package com.atlassian.jira.plugin.issuetabpanel

Interface PaginatedIssueTabPanel

All Known Implementing Classes:
AllTabPanel, ChangeHistoryTabPanel, CommentTabPanel, PaginatedIssueTabPanelAdaptor, PaginatedReferenceIssueTabPanel, WorklogTabPanel
@PublicSpi public interface PaginatedIssueTabPanel
This is the SPI for the issue-tabpanel JIRA module type, which allows to support pagination. 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 "Change History" tabs.

This plugin type is documented online.

Since:
v9.0
See Also:

  • Method Details

    • init

      void init(IssueTabPanelModuleDescriptor descriptor)

    • showPanel

      boolean showPanel(ShowPanelRequest request)
      Indicates whether this tab should be shown on a given issue.
      Parameters:
      request - a ShowPanelRequest
      Returns:
      a boolean indicating whether to show the panel or not

    • getActions

      Page<IssueAction> getActions(GetActionsRequest request)
      Returns a sorted list of issue actions wrapped in a Page object. This method will only be called if showPanel returned true for a given context. The request parameter contains the user that is viewing the tab, information as to whether the tab is being loaded using an AJAX request, and so on.

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

      Parameters:
      request - a GetActionsRequest
      Returns:
      the actions to display

    • paginationSupported

      default boolean paginationSupported()
      Indicates whether the tab supports pagination.
      Returns:
      true if pagination is supported in the tab, false otherwise

    • getPersistentMarkup

      default String getPersistentMarkup(GetActionsRequest request)
      Allows implementors to provide additional HTML code to the page. It will be added always, as long as showPanel(com.atlassian.jira.plugin.issuetabpanel.ShowPanelRequest) returns true.
      Returns:
      HTML to be added inside the activity tabs, or an empty string

    • getHeader

      default String getHeader(GetActionsRequest request)