Skip to navigation
Apex Toolkit reference

ListTab

View as Markdown
global class ListTab extends ReadWriteTab
Description
A list tab enables the recipient to choose from a list of options. You specify the options in the items property. This value can't be set.
items
global List<Item> items
The list of items that can be selected by senders.

Corresponds to the listItems API property.

Methods

global ListTab()
Description
Constructs a list tab.
global ListTab withItems(final List<Item> items)
Description
Updates the tab items property.
Returns
The tab with an updated items value.
Parameters
items
final List<Item> items
The list of items that can be selected by senders.

ListTab.Item

global class Item
Description
A selectable list tab item.
label
global String label
Specifies the text that is shown in the dropdown list.

Corresponds to the text API parameter.

selected
global Boolean selected
When set to true, indicates that this item is the default selection shown to a signer.

Only one selection can be set as the default.

value
global Object value
Specifies the value that is used when the list item is selected.

Methods

global Item(final String label, final Object value, final Boolean selected)
Parameters
label
final String label
Specifies the text that is shown in the dropdown list.
value
final Object value
Specifies the value that is used when the list item is selected.
selected
final Boolean selected
When set to true, indicates that this item is the default selection shown to a signer.