com.atlassian.jira.issue.fields
Class AbstractTextSystemField

java.lang.Object
  extended bycom.atlassian.jira.issue.fields.AbstractField
      extended bycom.atlassian.jira.issue.fields.AbstractOrderableField
          extended bycom.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
              extended bycom.atlassian.jira.issue.fields.AbstractTextSystemField
All Implemented Interfaces:
Comparable, Field, NavigableField, OrderableField, RenderableField, SearchableField
Direct Known Subclasses:
DescriptionSystemField, EnvironmentSystemField, SummarySystemField

public abstract class AbstractTextSystemField
extends AbstractOrderableNavigableFieldImpl
implements RenderableField

Copyright (c) 2002-2004 All rights reserved.


Field Summary
 
Fields inherited from class com.atlassian.jira.issue.fields.AbstractField
authenticationContext
 
Fields inherited from interface com.atlassian.jira.issue.fields.NavigableField
ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH
 
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH
 
Constructor Summary
AbstractTextSystemField(String id, String name, com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager)
           
 
Method Summary
 void createValue(Issue issue, Object value)
          Create the value of the issue in the data store.
protected  String getChangeLogFieldName()
           
protected  String getChangelogValue(Object value)
           
 String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
           
protected abstract  String getColumnViewTemplateName()
           
 String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map dispayParameters)
          Returns the HTML that should be shown when the issue is being created
 String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
          Returns HTML that should be shown when the issue is being edited
protected abstract  String getEditTemplateName()
           
protected  Object getRelevantParams(Map params)
           
abstract  String getValueFromIssue(Issue issue)
          Gets the value stored for this field on the provided issue.
 Object getValueFromParams(Map params)
          Get a field value from the map of parameters passed.
 String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
           
 String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Object value, Map displayParameters)
           
 boolean hasValue(Issue issue)
          Determines if the field has a value for the given issue.
 boolean isRenderable()
          Defines if a field determines itself as renderable.
 MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
          Used to determine if the field needs input from user to be moved to the new project and/or issue type.
 void populateDefaults(Map fieldValuesHolder, Issue issue)
          Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet
 void populateForMove(Map fieldValuesHolder, Issue originalIssue, Issue targetIssue)
          Used to populate the fieldValueHolder with parameters for move issue screen.
 void populateFromIssue(Map fieldValuesHolder, Issue issue)
          Used to initialise the fieldValuesHolder from the current value of teh issue.
 void populateParamsFromString(Map fieldValuesHolder, String stringValue, Issue issue)
          Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
protected  void populateVelocityParams(FieldLayoutItem fieldLayoutItem, Issue issue, Map params)
           
protected  void populateVelocityParams(Map fieldValuesHolder, Map params)
           
 void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
          Update the issue in the data store
protected  boolean valuesEqual(String currentValue, String value)
           
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, valuesEqual
 
Methods inherited from class com.atlassian.jira.issue.fields.AbstractField
compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.jira.issue.fields.renderer.RenderableField
getId
 
Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField
getColumnHeadingKey, getDefaultSortOrder, getSorter
 
Methods inherited from interface com.atlassian.jira.issue.fields.Field
getId, getName, getNameKey
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField
availableForBulkEdit, getDefaultValue, isShown, removeValue, updateIssue, validateParams
 
Methods inherited from interface com.atlassian.jira.issue.fields.SearchableField
getAssociatedSearchers
 

Constructor Detail

AbstractTextSystemField

public AbstractTextSystemField(String id,
                               String name,
                               com.atlassian.velocity.VelocityManager velocityManager,
                               ApplicationProperties applicationProperties,
                               JiraAuthenticationContext authenticationContext,
                               RendererManager rendererManager,
                               PermissionManager permissionManager)
Method Detail

getCreateHtml

public String getCreateHtml(FieldLayoutItem fieldLayoutItem,
                            OperationContext operationContext,
                            webwork.action.Action action,
                            Issue issue,
                            Map dispayParameters)
Description copied from interface: OrderableField
Returns the HTML that should be shown when the issue is being created

Specified by:
getCreateHtml in interface OrderableField

getEditTemplateName

protected abstract String getEditTemplateName()

getColumnViewHtml

public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
                                Map displayParams,
                                Issue issue)
Specified by:
getColumnViewHtml in interface NavigableField

getColumnViewTemplateName

protected abstract String getColumnViewTemplateName()

populateVelocityParams

protected void populateVelocityParams(Map fieldValuesHolder,
                                      Map params)

populateVelocityParams

protected void populateVelocityParams(FieldLayoutItem fieldLayoutItem,
                                      Issue issue,
                                      Map params)

getValueFromParams

public Object getValueFromParams(Map params)
Description copied from interface: OrderableField
Get a field value from the map of parameters passed. The params map may contain other parameters that are not relevant to this custom field.

Specified by:
getValueFromParams in interface OrderableField

populateParamsFromString

public void populateParamsFromString(Map fieldValuesHolder,
                                     String stringValue,
                                     Issue issue)
                              throws FieldValidationException
Description copied from interface: OrderableField
Used to convert from a user friendly string value and put the result into the fieldValuesHolder. This method is useful for places like Jelly where the field value can be a name (e.g. issue type name) and not a regular id that is used in the web pages.

Specified by:
populateParamsFromString in interface OrderableField
Throws:
FieldValidationException - if cannot convert to a value from the given string

getEditHtml

public String getEditHtml(FieldLayoutItem fieldLayoutItem,
                          OperationContext operationContext,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)
Description copied from interface: OrderableField
Returns HTML that should be shown when the issue is being edited

Specified by:
getEditHtml in interface OrderableField

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          Map displayParameters)
Specified by:
getViewHtml in interface OrderableField

getViewHtml

public String getViewHtml(FieldLayoutItem fieldLayoutItem,
                          webwork.action.Action action,
                          Issue issue,
                          Object value,
                          Map displayParameters)
Specified by:
getViewHtml in interface OrderableField

createValue

public void createValue(Issue issue,
                        Object value)
Description copied from interface: OrderableField
Create the value of the issue in the data store.

Specified by:
createValue in interface OrderableField
Parameters:
issue - Issue this field is part of
value - Value to store in this field (eg. Collection for Version fields). Cannot be null.

updateValue

public void updateValue(FieldLayoutItem fieldLayoutItem,
                        Issue issue,
                        ModifiedValue modifiedValue,
                        IssueChangeHolder issueChangeHolder)
Description copied from interface: OrderableField
Update the issue in the data store

Specified by:
updateValue in interface OrderableField
Parameters:
fieldLayoutItem - for this field within this context
issue - Issue this field is part of
modifiedValue - new value to set field to. Cannot be null.
issueChangeHolder - an object to record any changes made to the issue by this method.

valuesEqual

protected boolean valuesEqual(String currentValue,
                              String value)

needsMove

public MessagedResult needsMove(Collection originalIssues,
                                Issue targetIssue,
                                FieldLayoutItem targetFieldLayoutItem)
Description copied from interface: OrderableField
Used to determine if the field needs input from user to be moved to the new project and/or issue type. This method is called only if the field is visible in the target project/issue type.

Specified by:
needsMove in interface OrderableField

populateForMove

public void populateForMove(Map fieldValuesHolder,
                            Issue originalIssue,
                            Issue targetIssue)
Description copied from interface: OrderableField
Used to populate the fieldValueHolder with parameters for move issue screen. This field is only called if the issue needs to be updated during move, i.e. OrderableField.needsMove(java.util.Collection,com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem) returned true, and the remote user (the one performing the move) has the permission to actually update this field.

Specified by:
populateForMove in interface OrderableField

hasValue

public boolean hasValue(Issue issue)
Description copied from interface: OrderableField
Determines if the field has a value for the given issue.

Specified by:
hasValue in interface OrderableField

populateFromIssue

public void populateFromIssue(Map fieldValuesHolder,
                              Issue issue)
Description copied from interface: OrderableField
Used to initialise the fieldValuesHolder from the current value of teh issue. Used, for example, when showing teh Edit Issue screen to show the issue's current values.

Specified by:
populateFromIssue in interface OrderableField

getValueFromIssue

public abstract String getValueFromIssue(Issue issue)
Description copied from interface: RenderableField
Gets the value stored for this field on the provided issue.

Specified by:
getValueFromIssue in interface RenderableField
Parameters:
issue - identifies the issue that will contain the value for this field.
Returns:
the value stored on this issue for this field, null if not applicable.

isRenderable

public boolean isRenderable()
Description copied from interface: RenderableField
Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.

Specified by:
isRenderable in interface RenderableField
Returns:
true if the field is renderable, false otherwise.

getChangeLogFieldName

protected String getChangeLogFieldName()

getChangelogValue

protected String getChangelogValue(Object value)

getRelevantParams

protected Object getRelevantParams(Map params)
Specified by:
getRelevantParams in class AbstractOrderableField

populateDefaults

public void populateDefaults(Map fieldValuesHolder,
                             Issue issue)
Description copied from interface: OrderableField
Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet

Specified by:
populateDefaults in interface OrderableField


Copyright © 2002-2006 Atlassian. All Rights Reserved.