Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
DescribeAvailableQuickActionResult Class
DescribeLayoutComponent Class
DescribeLayoutItem Class
DescribeLayoutItem Methods
DescribeLayoutRow Class
DescribeLayoutSection Class
DescribeQuickActionDefaultValue Class
DescribeQuickActionParameter Class
DescribeQuickActionResult Class
QuickActionDefaults Class
QuickActionDefaultsHandler Interface
QuickActionRequest Class
QuickActionResult Class
SendEmailQuickActionDefaults Class
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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>

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.