Apex Developer Guide

Getting Started
Writing Apex
Ways to Invoke Apex
Finishing Touches
Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Process Namespace
QuickAction Namespace
DescribeAvailableQuickActionResult Class
DescribeLayoutComponent Class
DescribeLayoutItem Class
DescribeLayoutItem Methods
DescribeLayoutRow Class
DescribeLayoutSection Class
DescribeQuickActionDefaultValue Class
DescribeQuickActionResult Class
QuickActionDefaults Class
QuickActionDefaultsHandler Interface
QuickActionRequest Class
QuickActionResult Class
SendEmailQuickActionDefaults Class
Reports Namespace
Schema Namespace
Search Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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()

Return Value

Type: List<QuickAction.DescribeLayoutComponent>

isEditable()

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

Signature

public Boolean isEditable()

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.