@PublicApi public interface


implements FieldLayout
Known Indirect Subclasses


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

Used to describe an EditableFieldLayout. Note: These are called Field Configurations in the UI.


Public Methods
String getType()
void hide(FieldLayoutItem fieldLayoutItem)
void makeOptional(FieldLayoutItem fieldLayoutItem)
void makeRequired(FieldLayoutItem fieldLayoutItem)
void setDescription(FieldLayoutItem fieldLayoutItem, String description)
void setDescription(String description)
void setName(String name)
void setRendererType(FieldLayoutItem fieldLayoutItem, String rendererType)
void show(FieldLayoutItem fieldLayoutItem)
Inherited Methods
From interface com.atlassian.jira.issue.fields.layout.field.FieldLayout

Public Methods

public String getType ()

public void hide (FieldLayoutItem fieldLayoutItem)

public void makeOptional (FieldLayoutItem fieldLayoutItem)

public void makeRequired (FieldLayoutItem fieldLayoutItem)

public void setDescription (FieldLayoutItem fieldLayoutItem, String description)

public void setDescription (String description)

public void setName (String name)

public void setRendererType (FieldLayoutItem fieldLayoutItem, String rendererType)

public void show (FieldLayoutItem fieldLayoutItem)