goog.events.ListenerMap

Provided By	`goog.events.ListenerMap`

Creates a new listener map.

new ListenerMap( `src` )

Parameters

`src`	`(EventTarget\|goog.events.Listenable\|null)`
	The src object.

VIEW SOURCE

Instance Methods

Adds an event listener. 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 a one-off listener will not change an existing listener, if any. On the other hand a normal listener will change existing one-off listener to become a normal listener.

Parameters

`type`	`(string\|goog.events.EventId)`
	The listener event type.
`listener`	`Function`
	This listener callback method.
`callOnce`	`boolean`
	Whether the listener is a one-off listener.
`opt_useCapture`	`boolean=`
	The capture mode of the listener.
`opt_listenerScope`	`(Object\|null)=`
	Object in whose scope to call the listener.

Returns

goog.events.ListenableKey

Unique key for the listener.

VIEW SOURCE

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

Parameters

`type`	`(string\|goog.events.EventId)`
	The type of the listener to retrieve.
`listener`	`Function`
	The listener function to get.
`capture`	`boolean`
	Whether the listener is a capturing listener.
`opt_listenerScope`	`(Object\|null)=`
	Object in whose scope to call the listener.

Returns

(goog.events.ListenableKey|null)

the found listener or null if not found.

VIEW SOURCE

Parameters

None.

Returns

number

Total number of registered listeners.

VIEW SOURCE

Gets all listeners that match the given type and capture mode. The returned array is a copy (but the listener objects are not).

Parameters

`type`	`(string\|goog.events.EventId)`
	The type of the listeners to retrieve.
`capture`	`boolean`
	The capture mode of the listeners to retrieve.

Returns

Array<goog.events.ListenableKey>

An array of matching listeners.

VIEW SOURCE

Parameters

None.

Returns

number

The count of event types in this map that actually have registered listeners.

VIEW SOURCE

Whether there is a matching listener. If either the type or capture parameters are unspecified, the function will match on the remaining criteria.

Parameters

`opt_type`	`(string\|goog.events.EventId)=`
	The type of the listener.
`opt_capture`	`boolean=`
	The capture mode of the listener.

Returns

boolean

Whether there is an active listener matching the requested type and/or capture phase.

VIEW SOURCE

Removes a matching listener.

Parameters

`type`	`(string\|goog.events.EventId)`
	The listener event type.
`listener`	`Function`
	This listener callback method.
`opt_useCapture`	`boolean=`
	The capture mode of the listener.
`opt_listenerScope`	`(Object\|null)=`
	Object in whose scope to call the listener.

Returns

boolean

Whether any listener was removed.

VIEW SOURCE

Removes all listeners from this map. If opt_type is provided, only listeners that match the given type are removed.

Parameters

`opt_type`	`(string\|goog.events.EventId)=`
	Type of event to remove.

Returns

number

Number of listeners removed.

VIEW SOURCE

Removes the given listener object.

Parameters

`listener`	`goog.events.ListenableKey`
	The listener to remove.

Returns

boolean

Whether the listener is removed.

VIEW SOURCE

Instance Properties

Maps of event type to an array of listeners.

VIEW SOURCE

No information.

VIEW SOURCE

goog.events.ListenerMap

new ListenerMap( `src` )

Instance Methods

`this.`add( `type`, `listener`, `callOnce`, `opt_useCapture`, `opt_listenerScope` ) `→` `goog.events.ListenableKey`

`this.`getListener( `type`, `listener`, `capture`, `opt_listenerScope` ) `→` `(goog.events.ListenableKey|null)`

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

`this.`getListeners( `type`, `capture` ) `→` `Array<goog.events.ListenableKey>`

`this.`getTypeCount() `→` `number`

`this.`hasListener( `opt_type`, `opt_capture` ) `→` `boolean`

`this.`remove( `type`, `listener`, `opt_useCapture`, `opt_listenerScope` ) `→` `boolean`

`this.`removeAll( `opt_type` ) `→` `number`

`this.`removeByKey( `listener` ) `→` `boolean`

Instance Properties

`this.`listeners `→` `Object<string, Array<goog.events.Listener>>`

`this.`src `→` `(EventTarget|goog.events.Listenable|null)`

goog.events.ListenerMap

new ListenerMap( src )

Instance Methods

this.add( type, listener, callOnce, opt_useCapture, opt_listenerScope ) → goog.events.ListenableKey

this.getListener( type, listener, capture, opt_listenerScope ) → (goog.events.ListenableKey|null)

this.getListenerCount() → number

this.getListeners( type, capture ) → Array<goog.events.ListenableKey>

this.getTypeCount() → number

this.hasListener( opt_type, opt_capture ) → boolean

this.remove( type, listener, opt_useCapture, opt_listenerScope ) → boolean

this.removeAll( opt_type ) → number

this.removeByKey( listener ) → boolean

Instance Properties

this.listeners → Object<string, Array<goog.events.Listener>>

this.src → (EventTarget|goog.events.Listenable|null)

new ListenerMap( `src` )

`this.`add( `type`, `listener`, `callOnce`, `opt_useCapture`, `opt_listenerScope` ) `→` `goog.events.ListenableKey`

`this.`getListener( `type`, `listener`, `capture`, `opt_listenerScope` ) `→` `(goog.events.ListenableKey|null)`

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

`this.`getListeners( `type`, `capture` ) `→` `Array<goog.events.ListenableKey>`

`this.`getTypeCount() `→` `number`

`this.`hasListener( `opt_type`, `opt_capture` ) `→` `boolean`

`this.`remove( `type`, `listener`, `opt_useCapture`, `opt_listenerScope` ) `→` `boolean`

`this.`removeAll( `opt_type` ) `→` `number`

`this.`removeByKey( `listener` ) `→` `boolean`

`this.`listeners `→` `Object<string, Array<goog.events.Listener>>`

`this.`src `→` `(EventTarget|goog.events.Listenable|null)`