Class TKObject

Object
   |
   +--TKObject

class TKObject

The TKObject class is the base class for all TuneKit objects and provides a way to receive and trigger notifications when a JavaScript property changes.

Observing a property on an object is done through the addPropertyObserver method, specifying the property to observe as well as the object that will receive the notifications of the property change. Likewise, an object can stop observing such changes using the removePropertyObserver method. When a property value changes, the author needs to call the notifyPropertyChange method so that registered observers will be notified. Note that synthetized properties will automatically trigger notifications when changed, so in this case, setters need not manually call notifyPropertyChange.

Finally, TKObject also provides the callSuper method to call the superclass's implementation of an overload method.

Field Detail

observedProperties

Object observedProperties

TKObject

TKObject()

addPropertyObserver

void addPropertyObserver(<String> propertyName, <Object> observer, <String> methodName)

Adds an observer for the named property on this object. In case an existing combination of the observer and property is already registered, this method is a no-op.

Parameters:
propertyName - The property to observe.
observer - The object that will be notified when the property is changed.
methodName - The optional method name that will be called on the observer when the property is changed. If this property is not provided, the observer must implement the TKPropertyValueChange protocol.

callMethodNameAfterDelay

int callMethodNameAfterDelay(<String> methodName, <int> delay)

Calls a method on this object after a delay, allowing any number of optional extra arguments to be passed after the first two mandatory ones.

Parameters:
methodName - The method name to be called.
delay - The delay in miliseconds.

Returns:
The timeout that can be used to call clearTimeout.

callSuper

Object callSuper()

This method calls the object's superclass implementation of the current method

notifyPropertyChange

void notifyPropertyChange(<String> propertyName)

Triggers a notification that the given property on this object has changed. For synthesized properties, this is called automatically upon setting the property. For methods that update an instance variable that is not synthesized, notifyPropertyChange() has to be called manually so that observers are notified.

Parameters:
propertyName - The observed property.

removePropertyObserver

bool removePropertyObserver(<String> propertyName, <Object> observer)

Removes the observer for the named property on this object. In case an existing combination of the observer and property is not already registered, this method is a no-op.

Parameters:
propertyName - The observed property.
observer - The object that was notified when the property changed.

Returns:
Whether an observer was removed