|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.fields.renderer.wiki.AtlassianWikiRenderer
public class AtlassianWikiRenderer
Implementation of the a renderer plugin that exposes the Wiki renderer within Jira.
Field Summary | |
---|---|
static java.lang.String |
ISSUE_CONTEXT_KEY
|
static java.lang.String |
RENDERER_TYPE
|
Constructor Summary | |
---|---|
AtlassianWikiRenderer()
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ISSUE_CONTEXT_KEY
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public AtlassianWikiRenderer()
Method Detail |
---|
public java.lang.String render(java.lang.String value, IssueRenderContext context)
JiraRendererPlugin
render
in interface JiraRendererPlugin
value
- the raw value to render.context
- the issue context for this rendering
public java.lang.String renderAsText(java.lang.String value, IssueRenderContext context)
JiraRendererPlugin
renderAsText
in interface JiraRendererPlugin
value
- the raw value to render.context
- the issue context for this rendering
public java.lang.String getRendererType()
JiraRendererPlugin
getRendererType
in interface JiraRendererPlugin
public java.lang.Object transformForEdit(java.lang.Object rawValue)
JiraRendererPlugin
transformForEdit
in interface JiraRendererPlugin
rawValue
- is the value stored in the system, before transform.
public java.lang.Object transformFromEdit(java.lang.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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |