com.atlassian.jira.issue.fields.layout.column

Interface ColumnLayoutItem

All Superinterfaces:

Comparable

All Known Implementing Classes:

ActionsAndOperationsColumnLayoutItem, ColumnLayoutItemImpl, ExcelColumnLayoutItem, SimpleColumnLayoutItem, SubTaskReorderColumnLayoutItem

@PublicApi
public interface ColumnLayoutItem
extends Comparable

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<ColumnLayoutItem,String>	TO_ID Transform to its id.

Method Summary

Modifier and Type	Method and Description
String	getColumnHeadingKey() Return some text for the Column Header.
String	getHtml(Map displayParams, Issue issue)
String	getId() Return the string form of the unique identifier for this column.
NavigableField	getNavigableField()
int	getPosition()
boolean	isAliasForField(ApplicationUser user, String sortField)

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TO_ID

static final com.google.common.base.Function<ColumnLayoutItem,String> TO_ID

Transform to its id.

Method Detail

getNavigableField

NavigableField getNavigableField()

getId

String getId()

Return the string form of the unique identifier for this column. When the column corresponds to a NavigableField, the id of the column will be the same as the id of the field.

Returns:

the id;

isAliasForField

boolean isAliasForField(ApplicationUser user,
                        String sortField)

getPosition

int getPosition()

getHtml

String getHtml(Map displayParams,
               Issue issue)

getColumnHeadingKey

String getColumnHeadingKey()

Return some text for the Column Header. By default this calls NavigableField.getColumnHeadingKey() but implementations can override this to provide different column headings as appropriate

Returns:

A key, which can be run through I18nHelper.getText(String) to get a heading