|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JiraRendererPlugin
The top-level interface that defines a renderer and its configuration within jira.
Method Summary | |
---|---|
JiraRendererModuleDescriptor |
getDescriptor()
Simple accessor method for the module descriptor. |
java.lang.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. |
java.lang.String |
render(java.lang.String value,
IssueRenderContext context)
This will render the provided value within the provided context and produce a rendered output. |
java.lang.String |
renderAsText(java.lang.String value,
IssueRenderContext context)
This will render the provided value within the provided context and produce a rendered output that is text readable. |
java.lang.Object |
transformForEdit(java.lang.Object rawValue)
This allows the renderer to perform a transformation on the raw value before populating an editable component with the value. |
java.lang.Object |
transformFromEdit(java.lang.Object editValue)
This allows the renderer to perform a transformation on the submitted edit value before storing the value in the system. |
Method Detail |
---|
java.lang.String render(java.lang.String value, IssueRenderContext context)
value
- the raw value to render.context
- the issue context for this rendering
java.lang.String renderAsText(java.lang.String value, IssueRenderContext context)
value
- the raw value to render.context
- the issue context for this rendering
java.lang.String getRendererType()
java.lang.Object transformForEdit(java.lang.Object rawValue)
rawValue
- is the value stored in the system, before transform.
java.lang.Object transformFromEdit(java.lang.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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |