Package com.atlassian.greenhopper.web.sidebar

Class BoardSidebarRenderer

java.lang.Object

com.atlassian.greenhopper.web.sidebar.BoardSidebarRenderer

public class BoardSidebarRenderer
extends Object

Class to assist with rendering a sidebar. Handles permission checks and determining which sidebar to show.

Constructor Summary

Constructors

Constructor

Description

BoardSidebarRenderer(com.atlassian.jira.security.JiraAuthenticationContext jiraAuthenticationContext, ProjectRapidViewService projectRapidViewService, com.atlassian.jira.bc.project.ProjectService projectService, SidebarPlaceholderRenderer sidebarPlaceholderRenderer, RapidViewPermissionService rapidViewPermissionService, SidebarDarkFeatureManager sidebarDarkFeatureManager, GlobalBoardDarkFeatureManager globalBoardDarkFeatureManager, SoftwareProjectTypeService softwareProjectTypeService, com.atlassian.webresource.api.assembler.PageBuilderService pageBuilderService)

Method Summary

Modifier and Type	Method	Description
String	getSidebarHtml(String projectKey, RapidView rapidView)	Get the board sidebar HTML.
boolean	shouldShowSidebar(String projectKey, RapidView rapidView)	Only show the sidebar if the dark feature is enabled, the current user can see the RapidView for which the sidebar is being rendered AND the conditions to shown one of the sidebars are true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BoardSidebarRenderer

@Autowired
public BoardSidebarRenderer(com.atlassian.jira.security.JiraAuthenticationContext jiraAuthenticationContext,
 ProjectRapidViewService projectRapidViewService,
 com.atlassian.jira.bc.project.ProjectService projectService,
 SidebarPlaceholderRenderer sidebarPlaceholderRenderer,
 RapidViewPermissionService rapidViewPermissionService,
 SidebarDarkFeatureManager sidebarDarkFeatureManager,
 GlobalBoardDarkFeatureManager globalBoardDarkFeatureManager,
 SoftwareProjectTypeService softwareProjectTypeService,
 com.atlassian.webresource.api.assembler.PageBuilderService pageBuilderService)

Method Details

getSidebarHtml

public String getSidebarHtml(String projectKey,
 RapidView rapidView)

Get the board sidebar HTML.

This method will return an empty string if either the project centric navigation dark feature isn't enabled, or rendering the sidebar fails.

Parameters:

projectKey - key for Project to use if project sidebar is rendered

rapidView - the RapidView being rendered

Returns:

Board sidebar HTML or an empty string.

shouldShowSidebar

public boolean shouldShowSidebar(String projectKey,
 RapidView rapidView)

Only show the sidebar if the dark feature is enabled, the current user can see the RapidView for which the sidebar is being rendered AND the conditions to shown one of the sidebars are true.

Parameters:

projectKey - key for Project to use if project sidebar is rendered

rapidView - the RapidView being rendered

Returns:

true if the sidebar should be shown and false otherwise