Class: ConboEvent

conbo.ConboEvent(type, options)

new ConboEvent(type, options)

conbo.Event Default event class for events fired by ConboJS For consistency, callback parameters of Backbone.js derived classes are event object properties in ConboJS
Parameters:
Name Type Description
type string The type of event this object represents
options Object Properties to be added to this event object
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

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

clone() → {conbo.Event}

Create an identical clone of this event
Inherited From:
Source:
Returns:
A clone of this event
Type
conbo.Event

constructor(type)

Constructor: DO NOT override! (Use initialize instead)
Parameters:
Name Type Description
type string The type of event this class instance represents
Inherited From:
Source:

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

initialize(type, optionsopt)

Initialize the ConboEvent class instance
Parameters:
Name Type Attributes Description
type string The type of event this class instance represents
options Object <optional>
Object containing additional properties to add to this class instance
Overrides:
Source:

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

preventDefault() → {conbo.Event}

Prevent whatever the default framework action for this event is
Inherited From:
Source:
Returns:
A reference to this event instance
Type
conbo.Event

stopImmediatePropagation() → {conbo.Event}

Keep the rest of the handlers from being executed
Inherited From:
Source:
Returns:
A reference to this event
Type
conbo.Event

stopPropagation() → {conbo.Event}

Not currently used
Inherited From:
Source:
Returns:
A reference to this event instance
Type
conbo.Event

toString() → {string}

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

Events

ADD

Something was added
Type:
Source:

ALL

Special event used to listed for all event types
Type:
Source:

BIND

Something has been bound
Type:
Source:

CHANGE

Something has changed (also 'change:[name]')
Type:
Properties:
Name Type Description
property string The name of the property that changed
value * The new value of the property
Source:

CREATION_COMPLETE

Something has been created and it's ready to use
Type:
Source:

DETACH

Something has been detached
Type:
Source:

FAULT

A fault has occurred
Type:
Properties:
Name Type Description
fault * The fault received
Source:

INIT_COMPLETE

Something has finished initializing
Type:
Source:

INITIALIZE

Something is initializing
Type:
Source:

PREINITIALIZE

Something is about to initialize
Type:
Source:

REMOVE

Something was removed
Type:
Source:

RESULT

A result has been received
Type:
Properties:
Name Type Description
result * The data received
Source:

ROUTE

The route has changed (also 'route:[name]')
Type:
Properties:
Name Type Description
router conbo.Router The router that handled the route change
route RegExp The route that was followed
name string The name assigned to the route
parameters Array The parameters extracted from the route
path string The new path
Source:

START

Something has started
Type:
Source:

STOP

Something has stopped
Type:
Source:

TEMPLATE_COMPLETE

A template is ready to use
Type:
Source:

TEMPLATE_ERROR

A template error has occurred
Type:
Source:

UNBIND

Something has been unbound
Type:
Source: