The goog.labs.observe.Observable Interface

goog.labs.observe.Observable
> goog.disposable.IDisposable

goog.labs.observe.Observable()

Interface for an observable object. @interface

unhandled information:

type
'interface'

.dispose

Inherited from goog.disposable.IDisposable .

Disposes of the object and its resources.

returns {void}
Nothing.

.isDisposed

Inherited from goog.disposable.IDisposable .

returns {boolean}
Whether the object has been disposed of.

.notify(opt_data)

Notifies observers by invoking them. Optionally, a data object may be given to be passed to each observer.

opt_data {*=}
An optional data object.

.observe(observer)

Registers an observer on the observable. Note that no guarantee is provided on order of execution of the observers. For a single notification, one Notice object is reused across all invoked observers. Note that if an observation with the same observer is already registered, it will not be registered again. Comparison is done via observer's {@code equals} method.

observer {!goog.labs.observe.Observer}
The observer to add.
returns {boolean}
Whether the observer was successfully added.

.unobserve(observer)

Unregisters an observer from the observable. The parameter must be the same as those passed to {@code observe} method. Comparison is done via observer's {@code equals} method.

observer {!goog.labs.observe.Observer}
The observer to remove.
returns {boolean}
Whether the observer is removed.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.