interface Bindable

jsx3.amp.Bindable

All Known Implementing Classes:

jsx3.amp.PlugIn

interface Bindable

No description provided.

Method Summary
void	addBindableProp(key : String, expression : String) Adds a bindable property to this object.
jsx3.$Array<String>	getBindableProps() Returns the list of bindable properties of this object.
void	setBindableProp(key : String, newValue : Object) Sets the current calculated value of a bindable property of this object.
void	updateBindable(key : String) Causes a bindable property of this object to be recalculated.
void	updateBindableOn(key : String, publisher : jsx3.util.EventDispatcher, subject : String) Causes a bindable property to be updated when publisher publishes an event with subject subject.

Method Detail

addBindableProp

void addBindableProp(key : String, expression : String)

Adds a bindable property to this object.

Parameters:

key – the property name.

expression – the binding expression.

getBindableProps

jsx3.$Array<String> getBindableProps()

Returns the list of bindable properties of this object.

Returns:

setBindableProp

void setBindableProp(key : String, newValue : Object)

Sets the current calculated value of a bindable property of this object. If the new value does not match the old value, an event is published. The schema of the event is {subject: propName, oldValue: previousValue, value: newValue}.

Parameters:

key – the property name.

newValue – the next calculated value.

updateBindable

void updateBindable(key : String)

Causes a bindable property of this object to be recalculated. The property is set to the value of the binding expression, evaluated in the context of this object. If the property value has changed then this object will publish an event with subject key.

Parameters:

key – the property to recalculate.

updateBindableOn

void updateBindableOn(key : String, publisher : jsx3.util.EventDispatcher, subject : String)

Causes a bindable property to be updated when publisher publishes an event with subject subject.

Parameters:

key – the property to update.

publisher – the object to which to subscribe.

subject – the event subject to which to subscribe.