com.atlassian.jira.plugin.renderer
Class JiraRendererModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      extended by com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
          extended by com.atlassian.jira.plugin.renderer.JiraRendererModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced

public class JiraRendererModuleDescriptor
extends JiraResourcedModuleDescriptor

Descriptor that defines a JiraRendererModule.


Field Summary
static String TEMPLATE_NAME_CSS
           
static String TEMPLATE_NAME_EDIT
           
static 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
plugin, resources, singleton
 
Constructor Summary
JiraRendererModuleDescriptor(JiraAuthenticationContext authenticationContext, ApplicationProperties applicationProperties)
           
 
Method Summary
 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)
           
 Object getModule()
           
 boolean isCSSTemplateExists()
           
 boolean isEditTemplateExists()
           
 boolean isJavaScriptTemplateExists()
           
 
Methods inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
assertResourceExists, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, getName, getText, getText, init, isResourceExist
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, 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 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
Constructor Detail

JiraRendererModuleDescriptor

public JiraRendererModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                    ApplicationProperties applicationProperties)
Method Detail

getModule

public Object getModule()
Specified by:
getModule in interface com.atlassian.plugin.ModuleDescriptor
Specified by:
getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

getCss

public String getCss()

getJavaScript

public String getJavaScript(String contextPath)

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.

Returns:
the renderered html for the edit input

isCSSTemplateExists

public boolean isCSSTemplateExists()

isJavaScriptTemplateExists

public boolean isJavaScriptTemplateExists()

isEditTemplateExists

public boolean isEditTemplateExists()


Copyright © 2002-2009 Atlassian. All Rights Reserved.