Caplin Trader 5.1.0

Class: module:br-presenter/node/Button

module:br-presenter/node/Button(vLabel)

A PresentationNode containing all of the attributes necessary to model a button on screen.

Constructor

new module:br-presenter/node/Button(vLabel)

Extends:
Parameters:
Name Type Description
vLabel

(optional) The text that will be displayed within the button — can be a String or a module:br-presenter/property/Property.

Extends

Members

enabled :br-presenter/property/WritableProperty

A boolean property representing whether the button is enabled or not.

Type:
  • br-presenter/property/WritableProperty

label :br-presenter/property/WritableProperty

The text currently displayed within the button.

Type:
  • br-presenter/property/WritableProperty

visible :br-presenter/property/WritableProperty

A boolean property representing whether the button is visible or not.

Type:
  • br-presenter/property/WritableProperty

Methods

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: