DescribeLayoutItem Class

Represents an individual item in a QuickAction.DescribeLayoutRow.

Namespace

QuickAction

Usage

For most fields on a layout, there is only one component per layout item. However, in a display-only view, the QuickAction.DescribeLayoutItem might be a composite of the individual fields (for example, an address can consist of street, city, state, country, and postal code data). On the corresponding edit view, each component of the address field would be split up into separate QuickAction.DescribeLayoutItems.

DescribeLayoutItem Methods

The following are methods for DescribeLayoutItem. All are instance methods.

getLabel()

Returns the label text for this item.

Signature

public String getLabel()

Return Value

Type: String

getLayoutComponents()

Returns a list of QuickAction.DescribeLayoutComponents for this item.

Signature

public List<QuickAction.DescribeLayoutComponent> getLayoutComponents()

isEditableForNew()

Indicates whether this item can be edited for new (true) or not (false).

Signature

public Boolean isEditableForNew()

Return Value

Type: Boolean

isEditableForUpdate()

Indicates whether this item can be edited for update(true) or not (false).

Signature

public Boolean isEditableForUpdate()

Return Value

Type: Boolean

isPlaceholder()

Indicates whether this item is a placeholder (true) or not (false). If true, then this item is blank.

Signature

public Boolean isPlaceholder()

Return Value

Type: Boolean

isRequired()

Indicates whether this item is required (true) or not (false).

Signature

public Boolean isRequired()

Return Value

Type: Boolean

Usage

This is useful if, for example, you want to render required fields in a contrasting color.