Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.presenter.node

MappedNodeList

The class is still in Beta and is subject to API changes.
Extends caplin.presenter.node.NodeList.
MappedNodeList is a caplin.presenter.node.NodeList.

The MappedNodeList class is useful when you want to refer to items in a caplin.presenter.node.NodeList (which stores items in an array) using a name, rather than then ordinal position within the array. The mappings are only accessible via the PresentationNode representation of the list and not from the view i.e. can't refer to the mappings in templates.

The contents of the MappedNodeList class should only be modified using the #updateList method, and this will cause the view to immediately update to reflect the contents of the new Map.

If the optional second parameter to the constructor, fNodeClass, is provided, then the MappedNodeList will need all the nodes it is expected to contain to be instances of fNodeClass (i.e. subclasses are allowed), otherwise it throws a caplin.core.Error.

Constructor Summary

Attributes Name and Description
caplin.presenter.node.MappedNodeList(Map mPresentationNodes, Function fNodeClass)

Constructs a new instance of MappedNodeList.

Method Summary

Attributes Name and Description
Object getPresentationNodesMap()

Returns the string-to-node mapping.
void updateList(Array mPresentationNodes)

Updates the node list with a new Map of caplin.presenter.node.PresentationNode instances.
Methods inherited from class caplin.presenter.node.NodeList:
addChangeListener, addListener, getPresentationNodesArray, getTemplateForNode, removeAllListeners, removeListener

Constructor Detail

► caplin.presenter.node.MappedNodeList(Map mPresentationNodes, Function fNodeClass)

Constructs a new instance of MappedNodeList.

Parameters
Map mPresentationNodes The initial map of caplin.presenter.node.PresentationNode instances.
Function fNodeClass (optional) The class/interface that all nodes in this list should be an instance of.

Method Detail

► Object getPresentationNodesMap()

Returns the string-to-node mapping. Treat as immutable.

► void updateList(Array mPresentationNodes)

Updates the node list with a new Map of caplin.presenter.node.PresentationNode instances.

Care must be taken to always invoke this method when the contents of the node list change. The array returned by #getPresentationNodesArray should be treated as being immutable.

Parameters
Array mPresentationNodes The new map of caplin.presenter.node.PresentationNode instances.