Constructor
new module:br-presenter
Constructs a new WritableProperty instance.
Extends:
Parameters:
| Name | Type | Description |
|---|---|---|
vValue |
Object | (optional) The default value for this property. |
Extends
Methods
add
Convenience method that allows a change listener to be added to added for objects
that do not themselves implement module:br-presenter/property/PropertyListener.
Listeners added using addChangeListener() will only be notified
when module:br-presenter/property/PropertyListener#onPropertyChanged fires, and
will not be notified if any of the other
module:br-presenter/property/PropertyListener call-backs fire. The advantage to
using this method is that objects can choose to listen to call-back events on multiple
properties.
We also allow oListener and sMethod to be used in place of
fCallback, but this form is now deprecated as it's imcompatible with
Closure Compiler's property renaming feature.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
fCallback |
function | The call-back that will be invoked each time the property changes. |
|
bNotifyImmediately |
boolean |
<optional> |
(optional) Whether to invoke the listener immediately for the current value. |
- Inherited From:
add
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 |
The formatter being added. |
mConfig |
Object | (optional) Any additional configuration for the formatter. |
- Inherited From:
add
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 |
The listener to be added. |
bNotifyImmediately |
boolean | Whether to invoke the listener immediately using the current value. |
- Inherited From:
add
Convenience method that allows an update listener to be added to added for objects
that do not themselves implement module:br-presenter/property/PropertyListener.
Listeners added using addUpdateListener() will only be notified
when module:br-presenter/property/PropertyListener#onPropertyUpdated fires, and
will not be notified if any of the other
module:br-presenter/property/PropertyListener call-backs fire. The advantage to
using this method is that objects can choose to listen to call-back events on multiple
properties.
We also allow oListener and sMethod to be used in place of
fCallback, but this form is now deprecated as it's imcompatible with
Closure Compiler's property renaming feature.
Parameters:
| Name | Type | Description |
|---|---|---|
fCallback |
function | The call-back that will be invoked each time the property is updated. |
bNotifyImmediately |
boolean | (optional) Whether to invoke the listener immediately for the current value. |
- Inherited From:
get
Returns the formatted value for this property if any formatters have been attached, otherwise returns the raw property value.
- Inherited From:
get
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:
get
Returns the rendered value after applying any active formatters, otherwise returns the raw property value.
- Inherited From:
get
Returns the unformatted value for this property.
- Inherited From:
remove
Remove all previously added module:br-presenter/property/PropertyListener instances.
- Inherited From:
remove
Remove a previously added module:br-presenter/property/PropertyListener.
Parameters:
| Name | Type | Description |
|---|---|---|
oListener |
module:br-presenter |
The listener being removed. |
- Inherited From:
set
Sets the unformatted value for this property and notifies listeners of the change.
This method is called from the presentation model only, and does not allow user editable controls to be bound from the view.
Parameters:
| Name | Type | Description |
|---|---|---|
vValue |
Variant | The new value for this property. |