• index
• goog
• events
• search: Go

The goog.events.EventHandler Class

goog.events.EventHandler
> goog.Disposable

goog.events.EventHandler(opt_handler)

Super class for objects that want to easily manage a number of event listeners. It allows a short cut to listen and also provides a quick way to remove all events listeners belonging to this object.

opt_handler {Object=}

Object in whose scope to call the listeners.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

.getListenerCount()

returns {number}

Number of listeners registered by this handler.

.handleEvent(e)

Default event handler

e {goog.events.Event}

Event object.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.listen(src, type, opt_fn, opt_capture, opt_handler)

Listen to an event on a DOM node or EventTarget. If the function is omitted then the EventHandler's handleEvent method will be used.

src {goog.events.EventTarget|EventTarget}

Event source.

type {string|Array.<string>}

Event type to listen for or array of event types.

opt_fn {Function|Object=}

Optional callback function to be used as the listener or an object with handleEvent function.

opt_capture {boolean=}

Optional whether to use capture phase.

opt_handler {Object=}

Object in whose scope to call the listener.

returns {goog.events.EventHandler}

This object, allowing for chaining of calls.

.listenOnce(src, type, opt_fn, opt_capture, opt_handler)

Listen to an event on a DOM node or EventTarget. If the function is omitted then the EventHandler's handleEvent method will be used. After the event has fired the event listener is removed from the target. If an array of event types is provided, each event type will be listened to once.

src {goog.events.EventTarget|EventTarget}

Event source.

type {string|Array.<string>}

Event type to listen for or array of event types.

opt_fn {Function|Object=}

Optional callback function to be used as the listener or an object with handleEvent function.

opt_capture {boolean=}

Optional whether to use capture phase.

opt_handler {Object=}

Object in whose scope to call the listener.

returns {goog.events.EventHandler}

This object, allowing for chaining of calls.

.listenWithWrapper(src, wrapper, listener, opt_capt, opt_handler)

Adds an event listener with a specific event wrapper on a DOM Node or an object that has implemented {@link goog.events.EventTarget}. A listener can only be added once to an object.

src {EventTarget|goog.events.EventTarget}

The node to listen to events on.

wrapper {goog.events.EventWrapper}

Event wrapper to use.

listener {Function|Object}

Callback method, or an object with a handleEvent function.

opt_capt {boolean=}

Whether to fire in capture phase (defaults to false).

opt_handler {Object=}

Element in whose scope to call the listener.

returns {goog.events.EventHandler}

This object, allowing for chaining of calls.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.removeAll()

Unlistens to all events.

.unlisten(src, type, opt_fn, opt_capture, opt_handler)

Unlistens on an event.

src {goog.events.EventTarget|EventTarget}

Event source.

type {string|Array.<string>}

Event type to listen for.

opt_fn {Function|Object=}

Optional callback function to be used as the listener or an object with handleEvent function.

opt_capture {boolean=}

Optional whether to use capture phase.

opt_handler {Object=}

Object in whose scope to call the listener.

returns {goog.events.EventHandler}

This object, allowing for chaining of calls.

.unlistenWithWrapper(src, wrapper, listener, opt_capt, opt_handler)

Removes an event listener which was added with listenWithWrapper().

src {EventTarget|goog.events.EventTarget}

The target to stop listening to events on.

wrapper {goog.events.EventWrapper}

Event wrapper to use.

listener {Function|Object}

The listener function to remove.

opt_capt {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handler {Object=}

Element in whose scope to call the listener.

returns {goog.events.EventHandler}

This object, allowing for chaining of calls.

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