public class ReferenceJiraRenderer extends Object implements JiraRendererPlugin
Modifier and Type | Field and Description |
---|---|
static String |
RENDERER_TYPE |
Constructor and Description |
---|
ReferenceJiraRenderer() |
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.
|
protected String |
prefix()
Prefix for rendered text, may be HTML.
|
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.
|
public static final String RENDERER_TYPE
public String render(String value, IssueRenderContext context)
JiraRendererPlugin
render
in interface JiraRendererPlugin
value
- the raw value to render.context
- the issue context for this renderingprotected String prefix()
public String renderAsText(String value, IssueRenderContext context)
JiraRendererPlugin
renderAsText
in interface JiraRendererPlugin
value
- the raw value to render.context
- the issue context for this renderingpublic String getRendererType()
JiraRendererPlugin
getRendererType
in interface JiraRendererPlugin
public Object transformForEdit(Object rawValue)
JiraRendererPlugin
transformForEdit
in interface JiraRendererPlugin
rawValue
- is the value stored in the system, before transform.public Object transformFromEdit(Object editValue)
JiraRendererPlugin
transformFromEdit
in interface JiraRendererPlugin
editValue
- is the value produced by the edit control.public void init(JiraRendererModuleDescriptor jiraRendererModuleDescriptor)
JiraRendererPlugin
init
in interface JiraRendererPlugin
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.public JiraRendererModuleDescriptor getDescriptor()
JiraRendererPlugin
getDescriptor
in interface JiraRendererPlugin
Copyright © 2002-2024 Atlassian. All Rights Reserved.