Skip to navigation
Apex Toolkit reference

ReadWriteTab

View as Markdown
global abstract class ReadWriteTab extends Tab
Description
Base class for read/write tabs. This class may not be directly instantiated.
collaboration
global Tab.Collaboration collaboration
Tab collaboration settings.
formatting
global Tab.Formatting formatting
Tab formatting settings.
mergeField
global Tab.MergeField mergeField
Contains the information necessary to map the tab to a field in SalesForce.
readOnly
global Boolean readOnly
When set to true, the signer cannot change the data of the custom tab.

Corresponds to the locked API property.

required
global Boolean required
When set to true, the signer is required to fill out this tab.
validation
global Tab.Validation validation
Tab validation settings.
value
global Object value
Specifies the value of the tab.

Methods

global ReadWriteTab withCollaboration(final Tab.Collaboration collaboration)
Description
Updates the tab collaboration property.
Returns
The tab with an updated collaboration value.
Parameters
collaboration
final Tab.Collaboration collaboration
Tab collaboration settings.
global ReadWriteTab withFormatting(final Tab.Formatting formatting)
Description
Updates the tab formatting property.
Returns
The tab with an updated formatting value.
Parameters
formatting
final Tab.Formatting formatting
Tab formatting settings.
global ReadWriteTab withMergeField(final Tab.MergeField mergeField)
Description
Updates the tab mergeField property.
Returns
The tab with an updated mergeField value.
Parameters
mergeField
final Tab.MergeField mergeField
Contains the information necessary to map the tab to a field in SalesForce.
global ReadWriteTab withReadOnly(final Boolean readOnly)
Description
Updates the tab readOnly property.
Returns
The tab with an updated readOnly value.
Parameters
readOnly
final Boolean readOnly
When set to true, the signer cannot change the data of the custom tab.
global ReadWriteTab withRequired(final Boolean required)
Description
Updates the tab required property.
Returns
The tab with an updated required value.
Parameters
required
final Boolean required
When set to true, the signer is required to fill out this tab.
global ReadWriteTab withValidation(final Tab.Validation validation)
Description
Updates the tab validation property.
Returns
The tab with an updated validation value.
Parameters
validation
final Tab.Validation validation
Tab validation settings.
global ReadWriteTab withValue(final Object value)
Description
Updates the tab value property.
Returns
The tab with an updated value value.
Parameters
value
final Object value
Specifies the value of the tab.