com.atlassian.jira.plugin.renderer

Interface JiraRendererModuleDescriptor

All Superinterfaces:

JiraResourcedModuleDescriptor<JiraRendererPlugin>, com.atlassian.plugin.ModuleDescriptor<JiraRendererPlugin>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware

All Known Implementing Classes:

JiraRendererModuleDescriptorImpl

@PublicApi
public interface JiraRendererModuleDescriptor
extends JiraResourcedModuleDescriptor<JiraRendererPlugin>

Descriptor that defines a JiraRendererModule.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATE_NAME_CSS
static String	TEMPLATE_NAME_EDIT
static String	TEMPLATE_NAME_JS

Method Summary

Modifier and Type	Method and Description
String	getCss()
String	getEditVM(String value, String issueKey, String rendererType, String fieldId, String fieldName, Map params, boolean singleLine) This render an editable input field for the given values based on the edit template provided for the renderer.
String	getJavaScript(String contextPath)
boolean	isCSSTemplateExists()
boolean	isEditTemplateExists()
boolean	isJavaScriptTemplateExists()

Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

getHtml, getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Field Detail

TEMPLATE_NAME_CSS

static final String TEMPLATE_NAME_CSS

See Also:

Constant Field Values

TEMPLATE_NAME_JS

static final String TEMPLATE_NAME_JS

See Also:

Constant Field Values

TEMPLATE_NAME_EDIT

static final String TEMPLATE_NAME_EDIT

See Also:

Constant Field Values

Method Detail

getCss

String getCss()

getJavaScript

String getJavaScript(String contextPath)

getEditVM

String getEditVM(String value,
                 String issueKey,
                 String rendererType,
                 String fieldId,
                 String fieldName,
                 Map params,
                 boolean singleLine)

This render an editable input field for the given values based on the edit template provided for the renderer.

Returns:

the renderered html for the edit input

isCSSTemplateExists

boolean isCSSTemplateExists()

isJavaScriptTemplateExists

boolean isJavaScriptTemplateExists()

isEditTemplateExists

boolean isEditTemplateExists()