ch.Object (Class)

Documentation updated on Fri Mar 09 2012 15:11:03 GMT-0300 (GMT-03:00), generated by JsDoc Toolkit 2.4.0

Contents
1 Overview
2 Summary
3 Classdetail
4 Properties detail
5 Methods detail

Overview

Object represent the abstract class of all Objects.

Summary

Visibility Name Description
<private>  
that
Reference to a internal component instance, saves all the information and configuration properties.
Visibility Name Description
<protected>  
callbacks()
This method will be deprecated soon.
<public>  
off(event, handler)
Removes a callback function from specific event.
<public>  
on(event, handler)
Add a callback function from specific event.
<public>  
once(event, handler)
Add a callback function from specific event that it will execute once.
<protected>  
trigger(event)
Triggers a specific event within the component public context.

Classdetail

See

Properties detail

that (private, object)

Reference to a internal component instance, saves all the information and configuration properties.

Methods detail

callbacks (protected)

This method will be deprecated soon. Triggers a specific callback inside component's context.

off (public)

Removes a callback function from specific event.

Examples
// Will remove event handler to the "ready" event
var startDoingStuff = function () {
    // Some code here!
};

me.off("ready", startDoingStuff);
Parameters
  • event (Since : string. Event name.
  • handler (Since : function. Handler function.
Returns
  • itself

on (public)

Add a callback function from specific event.

Examples
// Will add a event handler to the "ready" event
me.on("ready", startDoingStuff);
Parameters
  • event (Since : string. Event name.
  • handler (Since : function. Handler function.
Returns
  • itself

once (public)

Add a callback function from specific event that it will execute once.

Examples
// Will add a event handler to the "contentLoad" event once
me.once("contentLoad", startDoingStuff);
Parameters
  • event (Since : string. Event name.
  • handler (Since : function. Handler function.
Returns
  • itself

trigger (protected)

Triggers a specific event within the component public context.

Parameters
  • event (Since : string. The event name you want to trigger.