Caplin Trader 5.1.0

Class: module:br-presenter/node/ComponentNode

module:br-presenter/node/ComponentNode(oComponent)

Allows components to be embedded within a presentation model so that they can be displayed as part of the template.

Component instances can be embedded within a template as follows:

  <div data-bind="component:componentNode, width:widthProperty, height:heightProperty"></div>

where componentNode is an instance of ComponentNode.

Constructor

new module:br-presenter/node/ComponentNode(oComponent)

Extends:
Parameters:
Name Type Description
oComponent module:br-component/Component

The component to be displayed on the page.

Extends

Methods

getComponent()

Retrieve the component stored within this node.

getPath()

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:

nodes(sNodeName, 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(sPropertyName, 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:

removeAllListeners()

Inherited From:
Deprecated:
  • This method has been replaced by #removeChildListeners which recurses the node tree. Removes all listeners attached to the properties contained by this PresentationNode.

removeChildListeners()

Removes all listeners attached to the properties contained by this PresentationNode, and any nodes it contains.

Inherited From: