public class

DefaultRendererManager

extends Object
implements RendererManager
java.lang.Object
   ↳ com.atlassian.jira.issue.managers.DefaultRendererManager

Class Overview

The default implementation of a RendererManager.

Summary

Public Constructors
DefaultRendererManager(PluginAccessor pluginAccessor)
Public Methods
@EventListener void clearCacheOnPluginAvailable(PluginModuleAvailableEvent event)
Refresh the list of rendererPlugins if we get a plugin system event.
@EventListener void clearCacheOnPluginDisable(PluginModuleDisabledEvent event)
Refresh the list of rendererPlugins if we get a plugin system event.
@EventListener void clearCacheOnPluginEnable(PluginModuleEnabledEvent event)
Refresh the list of rendererPlugins if we get a plugin system event.
@EventListener void clearCacheOnUnavailable(PluginModuleUnavailableEvent event)
Refresh the list of rendererPlugins if we get a plugin system event.
List<JiraRendererPlugin> getAllActiveRenderers()
Gets all the renderers in the system that have a RenderConfiguration in which the renderer is set as active.
String getRenderedContent(String rendererType, String value, IssueRenderContext renderContext)
A convienience method that is the equivilant of calling the getRendererForField method and then invoking the render method on the returned renderer, using the value of the field that is associated with the issue.
String getRenderedContent(FieldRenderContext fieldRenderContext)
String getRenderedContent(FieldLayoutItem fieldConfig, Issue issue)
A convienience method that is the equivilant of calling the getRendererForField method and then invoking the render method on the returned renderer, using the value of the field that is associated with the issue.
JiraRendererPlugin getRendererForField(FieldLayoutItem fieldConfig)
This will returned the correct renderer for a provided field and a provided issue.
JiraRendererPlugin getRendererForType(String rendererType)
Will return a field renderer for the given renderer type.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.RendererManager

Public Constructors

public DefaultRendererManager (PluginAccessor pluginAccessor)

Public Methods

@EventListener public void clearCacheOnPluginAvailable (PluginModuleAvailableEvent event)

Refresh the list of rendererPlugins if we get a plugin system event.

Parameters
event PluginModuleAvailableEvent

@EventListener public void clearCacheOnPluginDisable (PluginModuleDisabledEvent event)

Refresh the list of rendererPlugins if we get a plugin system event.

Parameters
event PluginModuleAvailableEvent

@EventListener public void clearCacheOnPluginEnable (PluginModuleEnabledEvent event)

Refresh the list of rendererPlugins if we get a plugin system event.

Parameters
event PluginModuleAvailableEvent

@EventListener public void clearCacheOnUnavailable (PluginModuleUnavailableEvent event)

Refresh the list of rendererPlugins if we get a plugin system event.

Parameters
event PluginModuleUnavailableEvent

public List<JiraRendererPlugin> getAllActiveRenderers ()

Gets all the renderers in the system that have a RenderConfiguration in which the renderer is set as active.

Returns
  • a list containing Renderer objects whose RenderConfiguration in which the renderer is set as active.

public String getRenderedContent (String rendererType, String value, IssueRenderContext renderContext)

A convienience method that is the equivilant of calling the getRendererForField method and then invoking the render method on the returned renderer, using the value of the field that is associated with the issue. This will make sure that the passed context is initialized.

Parameters
rendererType is the renderer to use, if not resolved will fall back to the system default.
value is the value to render.
renderContext is the context to use for rendering.
Returns
  • a string that has been processed through the correct renderer, the string will be unprocessed if there was an error resolving renderers.

public String getRenderedContent (FieldRenderContext fieldRenderContext)

public String getRenderedContent (FieldLayoutItem fieldConfig, Issue issue)

A convienience method that is the equivilant of calling the getRendererForField method and then invoking the render method on the returned renderer, using the value of the field that is associated with the issue. This will make sure that the passed context is initialized.

Parameters
fieldConfig identifies the configuration of the System or Custom field that is the object of the renderering.
issue identifies the unique instance container of the field that will be rendered.
Returns
  • a string that has been processed through the correct renderer, the string will be processed through the default renderer if there was an error resolving the specified renderers.

public JiraRendererPlugin getRendererForField (FieldLayoutItem fieldConfig)

This will returned the correct renderer for a provided field and a provided issue. This method takes into account any system preferences for renderers and will return the correct system renderer.

Parameters
fieldConfig is the configuration object for the given field.
Returns
  • a field renderer that will be able to render the content of the specified field in the specified issue correctly.

public JiraRendererPlugin getRendererForType (String rendererType)

Will return a field renderer for the given renderer type. If the renderer does not exist for the type then this will return null.

Note: if there happens to be two renderers in the system with the same name (for example due to conflicting plugins) then this method will return the first plugin encountered. Plugin developers beware!

Parameters
rendererType a string identifier that uniquely identifies a renderer in the system.
Returns
  • an instance of a FieldRenderer for the requested type, null if no renderer exists for the type.