@PublicApi public interface

FieldLayoutItem

implements Comparable<T>
com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Summary

Public Methods
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.
[Expand]
Inherited Methods
From interface java.lang.Comparable

Public Methods

public String getFieldDescription ()

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

Returns
  • rendered view of the field description.

public FieldLayout getFieldLayout ()

Returns the FieldLayout that this item is a part of.

Returns
  • the field layout; may be null.

public OrderableField getOrderableField ()

Gets the field in question.

Returns
  • the field.

public String getRawFieldDescription ()

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

Returns
  • the raw field description.

public String getRendererType ()

Returns the renderer type, e.g. RENDERER_TYPE.

Returns
  • the renderer for the field configuration for this field.

public boolean isHidden ()

Whether the field should be invisible in the UI.

Returns
  • true only if the field should be hidden.

public boolean isRequired ()

Whether a field value is mandatory.

Returns
  • true only if a value is required.