events.EventHandler Extends goog.Disposable
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.

Inheritance

Constructor

goog.events.EventHandler(opt_handler)

Parameters

opt_handler :
(Object | null | undefined)
Object in whose scope to call the listeners.

Instance Methods

Public Protected Private
Defined in goog.events.EventHandler
disposeInternal()
Disposes of this EventHandler and removes all listeners that it registered.
code »
getListenerCount() ⇒
number
No description.
Returns: 
number
  Number of listeners registered by this handler.
code »
handleEvent(e)
Default event handler
Arguments:
e :
(goog.events.Event | null)
Event object.
code »
listen(src, type, opt_fn, opt_capture, opt_handler) ⇒
(goog.events.EventHandler | null)
Listen to an event on a DOM node or EventTarget. If the function is omitted then the EventHandler's handleEvent method will be used.
Arguments:
src :
(EventTarget | goog.events.EventTarget | null)
Event source.
type :
(Array | null | string)
Event type to listen for or array of event types.
opt_fn :
(Object | null | undefined)
Optional callback function to be used as the listener or an object with handleEvent function.
opt_capture :
(boolean | undefined)
Optional whether to use capture phase.
opt_handler :
(Object | null | undefined)
Object in whose scope to call the listener.
Returns: 
(goog.events.EventHandler | null)
  This object, allowing for chaining of calls.
code »
listenOnce(src, type, opt_fn, opt_capture, opt_handler) ⇒
(goog.events.EventHandler | null)
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.
Arguments:
src :
(EventTarget | goog.events.EventTarget | null)
Event source.
type :
(Array | null | string)
Event type to listen for or array of event types.
opt_fn :
(Object | null | undefined)
Optional callback function to be used as the listener or an object with handleEvent function.
opt_capture :
(boolean | undefined)
Optional whether to use capture phase.
opt_handler :
(Object | null | undefined)
Object in whose scope to call the listener.
Returns: 
(goog.events.EventHandler | null)
  This object, allowing for chaining of calls.
code »
listenWithWrapper(src, wrapper, listener, opt_capt, opt_handler) ⇒
(goog.events.EventHandler | null)
Adds an event listener with a specific event wrapper on a DOM Node or an object that has implemented goog.events.EventTarget. A listener can only be added once to an object.
Arguments:
src :
(EventTarget | goog.events.EventTarget | null)
The node to listen to events on.
wrapper :
(goog.events.EventWrapper | null)
Event wrapper to use.
listener :
(Object | null)
Callback method, or an object with a handleEvent function.
opt_capt :
(boolean | undefined)
Whether to fire in capture phase (defaults to false).
opt_handler :
(Object | null | undefined)
Element in whose scope to call the listener.
Returns: 
(goog.events.EventHandler | null)
  This object, allowing for chaining of calls.
code »
removeAll()
Unlistens to all events.
code »
unlisten(src, type, opt_fn, opt_capture, opt_handler) ⇒
(goog.events.EventHandler | null)
Unlistens on an event.
Arguments:
src :
(EventTarget | goog.events.EventTarget | null)
Event source.
type :
(Array | null | string)
Event type to listen for.
opt_fn :
(Object | null | undefined)
Optional callback function to be used as the listener or an object with handleEvent function.
opt_capture :
(boolean | undefined)
Optional whether to use capture phase.
opt_handler :
(Object | null | undefined)
Object in whose scope to call the listener.
Returns: 
(goog.events.EventHandler | null)
  This object, allowing for chaining of calls.
code »
unlistenWithWrapper(src, wrapper, listener, opt_capt, opt_handler) ⇒
(goog.events.EventHandler | null)
Removes an event listener which was added with listenWithWrapper().
Arguments:
src :
(EventTarget | goog.events.EventTarget | null)
The target to stop listening to events on.
wrapper :
(goog.events.EventWrapper | null)
Event wrapper to use.
listener :
(Object | null)
The listener function to remove.
opt_capt :
(boolean | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handler :
(Object | null | undefined)
Element in whose scope to call the listener.
Returns: 
(goog.events.EventHandler | null)
  This object, allowing for chaining of calls.
code »
Defined in goog.Disposable
dispose() ⇒
undefined
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: 
undefined
  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example: 
mypackage.MyClass = function() {
goog.base(this);
// Constructor logic specific to MyClass.
...
};
goog.inherits(mypackage.MyClass, goog.Disposable);

mypackage.MyClass.prototype.disposeInternal = function() {
goog.base(this, 'disposeInternal');
// Dispose logic specific to MyClass.
...
};
code »
getDisposed() ⇒
boolean
Use #isDisposed instead. No description.
Returns: 
boolean
  Whether the object has been disposed of.
code »
isDisposed() ⇒
boolean
No description.
Returns: 
boolean
  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable :
(goog.disposable.IDisposable | null)
that will be disposed when this object is disposed.
code »

Instance Properties

Defined in goog.events.EventHandler
keys_ :
(Array | null)
Keys for events that are being listened to.
Code »
Defined in goog.Disposable
dependentDisposables_ :
(Array | null)
Disposables that should be disposed when this object is disposed.
Code »
disposed_ :
boolean
Whether the object has been disposed of.
Code »

Static Properties

goog.events.EventHandler.typeArray_ :
(Array | null)
Utility array used to unify the cases of listening for an array of types and listening for a single event, without using recursion or allocating an array each time.
Code »

Package events

Package Reference