Package com.atlassian.jira.issue.fields

Interface NavigableField

All Superinterfaces:

Comparable, Field

All Known Subinterfaces:

AffectedVersionsField, ComponentsField, CustomField, FixVersionsField, ProjectField, SummaryField, TimeSpentField

All Known Implementing Classes:

AbstractAggregateDurationSystemField, AbstractDurationSystemField, AbstractOrderableNavigableFieldImpl, AbstractPickerFieldImpl, AbstractProgressBarSystemField, AbstractTextSystemField, AbstractUserFieldImpl, AbstractVersionsSystemField, AffectedVersionsSystemField, AggregateEstimateSystemField, AggregateOriginalEstimateSystemField, AggregateProgressBarSystemField, AggregateTimeSpentSystemField, AssigneeSystemField, ComponentsSystemField, CreatedSystemField, CreatorSystemField, DescriptionSystemField, DueDateSystemField, EnvironmentSystemField, FixVersionsSystemField, ImmutableCustomField, IssueLinksSystemField, IssueTypeSystemField, KeySystemField, LabelsSystemField, LastViewedSystemField, MockCustomField, MockNavigableField, NavigableFieldImpl, OriginalEstimateSystemField, PrioritySystemField, ProgressBarSystemField, ProjectSystemField, ReporterSystemField, ResolutionDateSystemField, ResolutionSystemField, SecurityLevelSystemField, StatusSystemField, SubTaskSystemField, SummarySystemField, ThumbnailSystemField, TimeEstimateSystemField, TimeSpentSystemField, UpdatedSystemField, VotesSystemField, WatchesSystemField, WorkRatioSystemField

@PublicApi
public interface NavigableField
extends Field

Fields in JIRA which are able to be placed in the Issue Navigator implement this interface.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_ASCENDING
static final String	ORDER_DESCENDING
static final String	TEMPLATE_DIRECTORY_PATH

Method Summary

Modifier and Type	Method	Description
String	getColumnCssClass()
String	getColumnHeadingKey()
String	getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map<String,Object> displayParams, Issue issue)
String	getDefaultSortOrder()	The order in which to sort the field when it is sorted for the first time.
default List<FieldSort>	getFieldSorts(FieldSort.Order sortOrder)	Returns a list of FieldSort objects that can be used to sort this field.
String	getHiddenFieldId()	Returns the id of the field to check for visibility.
FieldValueLoader	getValueLoader()	A loader to be used when loading the value of the field from the index.
default boolean	hasSortsDefined()	Checks whether the field has either Lucene SortFields or FieldSorts that can be used to sort the field.
String	prettyPrintChangeHistory(String changeHistory)
String	prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)	Used for email notification templates - allows changelog to be displayed in language of the recipient.
default String	prettyPrintChangeHistory(String changeHistory, String id, I18nHelper i18nHelper)	Used for email notification templates - allows changelog to be displayed in language of the recipient.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Field Details

TEMPLATE_DIRECTORY_PATH

static final String TEMPLATE_DIRECTORY_PATH

See Also:

• Constant Field Values

ORDER_ASCENDING

static final String ORDER_ASCENDING

See Also:

• Constant Field Values

ORDER_DESCENDING

static final String ORDER_DESCENDING

See Also:

• Constant Field Values

Method Details

getColumnHeadingKey

String getColumnHeadingKey()

getColumnCssClass

String getColumnCssClass()

getDefaultSortOrder

String getDefaultSortOrder()

The order in which to sort the field when it is sorted for the first time.

Returns:

Either ORDER_ASCENDING or ORDER_DESCENDING

getFieldSorts

default List<FieldSort> getFieldSorts(FieldSort.Order sortOrder)

Returns a list of FieldSort objects that can be used to sort this field.

Parameters:

sortOrder - the order in which to sort the field

Returns:

a list of FieldSort objects that can be used to sort this field

Since:

10.4

hasSortsDefined

default boolean hasSortsDefined()

Checks whether the field has either Lucene SortFields or FieldSorts that can be used to sort the field.

Returns:

true if the field has either Lucene SortFields or FieldSorts that can be used to sort the field

Since:

10.4

getValueLoader

@Nullable
FieldValueLoader getValueLoader()

A loader to be used when loading the value of the field from the index.

Returns:

A loader that can be used to load the value of the field

Since:

10.4

See Also:

• DocumentIssueImpl

getColumnViewHtml

String getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
 Map<String,Object> displayParams,
 Issue issue)

getHiddenFieldId

String getHiddenFieldId()

Returns the id of the field to check for visibility. For example, with original estimate field need to ensure that the timetracking field is not hidden. With most fields, this is the same as their id.

prettyPrintChangeHistory

String prettyPrintChangeHistory(String changeHistory)

prettyPrintChangeHistory

default String prettyPrintChangeHistory(String changeHistory,
 String id,
 I18nHelper i18nHelper)

Used for email notification templates - allows changelog to be displayed in language of the recipient. By default it calls prettyPrintChangeHistory without id argument for backward compatibility.

Parameters:

changeHistory - - label

id - - object value

Returns:

String change history formatted according to locale in i18nHelper

prettyPrintChangeHistory

String prettyPrintChangeHistory(String changeHistory,
 I18nHelper i18nHelper)

Used for email notification templates - allows changelog to be displayed in language of the recipient.

Parameters:

changeHistory - - label

Returns:

String change history formatted according to locale in i18nHelper