com.atlassian.jira.issue.fields.layout.field

Interface FieldLayoutItem

All Superinterfaces:

Comparable<FieldLayoutItem>

All Known Implementing Classes:

FieldLayoutItemImpl, MockFieldLayoutItem

@PublicApi
public interface FieldLayoutItem
extends Comparable<FieldLayoutItem>

Holds hidden and required attributes and renderer type of a specific OrderableField, corresponds to a single entry of a the Field Configuration in the user interface.

Method Summary

Modifier and Type	Method and Description
String	getFieldDescription() This method should be used to retrieve the HTML rendered representation of the field description.
FieldLayout	getFieldLayout() Returns the FieldLayout that this item is a part of.
OrderableField	getOrderableField() Gets the field in question.
String	getRawFieldDescription() This method should be used to retrieve the NON-HTML rendered representation of the field description.
String	getRendererType() Returns the renderer type, e.g.
boolean	isHidden() Whether the field should be invisible in the UI.
boolean	isRequired() Whether a field value is mandatory.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getOrderableField

OrderableField getOrderableField()

Gets the field in question.

Returns:

the field.

getFieldDescription

String getFieldDescription()

This method should be used to retrieve the HTML rendered representation of the field description.

Returns:

rendered view of the field description.

getRawFieldDescription

String getRawFieldDescription()

This method should be used to retrieve the NON-HTML rendered representation of the field description.

Returns:

the raw field description.

Since:

v5.1.1

isHidden

boolean isHidden()

Whether the field should be invisible in the UI.

Returns:

true only if the field should be hidden.

isRequired

boolean isRequired()

Whether a field value is mandatory.

Returns:

true only if a value is required.

getRendererType

String getRendererType()

Returns the renderer type, e.g. DefaultTextRenderer.RENDERER_TYPE.

Returns:

the renderer for the field configuration for this field.

getFieldLayout

FieldLayout getFieldLayout()

Returns the FieldLayout that this item is a part of.

Returns:

the field layout; may be null.

Since:

v4.2