Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.presenter.node

OptionsNodeList

Extends caplin.presenter.node.NodeList.
The OptionsNodeList class is used to store the options available within caplin.presenter.node.SelectionField and caplin.presenter.node.MultiSelectionField instances.

Constructor Summary

Attributes Name and Description
caplin.presenter.node.OptionsNodeList(Object vOptions)

Constructs a new OptionsNodeList instance.

Method Summary

Attributes Name and Description
caplin.presenter.node.Option getFirstOption()

Retrieve the first option in the list — typically the default option.
void getOptionByLabel(String sLabel)

Retrieve the option with the given label.
void getOptionByValue(String sValue)

Retrieve the option with the given unique value.
Array getOptionLabels()

Retrieve an array of labels for each caplin.presenter.node.Option contained within this object.
Array getOptions()

Retrieve the array of caplin.presenter.node.Option instances contained by this object.
Array getOptionValues()

Retrieve an array of values for each caplin.presenter.node.Option contained within this object.
void setOptions(Object vOptions)

Reset the list of available options using the given array or map.
Methods inherited from class caplin.presenter.node.NodeList:
addChangeListener, addListener, getPresentationNodesArray, getTemplateForNode, removeAllListeners, removeListener, updateList
Methods from caplin.presenter.node.PresentationNode:
getPath, nodes, properties, removeChildListeners

Constructor Detail

► caplin.presenter.node.OptionsNodeList(Object vOptions)

Constructs a new OptionsNodeList instance.

Parameters
Object vOptions The set of available options, either as an array (keys only) or a map (keys to label).

Method Detail

► caplin.presenter.node.Option getFirstOption()

Retrieve the first option in the list — typically the default option.

► void getOptionByLabel(String sLabel)

Retrieve the option with the given label. (If there is more than one option which has the given label, the first instance is returned.)

Parameters
String sLabel Label to search.

► void getOptionByValue(String sValue)

Retrieve the option with the given unique value.

Parameters
String sValue Value to search.

► Array getOptionLabels()

Retrieve an array of labels for each caplin.presenter.node.Option contained within this object.

► Array getOptions()

Retrieve the array of caplin.presenter.node.Option instances contained by this object.

► Array getOptionValues()

Retrieve an array of values for each caplin.presenter.node.Option contained within this object.

► void setOptions(Object vOptions)

Reset the list of available options using the given array or map.

Parameters
Object vOptions The set of available options, either as an array (keys only) or a map (keys to label).