Class dijon.EventDispatcher
dijon.EventDispatcher
Defined in: dijon.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
addListener(eventType, listener, oneShot, passEvent)
adds a handler to be invoked when an event is dispatched
|
|
addScopedListener(eventType, listener, scope, oneShot, passEvent)
adds a handler to be invoked in a specific
scope when an event of eventType is dispatched |
|
dispatchEvent(event)
dispatches an event with any number of arguments
|
|
hasListener(eventType, listener)
Checks whether the dispatcher object has registered
listener for eventType |
|
hasScopedListener(eventType, listener, scope)
Checks whether the dispatcher object has registered
listener in scope for eventType |
|
length()
Returns the number of listeners
|
|
removes all event listeners
|
|
removeListener(eventType, listener)
Removes a
listener registered for eventType |
|
removeScopedListener(eventType, listener, scope)
Removes a
listener in scope registered for eventType |
Method Detail
{dijon.EventDispatcher}
addListener(eventType, listener, oneShot, passEvent)
adds a handler to be invoked when an event is dispatched
- Parameters:
- {String} eventType
- The name of the event to be listened to
- {Function} listener
- The handler to be called when the event has been dispatched
- {Boolean} oneShot Optional, Default: false
- Whether the listener must be called only once
- {Boolean} passEvent Optional, Default: false
- Whether the event object needs to be passed to the listener
- Returns:
- {dijon.EventDispatcher} The EventDispatcher instance
{dijon.EventDispatcher}
addScopedListener(eventType, listener, scope, oneShot, passEvent)
adds a handler to be invoked in a specific
scope
when an event of eventType
is dispatched
- Parameters:
- {String} eventType
- The name of the event to be listened to
- {Function} listener
- The handler to be called when the event has been dispatched
- {Object} scope
- The scope in which the listener will be called
- {Boolean} oneShot Optional, Default: false
- Whether the listener must be called only once
- {Boolean} passEvent Optional, Default: false
- Whether the event object needs to be passed to the listener
- Returns:
- {dijon.EventDispatcher} The EventDispatcher instance
{dijon.EventDispatcher}
dispatchEvent(event)
dispatches an event with any number of arguments
- Parameters:
- {Object|String} event
- The event object or event type
- {String} event.type
- if
event
is of typeObject
it requires atype
property set to the name of the event that will be listened to. - {...} ... Optional, Default: undefined
- Any number of parameters
- Returns:
- {dijon.EventDispatcher} The EventDispatcher instance
{Boolean}
hasListener(eventType, listener)
Checks whether the dispatcher object has registered
listener
for eventType
- Parameters:
- {String} eventType
- The name of the event to be listened to
- {Function} listener
- The handler to be called when the event has been dispatched
- Returns:
- {Boolean}
{Boolean}
hasScopedListener(eventType, listener, scope)
Checks whether the dispatcher object has registered
listener
in scope
for eventType
- Parameters:
- {String} eventType
- The name of the event to be listened to
- {Function} listener
- The handler to be called when the event has been dispatched
- {Object} scope
- The scope in which the listener will be called
- Returns:
- {Boolean}
{Number}
length()
Returns the number of listeners
- Returns:
- {Number} The number of listeners
{dijon.EventDispatcher}
removeAllListeners()
removes all event listeners
- Returns:
- {dijon.EventDispatcher} The EventDispatcher instance
{dijon.EventDispatcher}
removeListener(eventType, listener)
Removes a
listener
registered for eventType
- Parameters:
- {String} eventType
- The name of the event to be listened to
- {Function} listener
- The handler to be called when the event has been dispatched
- Returns:
- {dijon.EventDispatcher} The EventDispatcher instance
{dijon.EventDispatcher}
removeScopedListener(eventType, listener, scope)
Removes a
listener
in scope
registered for eventType
- Parameters:
- {String} eventType
- The name of the event to be listened to
- {Function} listener
- The handler to be called when the event has been dispatched
- {Object} scope
- The scope in which the listener will be called
- Returns:
- {dijon.EventDispatcher} The EventDispatcher instance