goog.events

Provided By	`goog.events`

No description available.

VIEW SOURCE

Functions

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object.

If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

Parameters

`src`	`(goog.events.Listenable\|null)`
	The event target.
`e`	`(string\|Object\|null)`
	Event object.

Returns

boolean

If anyone called preventDefault on the event object (or if any of the handlers returns false) this will also return false. If there are no handlers, or if all handlers return true, this returns true.

VIEW SOURCE

Provides a nice string showing the normalized event objects public members

Parameters

`e`	`(Object\|null)`
	Event Object.

Returns

string

String of the public members of the normalized event object.

VIEW SOURCE

Fires a listener with a set of arguments

Parameters

`listener`	`(goog.events.Listener\|null)`
	The listener object to call.
`eventObject`	`(Object\|null)`
	The event object to pass to the listener.

Returns

*

Result of listener.

VIEW SOURCE

Fires an object's listeners of a particular type and phase

Parameters

`obj`	`(Object\|null)`
	Object whose listeners to call.
`type`	`(string\|goog.events.EventId)`
	Event type.
`capture`	`boolean`
	Which event phase.
`eventObject`	`(Object\|null)`
	Event object to be passed to listener.

Returns

boolean

True if all listeners returned true else false.

VIEW SOURCE

Gets the goog.events.Listener for the event or null if no such listener is in use.

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	The target from which to get listeners.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|null)`
	The type of the event.
`listener`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null)`
	The listener function to get.
`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\|null)=`
	Element in whose scope to call the listener.

Returns

(goog.events.ListenableKey|null)

the found listener or null if not found.

VIEW SOURCE

Gets the listeners for a given object, type and capture phase.

Parameters

`obj`	`(Object\|null)`
	Object to get listeners for.
`type`	`(string\|goog.events.EventId)`
	Event type.
`capture`	`boolean`
	Capture phase?.

Returns

Array<goog.events.Listener>

Array of listener objects.

VIEW SOURCE

Helper function for returning a proxy function.

Parameters

None.

Returns

Function

A new or reused function object.

VIEW SOURCE

Gets the total number of listeners currently in the system.

Deprecated	This returns estimated count, now that Closure no longer stores a central listener registry. We still return an estimation to keep existing listener-related tests passing. In the near future, this function will be removed.

Parameters

None.

Returns

number

Number of listeners.

VIEW SOURCE

Creates a unique event id.

Parameters

`identifier`	`string`
	The identifier.

Returns

string

A unique identifier.

VIEW SOURCE

Returns whether an event target has any active listeners matching the specified signature. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Parameters

`obj`	`(EventTarget\|goog.events.Listenable\|null)`
	Target to get listeners for.
`opt_type`	`(string\|goog.events.EventId)=`
	Event type.
`opt_capture`	`boolean=`
	Whether to check for capture or bubble-phase listeners.

Returns

boolean

Whether an event target has one or more listeners matching the requested type and/or capture phase.

VIEW SOURCE

Adds an event listener for a specific event on a native event target (such as a DOM element) or an object that has implemented goog.events.Listenable. A listener can only be added once to an object and if it is added again the key for the listener is returned. Note that if the existing listener is a one-off listener (registered via listenOnce), it will no longer be a one-off listener after a call to listen().

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	The node to listen to events on.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type or array of event types.
`listener`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null)`
	Callback method, or an object with a handleEvent function. WARNING: passing an Object is now softly deprecated.
`opt_options`	`(boolean\|AddEventListenerOptions)=`

`opt_handler`	`(T\|null)=`
	Element in whose scope to call the listener.

Returns

(number|goog.events.ListenableKey|null)

Unique key for the listener.

VIEW SOURCE

Adds an event listener for a specific event on a native event target (such as a DOM element) or an object that has implemented goog.events.Listenable. After the event has fired the event listener is removed from the target.

If an existing listener already exists, listenOnce will do nothing. In particular, if the listener was previously registered via listen(), listenOnce() will not turn the listener into a one-off listener. Similarly, if there is already an existing one-off listener, listenOnce does not modify the listeners (it is still a once listener).

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	The node to listen to events on.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type or array of event types.
`listener`	`(function((EVENTOBJ\|null)): ?\|{handleEvent: function(?): ?}\|null)`
	Callback method.
`opt_options`	`(boolean\|AddEventListenerOptions)=`

`opt_handler`	`(T\|null)=`
	Element in whose scope to call the listener.

Returns

(number|goog.events.ListenableKey|null)

Unique key for the listener.

VIEW SOURCE

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

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	The target 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).
`opt_handler`	`(T\|null)=`
	Element in whose scope to call the listener.

VIEW SOURCE

Installs exception protection for the browser event entry point using the given error handler.

Parameters

`errorHandler`	`(goog.debug.ErrorHandler\|null)`
	Error handler with which to protect the entry point.

VIEW SOURCE

Removes all listeners from an object. You can also optionally remove listeners of a particular type.

Parameters

`obj`	`(Object\|null\|undefined)`
	Object to remove listeners from. Must be an EventTarget or a goog.events.Listenable.
`opt_type`	`(string\|goog.events.EventId)=`
	Type of event to remove. Default is all types.

Returns

number

Number of listeners removed.

VIEW SOURCE

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

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	The target to stop listening to events on.
`type`	`(string\|goog.events.EventId<(EVENTOBJ\|null)>\|Array<?>\|null)`
	Event type or array of event types to unlisten to.
`listener`	`(function(?): ?\|{handleEvent: function(?): ?}\|null)`
	The listener function to remove.
`opt_options`	`(boolean\|EventListenerOptions)=`
	whether the listener is fired during the capture or bubble phase of the event.
`opt_handler`	`(Object\|null)=`
	Element in whose scope to call the listener.

Returns

(boolean|null)

indicating whether the listener was there to remove.

VIEW SOURCE

Removes an event listener which was added with listen() by the key returned by listen().

Parameters

`key`	`(number\|goog.events.ListenableKey\|null)`
	The key returned by listen() for this event listener.

Returns

boolean

indicating whether the listener was there to remove.

VIEW SOURCE

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

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|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_handler`	`(Object\|null)=`
	Element in whose scope to call the listener.

VIEW SOURCE

Parameters

`listener`	`(Object\|null)`
	The listener function or an object that contains handleEvent method.

Returns

Function

Either the original function or a function that calls obj.handleEvent. If the same listener is passed to this function more than once, the same function is guaranteed to be returned.

VIEW SOURCE

Properties

A typedef for event like objects that are dispatchable via the goog.events.dispatchEvent function. strings are treated as the type for a goog.events.Event. Objects are treated as an extension of a new goog.events.Event with the type property of the object being used as the type of the Event.

VIEW SOURCE

No information.

VIEW SOURCE

No information.

VIEW SOURCE

Mapping of mouse event names to underlying browser event names.

VIEW SOURCE

Compiler Constants

The capture simulation mode for IE8-. By default, this is ON.

VIEW SOURCE

goog.events

Functions

dispatchEvent( `src`, `e` ) `→` `boolean`

expose( `e` ) `→` `string`

fireListener( `listener`, `eventObject` ) `→` `*`

fireListeners( `obj`, `type`, `capture`, `eventObject` ) `→` `boolean`

getListener`<EVENTOBJ>`( `src`, `type`, `listener`, `opt_capt`, `opt_handler` ) `→` `(goog.events.ListenableKey|null)`

getListeners( `obj`, `type`, `capture` ) `→` `Array<goog.events.Listener>`

getProxy() `→` `Function`

getTotalListenerCount() `→` `number`

getUniqueId( `identifier` ) `→` `string`

hasListener( `obj`, `opt_type`, `opt_capture` ) `→` `boolean`

listen`<T, EVENTOBJ>`( `src`, `type`, `listener`, `opt_options`, `opt_handler` ) `→` `(number|goog.events.ListenableKey|null)`

listenOnce`<T, EVENTOBJ>`( `src`, `type`, `listener`, `opt_options`, `opt_handler` ) `→` `(number|goog.events.ListenableKey|null)`

listenWithWrapper`<T>`( `src`, `wrapper`, `listener`, `opt_capt`, `opt_handler` ) `→` `void`

protectBrowserEventEntryPoint( `errorHandler` ) `→` `void`

removeAll( `obj`, `opt_type` ) `→` `number`

unlisten`<EVENTOBJ>`( `src`, `type`, `listener`, `opt_options`, `opt_handler` ) `→` `(boolean|null)`

unlistenByKey( `key` ) `→` `boolean`

unlistenWithWrapper( `src`, `wrapper`, `listener`, `opt_capt`, `opt_handler` ) `→` `void`

wrapListener( `listener` ) `→` `Function`

Properties

EventLike `→` `(string|Object|null)`

Key `→` `(number|goog.events.ListenableKey|null)`

ListenableType `→` `(EventTarget|goog.events.Listenable|null)`

MouseEvents `→` `{MOUSECANCEL: string, MOUSEDOWN: string, MOUSEENTER: string, MOUSELEAVE: string, MOUSEMOVE: string, MOUSEOUT: string, MOUSEOVER: string, MOUSEUP: string}`

Compiler Constants

goog.events.CAPTURE_SIMULATION_MODE `→` `number`

Interfaces

Classes

Enumerations

goog.events

Functions

dispatchEvent( src, e ) → boolean

expose( e ) → string

fireListener( listener, eventObject ) → *

fireListeners( obj, type, capture, eventObject ) → boolean

getListener<EVENTOBJ>( src, type, listener, opt_capt, opt_handler ) → (goog.events.ListenableKey|null)

getListeners( obj, type, capture ) → Array<goog.events.Listener>

getProxy() → Function

getTotalListenerCount() → number

getUniqueId( identifier ) → string

hasListener( obj, opt_type, opt_capture ) → boolean

listen<T, EVENTOBJ>( src, type, listener, opt_options, opt_handler ) → (number|goog.events.ListenableKey|null)

listenOnce<T, EVENTOBJ>( src, type, listener, opt_options, opt_handler ) → (number|goog.events.ListenableKey|null)

listenWithWrapper<T>( src, wrapper, listener, opt_capt, opt_handler ) → void

protectBrowserEventEntryPoint( errorHandler ) → void

removeAll( obj, opt_type ) → number

unlisten<EVENTOBJ>( src, type, listener, opt_options, opt_handler ) → (boolean|null)

unlistenByKey( key ) → boolean

unlistenWithWrapper( src, wrapper, listener, opt_capt, opt_handler ) → void

wrapListener( listener ) → Function

Properties

EventLike → (string|Object|null)

Key → (number|goog.events.ListenableKey|null)

ListenableType → (EventTarget|goog.events.Listenable|null)

MouseEvents → {MOUSECANCEL: string, MOUSEDOWN: string, MOUSEENTER: string, MOUSELEAVE: string, MOUSEMOVE: string, MOUSEOUT: string, MOUSEOVER: string, MOUSEUP: string}

Compiler Constants

goog.events.CAPTURE_SIMULATION_MODE → number

Interfaces

Classes

Enumerations

dispatchEvent( `src`, `e` ) `→` `boolean`

expose( `e` ) `→` `string`

fireListener( `listener`, `eventObject` ) `→` `*`

fireListeners( `obj`, `type`, `capture`, `eventObject` ) `→` `boolean`

getListener`<EVENTOBJ>`( `src`, `type`, `listener`, `opt_capt`, `opt_handler` ) `→` `(goog.events.ListenableKey|null)`

getListeners( `obj`, `type`, `capture` ) `→` `Array<goog.events.Listener>`

getProxy() `→` `Function`

getTotalListenerCount() `→` `number`

getUniqueId( `identifier` ) `→` `string`

hasListener( `obj`, `opt_type`, `opt_capture` ) `→` `boolean`

listen`<T, EVENTOBJ>`( `src`, `type`, `listener`, `opt_options`, `opt_handler` ) `→` `(number|goog.events.ListenableKey|null)`

listenOnce`<T, EVENTOBJ>`( `src`, `type`, `listener`, `opt_options`, `opt_handler` ) `→` `(number|goog.events.ListenableKey|null)`

listenWithWrapper`<T>`( `src`, `wrapper`, `listener`, `opt_capt`, `opt_handler` ) `→` `void`

protectBrowserEventEntryPoint( `errorHandler` ) `→` `void`

removeAll( `obj`, `opt_type` ) `→` `number`

unlisten`<EVENTOBJ>`( `src`, `type`, `listener`, `opt_options`, `opt_handler` ) `→` `(boolean|null)`

unlistenByKey( `key` ) `→` `boolean`

unlistenWithWrapper( `src`, `wrapper`, `listener`, `opt_capt`, `opt_handler` ) `→` `void`

wrapListener( `listener` ) `→` `Function`

EventLike `→` `(string|Object|null)`

Key `→` `(number|goog.events.ListenableKey|null)`

ListenableType `→` `(EventTarget|goog.events.Listenable|null)`

MouseEvents `→` `{MOUSECANCEL: string, MOUSEDOWN: string, MOUSEENTER: string, MOUSELEAVE: string, MOUSEMOVE: string, MOUSEOUT: string, MOUSEOVER: string, MOUSEUP: string}`

goog.events.CAPTURE_SIMULATION_MODE `→` `number`