Home

# Library goog.events

Function Summary
| `ActionEventWrapper_()` Event wrapper for action handling. Fires when an element is activated either by clicking it or by focusing it and pressing Enter.
| `cleanUp_(string type, boolean capture, number srcUid, ?Array listenerArray)` Cleans up the listener array as well as the listener tree

`dispatchEvent(?goog.events.EventTarget src, (Object|goog.events.Event|null|string) e) ⇒ boolean`

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.

| `expose(?Object e) ⇒ string` Provides a nice string showing the normalized event objects public members
| `fireListener(?goog.events.Listener listener, ?Object eventObject) ⇒ boolean` Fires a listener with a set of arguments
| `fireListeners(?Object obj, string type, boolean capture, ?Object eventObject) ⇒ boolean` Fires an object's listeners of a particular type and phase
| `fireListeners_(?Object map, ?Object obj, string type, boolean capture, ?Object eventObject) ⇒ boolean` Fires an object's listeners of a particular type and phase.
| `getListener((EventTarget|goog.events.EventTarget|null) src, ?string type, ?Object listener, boolean= opt_capt, ?Object= opt_handler) ⇒ ?goog.events.Listener` Gets the goog.events.Listener for the event or null if no such listener is in use.
| `getListeners(?Object obj, string type, boolean capture) ⇒ ?Array` Gets the listeners for a given object, type and capture phase.
| `getListeners_(?Object obj, ?string type, boolean capture) ⇒ ?Array` Gets the listeners for a given object, type and capture phase.
| `getOnString_(string type) ⇒ string` Returns a string wth on prepended to the specified type. This is used for IE which expects "on" to be prepended. This function caches the string in order to avoid extra allocations in steady state.
| `getProxy() ⇒ ?Function` Helper function for returning a proxy function.
| `getTotalListenerCount() ⇒ number` Gets the total number of listeners currently in the system.
| `getUniqueId(string identifier) ⇒ string` Creates a unique event id.
| `handleBrowserEvent_(string key, ?Event= opt_evt) ⇒ boolean` Handles an event and dispatches it to the correct listeners. This function is a proxy for the real listener the user specified.
| `hasListener((EventTarget|goog.events.EventTarget|null) obj, string= opt_type, boolean= opt_capture) ⇒ boolean` 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.
| `isMarkedIeEvent_(?Event e) ⇒ boolean` This is used to check if an IE event has already been handled by the Closure system so we do not do the Closure pass twice for a bubbling event.
| `listen((EventTarget|goog.events.EventTarget|null) src, (Array.<string>|null|string) type, ?Object listener, boolean= opt_capt, ?Object= opt_handler) ⇒ ?number` Adds an event listener for a specific event on a DOM Node or an object that has implemented {@link goog.events.EventTarget}. A listener can only be added once to an object and if it is added again the key for the listener is returned.
| `listenOnce((EventTarget|goog.events.EventTarget|null) src, (Array.<string>|null|string) type, ?Object listener, boolean= opt_capt, ?Object= opt_handler) ⇒ ?number` Adds an event listener for a specific event on a DomNode or an object that has implemented {@link goog.events.EventTarget}. After the event has fired the event listener is removed from the target.
| `listenWithWrapper((EventTarget|goog.events.EventTarget|null) src, ?goog.events.EventWrapper wrapper, ?Object listener, boolean= opt_capt, ?Object= 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.
| `markIeEvent_(?Event e)` This is used to mark the IE event object so we do not do the Closure pass twice for a bubbling event.
| `protectBrowserEventEntryPoint(?goog.debug.ErrorHandler errorHandler)` Installs exception protection for the browser event entry point using the given error handler.
| `removeAll(?Object= opt_obj, string= opt_type, boolean= opt_capt) ⇒ number` Removes all listeners from an object, if no object is specified it will remove all listeners that have been registered. You can also optionally remove listeners of a particular type or capture phase.
| `unlisten((EventTarget|goog.events.EventTarget|null) src, (Array.<string>|null|string) type, ?Object listener, boolean= opt_capt, ?Object= opt_handler) ⇒ ?boolean` Removes an event listener which was added with listen().
| `unlistenByKey(?number key) ⇒ boolean` Removes an event listener which was added with listen() by the key returned by listen().
| `unlistenWithWrapper((EventTarget|goog.events.EventTarget|null) src, ?goog.events.EventWrapper wrapper, ?Object listener, boolean= opt_capt, ?Object= opt_handler)` Removes an event listener which was added with listenWithWrapper().