API Docs for: 0.2.0
Show:

Q.Evented Class

Extends Q.Class
Defined in: lib/quintus.js:782
Module: Quintus

The Q.Evented class adds event handling onto the base Q.Class class. Q.Evented objects can trigger events and other objects can bind to those events.

Item Index

Methods

debind

()

Defined in lib/quintus.js:907

debind is called to remove any listeners an object had on other objects. The most common case is when an object is destroyed you'll want all the event listeners to be removed for you.

extend

(
  • className
  • properties
  • [classMethods]
)

Inherited from Q.Class: lib/quintus.js:693

Create a new Class that inherits from this class

Parameters:

  • className String
  • properties Object
    • hash of properties (init will be the constructor)
  • [classMethods] Object optional
    • optional class methods to add to the class

isA

(
  • className
)

Inherited from Q.Class: lib/quintus.js:683

See if a object is a specific class

Parameters:

  • className String
    • class to check against

off

(
  • event
  • [target]
  • [callback]
)

Defined in lib/quintus.js:870

Unbinds an event. Can be called with 1, 2, or 3 parameters, each of which unbinds a more specific listener.

Parameters:

  • event String
    • name of event
  • [target] Object optional
    • optionally limit to a specific target
  • [callback] Function optional
    • optionally limit to one specific callback

on

(
  • event
  • [target]
  • [callback]
)

Defined in lib/quintus.js:793

Binds a callback to an event on this object. If you provide a target object, that object will add this event to it's list of binds, allowing it to automatically remove it when it is destroyed.

Parameters:

  • event String
    • name or comma separated list of events
  • [target] Object optional
    • optional context for callback, defaults to the Evented
  • [callback] Function optional
    • callback (optional - defaults to name of event on context

trigger

(
  • event
  • [data]
)

Defined in lib/quintus.js:848

Triggers an event, passing in some optional additional data about the event.

Parameters:

  • event String
    • name of event
  • [data] Object optional
    • optional data to pass to the callback