Package com.atlassian.jira.projects.sidebar

Class ProjectSidebarRendererImpl

java.lang.Object

com.atlassian.jira.projects.sidebar.ProjectSidebarRendererImpl

All Implemented Interfaces:

ProjectSidebarRenderer

@Component
public class ProjectSidebarRendererImpl
extends Object
implements ProjectSidebarRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SHOULD_DISPLAY_CHAPERONE

Fields inherited from interface com.atlassian.jira.projects.api.sidebar.ProjectSidebarRenderer

LEGACY_TABS_LINKS_SIDEBAR_SECTION_KEY, MAIN_SIDEBAR_SECTION_KEY, PLUGIN_LINKS_SIDEBAR_SECTION_KEY

Constructor Summary

Constructors

Constructor

Description

ProjectSidebarRendererImpl(ProjectHeaderRenderer projectHeaderRenderer, ProjectContentRendererRegistry contentRendererRegistry, SidebarRenderer sidebarRenderer, ProjectAdminLinkService adminLinkProvider, ProjectService projectService, JiraAuthenticationContext jiraAuthenticationContext, JiraPageBuilderService pageBuilderService, OnboardingServiceAccessor onboardingServiceAccessor, com.atlassian.event.api.EventPublisher eventPublisher, CurrentProjectService currentProjectService, FlushHeadEarlyService flushHeadEarlyService, FeatureManager featureManager)

Method Summary

Modifier and Type	Method	Description
String	render(Project project, String selectedItemId)	Render a project sidebar.
io.atlassian.fugue.Either<ErrorCollection,String>	render(String projectKey, String selectedItemId)	Render a project sidebar.
void	requireResources(Project project, String selectedItemId)	Requires the resources needed for displaying this sidebar.

Methods inherited from class java.lang.Object

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

Field Details

SHOULD_DISPLAY_CHAPERONE

public static final String SHOULD_DISPLAY_CHAPERONE

See Also:

• Constant Field Values

Constructor Details

ProjectSidebarRendererImpl

@Autowired
public ProjectSidebarRendererImpl(ProjectHeaderRenderer projectHeaderRenderer,
 ProjectContentRendererRegistry contentRendererRegistry,
 SidebarRenderer sidebarRenderer,
 ProjectAdminLinkService adminLinkProvider,
 ProjectService projectService,
 JiraAuthenticationContext jiraAuthenticationContext,
 JiraPageBuilderService pageBuilderService,
 OnboardingServiceAccessor onboardingServiceAccessor,
 com.atlassian.event.api.EventPublisher eventPublisher,
 CurrentProjectService currentProjectService,
 FlushHeadEarlyService flushHeadEarlyService,
 FeatureManager featureManager)

Method Details

render

public String render(Project project,
 String selectedItemId)

Description copied from interface: ProjectSidebarRenderer

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.

Specified by:

render in interface ProjectSidebarRenderer

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

public io.atlassian.fugue.Either<ErrorCollection,String> render(String projectKey,
 String selectedItemId)

Description copied from interface: ProjectSidebarRenderer

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.

Specified by:

render in interface ProjectSidebarRenderer

Parameters:

projectKey - A project key.

selectedItemId - The ID of the selected item.

Returns:

Project sidebar HTML or an error collection.

requireResources

public void requireResources(Project project,
 String selectedItemId)

Description copied from interface: ProjectSidebarRenderer

Requires the resources needed for displaying this sidebar.

Specified by:

requireResources in interface ProjectSidebarRenderer

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.