com.atlassian.jira.plugin.renderer
Class JiraRendererModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<JiraRendererPlugin>
          com.atlassian.jira.plugin.renderer.JiraRendererModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<JiraRendererPlugin>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class JiraRendererModuleDescriptor
extends JiraResourcedModuleDescriptor<JiraRendererPlugin>

Descriptor that defines a JiraRendererModule.

Field Summary

static java.lang.String	TEMPLATE_NAME_CSS
static java.lang.String	TEMPLATE_NAME_EDIT
static java.lang.String	TEMPLATE_NAME_JS

Fields inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

RESOURCE_TYPE_I18N

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

moduleClassName, plugin, resources, singleton

Constructor Summary

JiraRendererModuleDescriptor(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

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

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

assertResourceExists, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, init, isResourceExist

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, destroy, enabled, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TEMPLATE_NAME_CSS

public static final java.lang.String TEMPLATE_NAME_CSS

See Also:

Constant Field Values

TEMPLATE_NAME_JS

public static final java.lang.String TEMPLATE_NAME_JS

See Also:

Constant Field Values

TEMPLATE_NAME_EDIT

public static final java.lang.String TEMPLATE_NAME_EDIT

See Also:

Constant Field Values

Constructor Detail

JiraRendererModuleDescriptor

public JiraRendererModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                    ApplicationProperties applicationProperties,
                                    com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

getCss

public java.lang.String getCss()

getJavaScript

public java.lang.String getJavaScript(java.lang.String contextPath)

getEditVM

public java.lang.String getEditVM(java.lang.String value,
                                  java.lang.String issueKey,
                                  java.lang.String rendererType,
                                  java.lang.String fieldId,
                                  java.lang.String fieldName,
                                  java.util.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

public boolean isCSSTemplateExists()

isJavaScriptTemplateExists

public boolean isJavaScriptTemplateExists()

isEditTemplateExists

public boolean isEditTemplateExists()