com.atlassian.jira.issue
Interface RendererManager

All Known Implementing Classes:
DefaultRendererManager

public interface RendererManager

This is the main interface to the renderer components.


Method Summary
 java.util.List<JiraRendererPlugin> getAllActiveRenderers()
          Gets all the renderers in the system that have a RenderConfiguration in which the renderer is set as active.
 java.lang.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.
 java.lang.String getRenderedContent(FieldRenderContext fieldRenderContext)
           
 java.lang.String getRenderedContent(java.lang.String rendererType, java.lang.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.
 JiraRendererPlugin getRendererForField(FieldLayoutItem fieldConfig)
          This will returned the correct renderer for a provided field and a provided issue.
 JiraRendererPlugin getRendererForType(java.lang.String rendererType)
          Will return a field renderer for the given renderer type.
 

Method Detail

getAllActiveRenderers

java.util.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.

getRendererForType

JiraRendererPlugin getRendererForType(java.lang.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.

getRendererForField

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.

getRenderedContent

java.lang.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.

getRenderedContent

java.lang.String getRenderedContent(java.lang.String rendererType,
                                    java.lang.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.

getRenderedContent

java.lang.String getRenderedContent(FieldRenderContext fieldRenderContext)


Copyright © 2002-2010 Atlassian. All Rights Reserved.