Class jabberwerx.GlobalEventDispatcher (MINIMAL)
Extends
jabberwerx.EventDispatcher.
The type for the global event dispatcher, jabberwerx.globalEvents.
Constructor Attributes | Constructor Name and Description |
---|---|
Creates a new GlobalEventsDispatcher
|
- Fields borrowed from class jabberwerx.EventDispatcher:
- source
Method Attributes | Method Name and Description |
---|---|
bind(name, cb)
Registers a callback for the given event name.
|
|
bindWhen(name, selector, cb)
Registers a callback for the given event name.
|
|
Marks this type for general graph saving.
|
|
Prevents this type from inline serialization.
|
|
unbind(name, cb)
Unregisters a callback for the given event name.
|
|
Called after the object is deserialized and rehydrated.
|
|
Called just prior to the object being serialized.
|
Class Detail
jabberwerx.GlobalEventDispatcher()
Creates a new GlobalEventsDispatcher
- Throws:
- {Error}
- if called after {jabberwerx.globalEvents} is already defined.
Method Detail
bind(name, cb)
Registers a callback for the given event name. This method behaves
just as jabberwerx.EventNotifier#bind. This function also
ensures that a notifier exists for {name}.
- Parameters:
- {String} name
- The event name to register on
- {Function} cb
- The callback to register or update
bindWhen(name, selector, cb)
Registers a callback for the given event name. This method behaves
just as jabberwerx.EventNotifier#bindWhen. This function
also ensures that a notifier exists for {name}.
- Parameters:
- {String} name
- The event name to register on
- {String|Function|undefined} selector
- The selector, as either a jQuery selector string or a function
- {Function} cb
- The callback to register or update
{Boolean}
shouldBeSavedWithGraph()
Marks this type for general graph saving.
- Returns:
- {Boolean} always true
{Boolean}
shouldBeSerializedInline()
Prevents this type from inline serialization.
- Returns:
- {Boolean} always false
unbind(name, cb)
Unregisters a callback for the given event name. This method behaves
just as jabberwerx.EventNotifier#unbind.
- Parameters:
- {String} name
- The event name to unregister on
- {Function} cb
- The callback to unregister
wasUnserialized()
Called after the object is deserialized and rehydrated. This method
"remembers" the source as the global "jabberwerx" namespace.
willBeSerialized()
Called just prior to the object being serialized. This method
"forgets" the source, to prevent the global "jabberwerx" namespace
from being serialized.