com.atlassian.jira.issue.RendererManager |
Known Indirect Subclasses |
Clients of @PublicApi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicApi
as per each product's API policy as long as the client does not implement/extend
@PublicApi
interfaces or classes (refer to each product's API policy for the exact
guarantee---usually binary compatibility is guaranteed at least across minor versions).
@PublicApi
interfaces and classes are not designed to be implemented or extended by clients,
we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not
affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces
annotated with @PublicSpi
are safe to extend/implement).
This is the main interface to the renderer components.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets all the renderers in the system that have a RenderConfiguration in which the renderer is set as active.
| |||||||||||
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.
| |||||||||||
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 returned the correct renderer for a provided field and a provided issue.
| |||||||||||
Will return a field renderer for the given renderer type.
|
Gets all the renderers in the system that have a RenderConfiguration in which the renderer is set as active.
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.
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. |
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.
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. |
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.
fieldConfig | is the configuration object for the given field. |
---|
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!
rendererType | a string identifier that uniquely identifies a renderer in the system. |
---|