► caplin.presenter.property.PropertyHelper()

The PropertyHelper is a utility to simplify the attaching and monitoring of property listeners.

This is a useful class if you want to keep track of all the properties of certain node in a single place. It will also provide some methods that give you extra functionality for handling call-backs from your properties.

► caplin.presenter.property.PropertyHelper addChangeListener(caplin.presenter.property.Property oProperty, Object oScope, Function|String vHandler, Boolean bCallNow)

Adds a change listener to the supplied property. Can accept either a String method name or a function reference as the handler callback

Returns

{caplin.presenter.property.PropertyHelper}

► caplin.presenter.property.PropertyHelper addChangeNotification(caplin.presenter.property.Property oProperty, Object oScope, Function|String vHandler, Boolean bCallNow)

Adds a change listener to the supplied property. The function handler will be called with three arguments: the new value of the property, the previous value of the property and the property itself.

You can use this method in case you want to receive in your change handler the property's old value as well as the new one.

Returns

{caplin.presenter.property.PropertyHelper}

► caplin.presenter.property.PropertyHelper addUpdateListener(caplin.presenter.property.Property oProperty, Object oScope, Function|String vHandler, Boolean bCallNow)

Adds an update listener to the supplied property. Can accept either a String method name or a function reference as the handler callback

Returns

{caplin.presenter.property.PropertyHelper}

► void addValidationChangeListener(caplin.presenter.property.EditableProperty oProperty, Object oScope, Function|String vHandler, Boolean bCallNow)

Adds a listener for the validation state changing on the supplied editable property. Can accept either a String method name or a function reference as the handler callback. Note that as this method attaches multiple handlers, there is no return value; in order to remove listeners created by this method, use either #removeAllListeners or #clearProperty. The function used as the handler will be called with two arguments, a boolean value that shows the validation status (true for valid and false for error) and the property.

► caplin.presenter.property.PropertyHelper addValidationErrorListener(caplin.presenter.property.Property oProperty, Object oScope, Function|String vHandler, Boolean bCallNow)

Adds a listener for the validation error event to the supplied property. Can accept either a String method name or a function reference as the handler callback

Returns

{caplin.presenter.property.PropertyHelper}

► caplin.presenter.property.PropertyHelper addValidationSuccessListener(caplin.presenter.property.Property oProperty, Object oScope, Function|String vHandler, Boolean bCallNow)

Adds a listener for the validation success event to the supplied property. Can accept either a String method name or a function reference as the handler callback

Returns

{caplin.presenter.property.PropertyHelper}

► caplin.presenter.property.PropertyHelper clearProperty(caplin.presenter.property.Property oProperty, String sType)

Removes any listener bound to the supplied property that was attached by this PropertyHelper

Returns

{caplin.presenter.property.PropertyHelper}

► void removeAllListeners()

Removes all listeners attached through this PropertyHelper

► caplin.presenter.property.PropertyHelper removeChangeListeners(caplin.presenter.property.Property oProperty)

Remove change handlers from the selected property that have been attached through this PropertyHelper

Returns

{caplin.presenter.property.PropertyHelper}

► caplin.presenter.property.PropertyHelper removeValidationSuccessListeners(caplin.presenter.property.Property oProperty)

Remove validation success handlers from the selected property that have been attached through this PropertyHelper

Returns

{caplin.presenter.property.PropertyHelper}