com.atlassian.jira.plugin.renderer

Class JiraRendererModuleDescriptorImpl

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<JiraRendererPlugin>

com.atlassian.jira.plugin.renderer.JiraRendererModuleDescriptorImpl

All Implemented Interfaces:

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

public class JiraRendererModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<JiraRendererPlugin>
implements JiraRendererModuleDescriptor

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
static String	WEB_PANELS_LOCATION

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

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor and Description
JiraRendererModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties, com.atlassian.plugin.module.ModuleFactory moduleFactory, ModuleWebComponent moduleWebComponent, com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager, IssueManager issueManager)

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)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isCSSTemplateExists()
boolean	isEditTemplateExists()
boolean	isJavaScriptTemplateExists()

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

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

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

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, 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

public static final String TEMPLATE_NAME_CSS

See Also:

Constant Field Values

TEMPLATE_NAME_JS

public static final String TEMPLATE_NAME_JS

See Also:

Constant Field Values

TEMPLATE_NAME_EDIT

public static final String TEMPLATE_NAME_EDIT

See Also:

Constant Field Values

WEB_PANELS_LOCATION

public static final String WEB_PANELS_LOCATION

See Also:

Constant Field Values

Constructor Detail

JiraRendererModuleDescriptorImpl

public JiraRendererModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
                                        ApplicationProperties applicationProperties,
                                        com.atlassian.plugin.module.ModuleFactory moduleFactory,
                                        ModuleWebComponent moduleWebComponent,
                                        com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager,
                                        IssueManager issueManager)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<JiraRendererPlugin>

Overrides:

init in class AbstractJiraModuleDescriptor<JiraRendererPlugin>

Throws:

com.atlassian.plugin.PluginParseException

getCss

public String getCss()

Specified by:

getCss in interface JiraRendererModuleDescriptor

getJavaScript

public String getJavaScript(String contextPath)

Specified by:

getJavaScript in interface JiraRendererModuleDescriptor

getEditVM

public 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.

Specified by:

getEditVM in interface JiraRendererModuleDescriptor

Returns:

the renderered html for the edit input

isCSSTemplateExists

public boolean isCSSTemplateExists()

Specified by:

isCSSTemplateExists in interface JiraRendererModuleDescriptor

isJavaScriptTemplateExists

public boolean isJavaScriptTemplateExists()

Specified by:

isJavaScriptTemplateExists in interface JiraRendererModuleDescriptor

isEditTemplateExists

public boolean isEditTemplateExists()

Specified by:

isEditTemplateExists in interface JiraRendererModuleDescriptor