com.atlassian.jira.plugin.customfield
Class CustomFieldTypeModuleDescriptor

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

public class CustomFieldTypeModuleDescriptor
extends JiraResourcedModuleDescriptor


Field Summary
(package private)  CustomFieldType cfType
           
static String TEMPLATE_NAME_COLUMN
           
static String TEMPLATE_NAME_EDIT
           
static String TEMPLATE_NAME_EDIT_DEFAULT
           
static String TEMPLATE_NAME_VIEW
           
static String TEMPLATE_NAME_XML
           
static String VELCITY_ACTION_PARAM
           
static String VELOCITY_VALUE_PARAM
           
 
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
CustomFieldTypeModuleDescriptor(JiraAuthenticationContext authenticationContext, RendererManager rendererManager)
           
 
Method Summary
 String getColumnViewHtml(CustomField field, Object value, Issue issue, Map displayParams, FieldLayoutItem fieldLayoutItem)
           
 String getDefaultViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
           
 String getEditDefaultHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
           
 String getEditHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
           
 Object getModule()
           
 String getViewHtml(CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem)
           
 String getViewXML(CustomField field, Issue issue, FieldLayoutItem fieldLayoutItem, boolean raw)
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 boolean isColumnViewTemplateExists()
           
 boolean isEditTemplateExists()
           
 boolean isViewTemplateExists()
           
 boolean isXMLTemplateExists()
           
 
Methods inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
assertResourceExists, createVelocityParams, getAuthenticationContext, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, getName, getText, getText, 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_VIEW

public static final String TEMPLATE_NAME_VIEW
See Also:
Constant Field Values

TEMPLATE_NAME_EDIT

public static final String TEMPLATE_NAME_EDIT
See Also:
Constant Field Values

TEMPLATE_NAME_EDIT_DEFAULT

public static final String TEMPLATE_NAME_EDIT_DEFAULT
See Also:
Constant Field Values

TEMPLATE_NAME_XML

public static final String TEMPLATE_NAME_XML
See Also:
Constant Field Values

TEMPLATE_NAME_COLUMN

public static final String TEMPLATE_NAME_COLUMN
See Also:
Constant Field Values

VELOCITY_VALUE_PARAM

public static final String VELOCITY_VALUE_PARAM
See Also:
Constant Field Values

VELCITY_ACTION_PARAM

public static final String VELCITY_ACTION_PARAM
See Also:
Constant Field Values

cfType

CustomFieldType cfType
Constructor Detail

CustomFieldTypeModuleDescriptor

public CustomFieldTypeModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                       RendererManager rendererManager)
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
Overrides:
init in class JiraResourcedModuleDescriptor
Throws:
com.atlassian.plugin.PluginParseException

getModule

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

isViewTemplateExists

public boolean isViewTemplateExists()

isColumnViewTemplateExists

public boolean isColumnViewTemplateExists()

isEditTemplateExists

public boolean isEditTemplateExists()

isXMLTemplateExists

public boolean isXMLTemplateExists()

getEditHtml

public String getEditHtml(FieldConfig config,
                          Map customFieldValuesHolder,
                          Issue issue,
                          webwork.action.Action action,
                          Map displayParameters,
                          FieldLayoutItem fieldLayoutItem)

getEditDefaultHtml

public String getEditDefaultHtml(FieldConfig config,
                                 Map customFieldValuesHolder,
                                 Issue issue,
                                 webwork.action.Action action,
                                 Map displayParameters,
                                 FieldLayoutItem fieldLayoutItem)

getColumnViewHtml

public String getColumnViewHtml(CustomField field,
                                Object value,
                                Issue issue,
                                Map displayParams,
                                FieldLayoutItem fieldLayoutItem)

getViewHtml

public String getViewHtml(CustomField field,
                          Object value,
                          Issue issue,
                          FieldLayoutItem fieldLayoutItem)

getViewXML

public String getViewXML(CustomField field,
                         Issue issue,
                         FieldLayoutItem fieldLayoutItem,
                         boolean raw)

getDefaultViewHtml

public String getDefaultViewHtml(FieldConfig fieldConfig,
                                 FieldLayoutItem fieldLayoutItem)


Copyright © 2002-2007 Atlassian. All Rights Reserved.