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

Interface ProjectContentRendererRegistry

All Known Implementing Classes:

ProjectContentRendererRegistryImpl

public interface ProjectContentRendererRegistry

Provides a registry of ProjectContentRenderer. This registry allows products to specify a ProjectContentRenderer for a particular Project Type, allowing them to customize the content of the Navigation panel in the Sidebar.

Since:

v3.0.3

Method Summary

Modifier and Type	Method	Description
ProjectContentRenderer	getRenderer(ProjectTypeKey projectTypeKey)	Returns the registered ProjectContentRenderer for the given ProjectTypeKey, with two exceptions: the given projectTypeKey doesn't have a ProjectContentRenderer registered, or the ProjectTypesDarkFeature is not enabled.
void	register(ProjectTypeKey projectType, ProjectContentRenderer renderer)	Registers a ProjectContentRenderer for a given ProjectTypeKey.
void	unregister(ProjectTypeKey projectType)	Un-registers *any* ProjectContentRenderer associated to a ProjectTypeKey.

Method Details

register

void register(ProjectTypeKey projectType,
 ProjectContentRenderer renderer)

Registers a ProjectContentRenderer for a given ProjectTypeKey. If that ProjectTypeKey already has a ProjectContentRenderer, it is replaced.

Parameters:

projectType - The key to register.

renderer - The renderer to use.

unregister

void unregister(ProjectTypeKey projectType)

Un-registers *any* ProjectContentRenderer associated to a ProjectTypeKey. After calling this method, calling getRenderer() with the same ProjectTypeKey will always return the default ProjectContentRenderer

Parameters:

projectType - The key to unregister.

getRenderer

ProjectContentRenderer getRenderer(ProjectTypeKey projectTypeKey)

Returns the registered ProjectContentRenderer for the given ProjectTypeKey, with two exceptions: the given projectTypeKey doesn't have a ProjectContentRenderer registered, or the ProjectTypesDarkFeature is not enabled. In those two cases, this method will return the default ProjectContentRenderer used in the sidebar for Business types.

Parameters:

projectTypeKey - The key to get.

Returns:

The renderer associated to the key, or the render used for Business types.