Package com.atlassian.jira.projects.api.sidebar

Interface ProjectSidebarRenderer

All Known Implementing Classes:
ProjectSidebarRendererImpl
public interface ProjectSidebarRenderer
Renders project sidebar HTML.
Since:
v1.1.0

  • Field Details

    • MAIN_SIDEBAR_SECTION_KEY

      static final String MAIN_SIDEBAR_SECTION_KEY
      The main section for web-items placed in sidebar
      See Also:

  • Method Details

    • render

      String render(Project project, String selectedItemId)
      Render a project sidebar. Users of this method are responsible for including the appropriate web-resources to hook up client-side behaviour of the sidebar themselves. This means they should at least include resources in the 'jira.project.sidebar' web-resource context.
      Parameters:
      project - A project object representing the project for which the sidebar should be rendered.
      selectedItemId - The location ID of the <web-item> which should be rendered.
      Returns:
      Project sidebar HTML or an error collection.

    • render

      io.atlassian.fugue.Either<ErrorCollection,String> render(String projectKey, String selectedItemId)
      Deprecated.
      since v1.2.0. Use render(com.atlassian.jira.project.Project, String) instead
      Render a project sidebar. Users of this method are responsible for including the appropriate web-resources to hook up client-side behaviour of the sidebar themselves. This means they should at least include resources in the 'jira.project.sidebar' web-resource context. Rendering can fail if the specified project doesn't exist or the current user doesn't have permission to view it.
      Parameters:
      projectKey - A project key.
      selectedItemId - The ID of the selected item.
      Returns:
      Project sidebar HTML or an error collection.

    • requireResources

      void requireResources(Project project, String selectedItemId)
      Requires the resources needed for displaying this sidebar.
      Parameters:
      project - A project object representing the project for which the sidebar should be rendered.
      selectedItemId - The location ID of the <web-item> which should be rendered.