Class: EventDispatcher

conbo.EventDispatcher(options)

new EventDispatcher(options)

Event Dispatcher Event model designed to bring events into line with DOM events and those found in HTML DOM, jQuery and ActionScript 2 & 3, offering a more predictable, object based approach to event dispatching and handling Should be used as the base class for any class that won't be used for data binding
Parameters:
Name Type Description
options Object Object containing optional initialisation options, including 'context'
Author:
  • Neil Rackett
Source:

Extends

Members

supro

Similar to `super` in ActionScript or Java, this property enables you to access properties and methods of the super class prototype, which is the case of JavaScript is the next prototype up the chain
Inherited From:
Source:

Methods

addEventListener(type, handler, scopeopt, priorityopt, onceopt) → {conbo.EventDispatcher}

Add a listener for a particular event type
Parameters:
Name Type Attributes Default Description
type string Type of event ('change') or events ('change blur')
handler function Function that should be called
scope Object <optional>
 Options object (recommended) or the scope in which to run the event handler (deprecated)
priority number <optional>
 0 The event handler's priority when the event is dispatached (deprecated)
once boolean <optional>
 false Should the event listener automatically be removed after it has been called once? (deprecated)
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

bindAll(…methodNameopt) → {this}

Scope all methods of this class instance to this class instance
Parameters:
Name Type Attributes Description
methodName string <optional>
<repeatable>
 Specific method names to bind (all will be bound if none specified)
Inherited From:
Source:
Returns:
Type
this

declarations() → {void}

Declarations is used to declare instance properties used by this class
Parameters:
Type Attributes Description
* <repeatable>
Inherited From:
Source:
Returns:
Type
void

destroy() → {void}

Clean everything up ready for garbage collection (you should override in your own classes)
Inherited From:
Source:
Returns:
Type
void

dispatchChange(propName) → {conbo.EventDispatcher}

Dispatch a change event for one or more changed properties
Parameters:
Name Type Description
propName string The name of the property that has changed
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

dispatchEvent(event) → {conbo.EventDispatcher}

Dispatch the event to listeners
Parameters:
Name Type Description
event conbo.Event The event to dispatch
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

hasEventListener(type, handleropt, scopeopt) → {boolean}

Does this object have an event listener of the specified type?
Parameters:
Name Type Attributes Description
type string Type of event (e.g. 'change')
handler function <optional>
 Function that should be called
scope Object <optional>
 Options object (recommended) or the scope in which to run the event handler (deprecated)
Source:
Returns:
True if this object has the specified event listener, false if it does not
Type
boolean

initialize() → {void}

Initialize (entry point) is called immediately after the constructor has completed
Parameters:
Type Attributes Description
* <repeatable>
Inherited From:
Source:
Returns:
Type
void

preinitialize() → {void}

Preinitialize is called before any code in the constructor has been run
Parameters:
Type Attributes Description
* <repeatable>
Inherited From:
Source:
Returns:
Type
void

removeEventListener(typeopt, handleropt, scopeopt) → {conbo.EventDispatcher}

Remove a listener for a particular event type
Parameters:
Name Type Attributes Description
type string <optional>
 Type of event ('change') or events ('change blur'), if not specified, all listeners will be removed
handler function <optional>
 Function that should be called, if not specified, all listeners of the specified type will be removed
scope Object <optional>
 Options object (recommended) or the scope in which to run the event handler (deprecated)
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

toString() → {string}

String representation of the current class
Overrides:
Source:
Returns:
Type
string