Caplin Trader 4.7.1

Class: module:caplin/presenter/property/Alias

module:caplin/presenter/property/Alias

Constructor

new module:caplin/presenter/property/Alias(oProperty)

Constructs a new Alias instance. Alias instances wrap instances of module:br/presenter/property/Property and keep the values synchronised, to allow access to the same property from multiple paths (e.g. double binding).
Extends:
Parameters:
Name Type Description
oProperty module:br/presenter/property/Property The property to wrap.

Extends

Methods

addFormatter(oFormatter, mConfig)

Add a module:br/presenter/formatter/Formatter that will be applied to the property before it's rendered to screen.

Any number of formatters can be added to a property, and will be applied in the same order in which the formatters were added.

Parameters:
Name Type Description
oFormatter module:br/presenter/formatter/Formatter The formatter being added.
mConfig Object (optional) Any additional configuration for the formatter.
Inherited From:

addListener(oListener, bNotifyImmediately)

Add a module:br/presenter/property/PropertyListener that will be notified each time the property is updated.
Parameters:
Name Type Description
oListener module:br/presenter/property/PropertyListener The listener to be added.
bNotifyImmediately boolean Whether to invoke the listener immediately using the current value.
Inherited From:

getFormattedValue()

Returns the formatted value for this property if any formatters have been attached, otherwise returns the raw property value.
Inherited From:

getPath()

Returns the path that would be required to bind this property 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:

getRenderedValue()

Returns the rendered value after applying any active formatters, otherwise returns the raw property value.
Inherited From:

getValue()

Returns the unformatted value for this property.
Inherited From:

removeAllListeners()

Remove all previously added module:br/presenter/property/PropertyListener instances.
Inherited From:

removeListener(oListener)

Remove a previously added module:br/presenter/property/PropertyListener.
Parameters:
Name Type Description
oListener module:br/presenter/property/PropertyListener The listener being removed.
Inherited From: