Constructor
new module:br/presenter/property/Alias(oProperty)
Alias
instance.
Parameters:
Name | Type | Description |
---|---|---|
oProperty |
module:br/presenter/property/Property | The property to wrap. |
Extends
Methods
-
addChangeListener(oListener, sMethod, bNotifyImmediatelyopt)
-
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 whenmodule:br/presenter/property/PropertyListener#onPropertyChanged
fires, and will not be notified if any of the othermodule: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.Parameters:
Name Type Attributes Description oListener
Object The listener to be added. sMethod
String The name of the method on the listener 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:
-
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:
-
addUpdateListener(oListener, sMethod, bNotifyImmediately)
-
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 whenmodule:br/presenter/property/PropertyListener#onPropertyUpdated
fires, and will not be notified if any of the othermodule: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.Parameters:
Name Type Description oListener
Object The listener to be added. sMethod
String The name of the method on the listener that will be invoked each time the property changes. bNotifyImmediately
boolean (optional) Whether to invoke the listener immediately for 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: