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 abstract class CustomFieldTypeModuleDescriptor
extends JiraResourcedModuleDescriptor<CustomFieldType>

Field Summary

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

moduleClass, moduleClassName, plugin, resources, singleton

Constructor Summary

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

Method Summary

abstract String	getBulkMoveHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem, Map<Long,BulkMoveHelper.DistinctValueResult> distinctValues, BulkMoveHelper bulkMoveHelper)
abstract String	getColumnViewHtml(CustomField field, Object value, Issue issue, Map displayParams, FieldLayoutItem fieldLayoutItem)
abstract String	getDefaultViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
abstract String	getEditDefaultHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
abstract String	getEditHtml(FieldConfig config, Map customFieldValuesHolder, Issue issue, webwork.action.Action action, Map displayParameters, FieldLayoutItem fieldLayoutItem)
abstract String	getViewHtml(CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem)
abstract String	getViewHtml(CustomField field, Object value, Issue issue, FieldLayoutItem fieldLayoutItem, Map displayParameters)
abstract String	getViewXML(CustomField field, Issue issue, FieldLayoutItem fieldLayoutItem, boolean raw)
abstract boolean	isColumnViewTemplateExists()
abstract boolean	isEditTemplateExists()
abstract boolean	isViewTemplateExists()
abstract boolean	isXMLTemplateExists()

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

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

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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_BULK_MOVE

public static final String TEMPLATE_NAME_BULK_MOVE

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

Constructor Detail

CustomFieldTypeModuleDescriptor

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

Method Detail

isViewTemplateExists

public abstract boolean isViewTemplateExists()

isColumnViewTemplateExists

public abstract boolean isColumnViewTemplateExists()

isEditTemplateExists

public abstract boolean isEditTemplateExists()

isXMLTemplateExists

public abstract boolean isXMLTemplateExists()

getEditHtml

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

getBulkMoveHtml

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

getEditDefaultHtml

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

getColumnViewHtml

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

getViewHtml

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

getViewHtml

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

getViewXML

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

getDefaultViewHtml

public abstract String getDefaultViewHtml(FieldConfig fieldConfig,
                                          FieldLayoutItem fieldLayoutItem)