goog.events.EventHandler

Provided By	`goog.events.EventHandler`
Extends	`goog.Disposable`
All Implemented Interfaces	`goog.disposable.IDisposable`

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.

new EventHandler`<SCOPE>`( `opt_scope` )

Parameters

`opt_scope`	`(SCOPE\|null)=`
	Object in whose scope to call the listeners.

VIEW SOURCE

Instance Methods

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Defined by

goog.Disposable

Parameters

`callback`	`function(): ?`
	The callback function.
`opt_scope`	`(T\|null)=`
	An optional scope to call the callback in.

VIEW SOURCE

Disposes of the object and its resources.

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

Nothing.

VIEW SOURCE

Disposes of this EventHandler and removes all listeners that it registered.

Overrides	`goog.events.EventHandler`
Parameters	None.

VIEW SOURCE

Deprecated	Use `#isDisposed` instead.

Defined by

goog.Disposable

Parameters

None.

Returns

boolean

Whether the object has been disposed of.

VIEW SOURCE

Overrides

goog.events.EventHandler

Parameters

None.

Returns

number

Number of listeners registered by this handler.

VIEW SOURCE

Default event handler

Overrides

goog.events.EventHandler

Parameters

`e`	`(goog.events.Event\|null)`
	Event object.

VIEW SOURCE

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

boolean

Whether the object has been disposed of.

VIEW SOURCE

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

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	Event source.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type to listen for or array of event types.
`opt_fn`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null)=`
	Optional callback function to be used as the listener or an object with handleEvent function.
`opt_options`	`(boolean\|AddEventListenerOptions)=`

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

Listen to an event on a Listenable. 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.

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	Event source.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type to listen for or array of event types.
`opt_fn`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null)=`
	Optional callback function to be used as the listener or an object with handleEvent function.
`opt_options`	`(boolean\|AddEventListenerOptions)=`

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	Event source.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type to listen for or array of event types.
`fn`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null\|undefined)`
	Optional callback function to be used as the listener or an object with handleEvent function.
`capture`	`(boolean\|undefined)`
	Optional whether to use capture phase.
`scope`	`(T\|null)`
	Object in whose scope to call the listener.

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

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

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	Event source.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type to listen for or array of event types.
`fn`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null\|undefined)`
	Optional callback function to be used as the listener or an object with handleEvent function.
`options`	`(boolean\|AddEventListenerOptions\|undefined)`

`scope`	`(T\|null)`
	Object in whose scope to call the listener.

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

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.

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.EventTarget\|null)`
	The node to listen to events on.
`wrapper`	`(goog.events.EventWrapper\|null)`
	Event wrapper to use.
`listener`	`(function(?): ?\|{handleEvent: function(?): ?}\|null)`
	Callback method, or an object with a handleEvent function.
`opt_capt`	`boolean=`
	Whether to fire in capture phase (defaults to false).

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

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.

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.EventTarget\|null)`
	The node to listen to events on.
`wrapper`	`(goog.events.EventWrapper\|null)`
	Event wrapper to use.
`listener`	`(function(?): ?\|{handleEvent: function(?): ?}\|null)`
	Optional callback function to be used as the listener or an object with handleEvent function.
`capture`	`(boolean\|undefined)`
	Optional whether to use capture phase.
`scope`	`(T\|null)`
	Object in whose scope to call the listener.

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

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

Defined by

goog.Disposable

Parameters

`disposable`	`(goog.disposable.IDisposable\|null)`
	that will be disposed when this object is disposed.

VIEW SOURCE

Unlistens to all events.

Overrides	`goog.events.EventHandler`
Parameters	None.

VIEW SOURCE

Unlistens on an event.

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	Event source.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type or array of event types to unlisten to.
`opt_fn`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null)=`
	Optional callback function to be used as the listener or an object with handleEvent function.
`opt_options`	`(boolean\|EventListenerOptions)=`

`opt_scope`	`(Object\|null)=`
	Object in whose scope to call the listener.

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

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

Overrides

goog.events.EventHandler

Parameters

`src`	`(EventTarget\|goog.events.EventTarget\|null)`
	The target to stop listening to events on.
`wrapper`	`(goog.events.EventWrapper\|null)`
	Event wrapper to use.
`listener`	`(function(?): ?\|{handleEvent: function(?): ?}\|null)`
	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_scope`	`(Object\|null)=`
	Element in whose scope to call the listener.

Returns

THIS

This object, allowing for chaining of calls.

VIEW SOURCE

Instance Properties

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

VIEW SOURCE

No information.

VIEW SOURCE

goog.events.EventHandler`<SCOPE>`

new EventHandler`<SCOPE>`( `opt_scope` )

Instance Methods

`this.`addOnDisposeCallback`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`dispose() `→` `?`

`this.`disposeInternal() `→` `void`

`this.`getDisposed() `→` `boolean`

`this.`getListenerCount() `→` `number`

`this.`handleEvent( `e` ) `→` `void`

`this.`isDisposed() `→` `boolean`

`this.`listen`<EVENTOBJ, THIS>`( `src`, `type`, `opt_fn`, `opt_options` ) `→` `THIS`

`this.`listenOnce`<EVENTOBJ, THIS>`( `src`, `type`, `opt_fn`, `opt_options` ) `→` `THIS`

`this.`listenOnceWithScope`<T, EVENTOBJ, THIS>`( `src`, `type`, `fn`, `capture`, `scope` ) `→` `THIS`

`this.`listenWithScope`<T, EVENTOBJ, THIS>`( `src`, `type`, `fn`, `options`, `scope` ) `→` `THIS`

`this.`listenWithWrapper`<THIS>`( `src`, `wrapper`, `listener`, `opt_capt` ) `→` `THIS`

`this.`listenWithWrapperAndScope`<T, THIS>`( `src`, `wrapper`, `listener`, `capture`, `scope` ) `→` `THIS`

`this.`registerDisposable( `disposable` ) `→` `void`

`this.`removeAll() `→` `void`

`this.`unlisten`<EVENTOBJ, THIS>`( `src`, `type`, `opt_fn`, `opt_options`, `opt_scope` ) `→` `THIS`

`this.`unlistenWithWrapper`<THIS>`( `src`, `wrapper`, `listener`, `opt_capt`, `opt_scope` ) `→` `THIS`

Instance Properties

`this.`creationStack `→` `(string|undefined)`

`this.`handler_ `→` `(SCOPE|undefined)`

goog.events.EventHandler<SCOPE>

new EventHandler<SCOPE>( opt_scope )

Instance Methods

this.addOnDisposeCallback<T>( callback, opt_scope ) → void

this.dispose() → ?

this.disposeInternal() → void

this.getDisposed() → boolean

this.getListenerCount() → number

this.handleEvent( e ) → void

this.isDisposed() → boolean

this.listen<EVENTOBJ, THIS>( src, type, opt_fn, opt_options ) → THIS

this.listenOnce<EVENTOBJ, THIS>( src, type, opt_fn, opt_options ) → THIS

this.listenOnceWithScope<T, EVENTOBJ, THIS>( src, type, fn, capture, scope ) → THIS

this.listenWithScope<T, EVENTOBJ, THIS>( src, type, fn, options, scope ) → THIS

this.listenWithWrapper<THIS>( src, wrapper, listener, opt_capt ) → THIS

this.listenWithWrapperAndScope<T, THIS>( src, wrapper, listener, capture, scope ) → THIS

this.registerDisposable( disposable ) → void

this.removeAll() → void

this.unlisten<EVENTOBJ, THIS>( src, type, opt_fn, opt_options, opt_scope ) → THIS

this.unlistenWithWrapper<THIS>( src, wrapper, listener, opt_capt, opt_scope ) → THIS

Instance Properties

this.creationStack → (string|undefined)

this.handler_ → (SCOPE|undefined)

goog.events.EventHandler`<SCOPE>`

new EventHandler`<SCOPE>`( `opt_scope` )

`this.`addOnDisposeCallback`<T>`( `callback`, `opt_scope` ) `→` `void`

`this.`dispose() `→` `?`

`this.`disposeInternal() `→` `void`

`this.`getDisposed() `→` `boolean`

`this.`getListenerCount() `→` `number`

`this.`handleEvent( `e` ) `→` `void`

`this.`isDisposed() `→` `boolean`

`this.`listen`<EVENTOBJ, THIS>`( `src`, `type`, `opt_fn`, `opt_options` ) `→` `THIS`

`this.`listenOnce`<EVENTOBJ, THIS>`( `src`, `type`, `opt_fn`, `opt_options` ) `→` `THIS`

`this.`listenOnceWithScope`<T, EVENTOBJ, THIS>`( `src`, `type`, `fn`, `capture`, `scope` ) `→` `THIS`

`this.`listenWithScope`<T, EVENTOBJ, THIS>`( `src`, `type`, `fn`, `options`, `scope` ) `→` `THIS`

`this.`listenWithWrapper`<THIS>`( `src`, `wrapper`, `listener`, `opt_capt` ) `→` `THIS`

`this.`listenWithWrapperAndScope`<T, THIS>`( `src`, `wrapper`, `listener`, `capture`, `scope` ) `→` `THIS`

`this.`registerDisposable( `disposable` ) `→` `void`

`this.`removeAll() `→` `void`

`this.`unlisten`<EVENTOBJ, THIS>`( `src`, `type`, `opt_fn`, `opt_options`, `opt_scope` ) `→` `THIS`

`this.`unlistenWithWrapper`<THIS>`( `src`, `wrapper`, `listener`, `opt_capt`, `opt_scope` ) `→` `THIS`

`this.`creationStack `→` `(string|undefined)`

`this.`handler_ `→` `(SCOPE|undefined)`