@PublicSpi
@PublicApi
public interface JiraRendererPlugin
Modifier and Type | Method and Description |
---|---|
JiraRendererModuleDescriptor |
getDescriptor()
Simple accessor method for the module descriptor.
|
String |
getRendererType()
Returns a unique identifier for this renderer plugin.
|
void |
init(JiraRendererModuleDescriptor jiraRendererModuleDescriptor)
This allows a plugin to get a handle on the module descriptor that spawned the plugin.
|
String |
render(String value,
IssueRenderContext context)
This will render the provided value within the provided context and produce a
rendered output.
|
String |
renderAsText(String value,
IssueRenderContext context)
This will render the provided value within the provided context and produce a
rendered output that is text readable.
|
Object |
transformForEdit(Object rawValue)
This allows the renderer to perform a transformation on the raw value before populating
an editable component with the value.
|
Object |
transformFromEdit(Object editValue)
This allows the renderer to perform a transformation on the submitted edit value before
storing the value in the system.
|
String render(String value, IssueRenderContext context)
value
- the raw value to render.context
- the issue context for this renderingString renderAsText(String value, IssueRenderContext context)
value
- the raw value to render.context
- the issue context for this renderingString getRendererType()
Object transformForEdit(Object rawValue)
rawValue
- is the value stored in the system, before transform.Object transformFromEdit(Object editValue)
editValue
- is the value produced by the edit control.void init(JiraRendererModuleDescriptor jiraRendererModuleDescriptor)
jiraRendererModuleDescriptor
- is the module descriptor that spawned the plugin. If
the plugin uses resources, such as velocity templates, then access can be gained through
this descriptor.JiraRendererModuleDescriptor getDescriptor()
Copyright © 2002-2019 Atlassian. All Rights Reserved.