com.atlassian.jira.plugin.customfield
Class CustomFieldTypeModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<CustomFieldType>
          com.atlassian.jira.plugin.customfield.CustomFieldTypeModuleDescriptor

All Implemented Interfaces:

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

public class CustomFieldTypeModuleDescriptor
extends JiraResourcedModuleDescriptor<CustomFieldType>

Field Summary

static java.lang.String	TEMPLATE_NAME_BULK_MOVE
static java.lang.String	TEMPLATE_NAME_COLUMN
static java.lang.String	TEMPLATE_NAME_EDIT
static java.lang.String	TEMPLATE_NAME_EDIT_DEFAULT
static java.lang.String	TEMPLATE_NAME_VIEW
static java.lang.String	TEMPLATE_NAME_XML
static java.lang.String	VELCITY_ACTION_PARAM
static java.lang.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

moduleClassName, plugin, resources, singleton

Constructor Summary

CustomFieldTypeModuleDescriptor(JiraAuthenticationContext authenticationContext, RendererManager rendererManager, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

void	enabled()
java.lang.String	getBulkMoveHtml(FieldConfig config, java.util.Map customFieldValuesHolder, Issue issue, webwork.action.Action action, java.util.Map displayParameters, FieldLayoutItem fieldLayoutItem, java.util.Map<java.lang.Long,BulkMoveHelper.DistinctValueResult> distinctValues, BulkMoveHelper bulkMoveHelper)
java.lang.String	getColumnViewHtml(CustomField field, java.lang.Object value, Issue issue, java.util.Map displayParams, FieldLayoutItem fieldLayoutItem)
java.lang.String	getDefaultViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
java.lang.String	getEditDefaultHtml(FieldConfig config, java.util.Map customFieldValuesHolder, Issue issue, webwork.action.Action action, java.util.Map displayParameters, FieldLayoutItem fieldLayoutItem)
java.lang.String	getEditHtml(FieldConfig config, java.util.Map customFieldValuesHolder, Issue issue, webwork.action.Action action, java.util.Map displayParameters, FieldLayoutItem fieldLayoutItem)
java.lang.String	getViewHtml(CustomField field, java.lang.Object value, Issue issue, FieldLayoutItem fieldLayoutItem)
java.lang.String	getViewHtml(CustomField field, java.lang.Object value, Issue issue, FieldLayoutItem fieldLayoutItem, java.util.Map displayParameters)
java.lang.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, createModule, createVelocityParams, disabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, 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, 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_VIEW

public static final java.lang.String TEMPLATE_NAME_VIEW

See Also:

Constant Field Values

TEMPLATE_NAME_EDIT

public static final java.lang.String TEMPLATE_NAME_EDIT

See Also:

Constant Field Values

TEMPLATE_NAME_EDIT_DEFAULT

public static final java.lang.String TEMPLATE_NAME_EDIT_DEFAULT

See Also:

Constant Field Values

TEMPLATE_NAME_BULK_MOVE

public static final java.lang.String TEMPLATE_NAME_BULK_MOVE

See Also:

Constant Field Values

TEMPLATE_NAME_XML

public static final java.lang.String TEMPLATE_NAME_XML

See Also:

Constant Field Values

TEMPLATE_NAME_COLUMN

public static final java.lang.String TEMPLATE_NAME_COLUMN

See Also:

Constant Field Values

VELOCITY_VALUE_PARAM

public static final java.lang.String VELOCITY_VALUE_PARAM

See Also:

Constant Field Values

VELCITY_ACTION_PARAM

public static final java.lang.String VELCITY_ACTION_PARAM

See Also:

Constant Field Values

Constructor Detail

CustomFieldTypeModuleDescriptor

public CustomFieldTypeModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                       RendererManager rendererManager,
                                       com.atlassian.plugin.module.ModuleFactory moduleFactory)

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

Overrides:

init in class JiraResourcedModuleDescriptor<CustomFieldType>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<CustomFieldType>

isViewTemplateExists

public boolean isViewTemplateExists()

isColumnViewTemplateExists

public boolean isColumnViewTemplateExists()

isEditTemplateExists

public boolean isEditTemplateExists()

isXMLTemplateExists

public boolean isXMLTemplateExists()

getEditHtml

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

getBulkMoveHtml

public java.lang.String getBulkMoveHtml(FieldConfig config,
                                        java.util.Map customFieldValuesHolder,
                                        Issue issue,
                                        webwork.action.Action action,
                                        java.util.Map displayParameters,
                                        FieldLayoutItem fieldLayoutItem,
                                        java.util.Map<java.lang.Long,BulkMoveHelper.DistinctValueResult> distinctValues,
                                        BulkMoveHelper bulkMoveHelper)

getEditDefaultHtml

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

getColumnViewHtml

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

getViewHtml

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

getViewHtml

public java.lang.String getViewHtml(CustomField field,
                                    java.lang.Object value,
                                    Issue issue,
                                    FieldLayoutItem fieldLayoutItem,
                                    java.util.Map displayParameters)

getViewXML

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

getDefaultViewHtml

public java.lang.String getDefaultViewHtml(FieldConfig fieldConfig,
                                           FieldLayoutItem fieldLayoutItem)