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

Class MockFieldLayoutItem

java.lang.Object

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

All Implemented Interfaces:

FieldLayoutItem, Comparable<FieldLayoutItem>

public class MockFieldLayoutItem
extends Object
implements FieldLayoutItem

Simple implementation of FieldLayoutItem.

Since:

v4.1

Constructor Summary

Constructors

Constructor	Description
MockFieldLayoutItem()
MockFieldLayoutItem(OrderableField orderableField, String description, boolean hidden, boolean required, String rendererType, FieldLayout fieldLayout)

Method Summary

Modifier and Type	Method	Description
int	compareTo(FieldLayoutItem fieldLayoutItem)
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.
MockFieldLayoutItem	setDescription(String description)
MockFieldLayoutItem	setFieldLayout(FieldLayout fieldLayout)
MockFieldLayoutItem	setHidden(boolean hidden)
MockFieldLayoutItem	setOrderableField(OrderableField orderableField)
MockFieldLayoutItem	setRendererType(String type)
MockFieldLayoutItem	setRequired(boolean required)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MockFieldLayoutItem

public MockFieldLayoutItem()

MockFieldLayoutItem

public MockFieldLayoutItem(OrderableField orderableField,
 String description,
 boolean hidden,
 boolean required,
 String rendererType,
 FieldLayout fieldLayout)

Method Details

getOrderableField

public OrderableField getOrderableField()

Description copied from interface: FieldLayoutItem

Gets the field in question.

Specified by:

getOrderableField in interface FieldLayoutItem

Returns:

the field.

setOrderableField

public MockFieldLayoutItem setOrderableField(OrderableField orderableField)

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:

rendered view of the field description.

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.

setDescription

public MockFieldLayoutItem setDescription(String 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.

setHidden

public MockFieldLayoutItem setHidden(boolean 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.

setRequired

public MockFieldLayoutItem setRequired(boolean 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.

setRendererType

public MockFieldLayoutItem setRendererType(String type)

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.

setFieldLayout

public MockFieldLayoutItem setFieldLayout(FieldLayout fieldLayout)

compareTo

public int compareTo(FieldLayoutItem fieldLayoutItem)

Specified by:

compareTo in interface Comparable<FieldLayoutItem>

toString

public String toString()

Overrides:

toString in class Object