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

Class FieldLayoutItemImpl

java.lang.Object

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

All Implemented Interfaces:

FieldLayoutItem, Comparable<FieldLayoutItem>

public class FieldLayoutItemImpl
extends Object
implements FieldLayoutItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldLayoutItemImpl.Builder Useful for instantiating FieldLayoutItemImpl objects from scratch or copying them.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FieldLayoutItem fieldLayoutItem)
boolean	equals(Object o)
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.
int	hashCode()
boolean	isHidden() Whether the field should be invisible in the UI.
boolean	isRequired() Whether a field value is mandatory.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getOrderableField

public OrderableField getOrderableField()

Description copied from interface: FieldLayoutItem

Gets the field in question.

Specified by:

getOrderableField in interface FieldLayoutItem

Returns:

the field.

getFieldDescription

public String getFieldDescription()

Description copied from interface: FieldLayoutItem

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

Specified by:

getFieldDescription in interface FieldLayoutItem

Returns:

a rendered view of the description for OnDemand only

getRawFieldDescription

public String getRawFieldDescription()

Description copied from interface: FieldLayoutItem

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

Specified by:

getRawFieldDescription in interface FieldLayoutItem

Returns:

the raw field description.

isHidden

public boolean isHidden()

Description copied from interface: FieldLayoutItem

Whether the field should be invisible in the UI.

Specified by:

isHidden in interface FieldLayoutItem

Returns:

true only if the field should be hidden.

isRequired

public boolean isRequired()

Description copied from interface: FieldLayoutItem

Whether a field value is mandatory.

Specified by:

isRequired in interface FieldLayoutItem

Returns:

true only if a value is required.

getRendererType

public String getRendererType()

Description copied from interface: FieldLayoutItem

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

Specified by:

getRendererType in interface FieldLayoutItem

Returns:

the renderer for the field configuration for this field.

getFieldLayout

public FieldLayout getFieldLayout()

Description copied from interface: FieldLayoutItem

Returns the FieldLayout that this item is a part of.

Specified by:

getFieldLayout in interface FieldLayoutItem

Returns:

the field layout; may be null.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(FieldLayoutItem fieldLayoutItem)

Specified by:

compareTo in interface Comparable<FieldLayoutItem>