new module:br-presenter /node /Node List()
- Deprecated:
- This functionality is provided by an equivalent 'br-' library, and this proxy class will be removed from CaplinTrader in a future release. Please update any references to this class in your code.
- See:
Methods
add Change Listener(fCallback, bNotify Immediately)
Convenience method that allows listeners to be added for objects that do
not themselves implement module:br-presenter/node/NodeListListener
.
Listeners added using addChangeListener()
will only be notified
when module:br-presenter/node/NodeListListener#onNodeListChanged
fires, and
will not be notified if any of the other
module:br-presenter/node/NodeListListener
call-backs fire. The advantage to
using this method is that objects can choose to listen to call-back events on multiple
node lists.
Parameters:
Name | Type | Description |
---|---|---|
fCallback |
function | The call-back that will be invoked each time the property changes. |
bNotifyImmediately |
boolean | (optional) Whether to invoke the listener immediately for the current value. |
add Listener(oListener, bNotify Immediately)
Add a module:br-presenter/node/NodeListListener
that will be notified
each time the node list is updated.
Parameters:
Name | Type | Description |
---|---|---|
oListener |
module:br-presenter |
The listener to be added. |
bNotifyImmediately |
boolean | Whether to invoke the listener immediately using the current node list. |
get Path()
Returns the path that would be required to bind this node from the view.
This method is used internally, but might also be useful in allowing the dynamic construction of views for arbitrary presentation models.
- Inherited From:
get Presentation Nodes Array()
Returns the list of module:br-presenter/node/PresentationNode
instances as an array.
get Template For Node(oPresentation Node)
Returns the name of the template used to render the given presentation node.
Parameters:
Name | Type | Description |
---|---|---|
oPresentationNode |
module:br-presenter |
The presentation node being queried. |
nodes(sNode Name, vProperties)
Returns all nested nodes matching the search criteria reachable from this node.
Care is taken not to search up the tree in cyclic presentation models (where some of the presentation nodes have back references to presentation nodes higher up in the tree).
Parameters:
Name | Type | Description |
---|---|---|
sNodeName |
String | The name of nodes to match. |
vProperties |
Object | Only nodes having this array or map of properties will be matched. |
- Inherited From:
- See:
properties(sProperty Name, vValue)
Returns all nested properties matching the search criteria reachable from this node.
Care is taken not to search up the tree in cyclic presentation models (where some of the presentation nodes have back references to presentation nodes higher up in the tree).
Parameters:
Name | Type | Description |
---|---|---|
sPropertyName |
String | The name of properties to match. |
vValue |
Object | The value of properties to match. |
- Inherited From:
- See:
remove All Listeners()
Remove all previously added module:br-presenter/node/NodeListListener
instances.
remove Child Listeners()
Removes all listeners attached to the properties contained by this PresentationNode
, and any nodes it contains.
- Inherited From:
remove Listener(oListener)
Remove a previously added module:br-presenter/node/NodeListListener
.
Parameters:
Name | Type | Description |
---|---|---|
oListener |
module:br-presenter |
The listener being removed. |
update List(pPresentation Nodes)
Updates the node list with a new array of module:br-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:
Name | Type | Description |
---|---|---|
pPresentationNodes |
Array | The new list of |