Chico UI

ch.Expando (Class)

Documentation updated on Fri May 18 2012 12:47:09 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
6 Events detail

Overview

Expando is a UI-Component.

Summary

Visibility Name Description
<protected>  
$content
The component's trigger.
<protected>  
$trigger
The component's trigger.
<public>  
element
The element reference.
<private>  
that
Reference to a internal component instance, saves all the information and configuration properties.
<public>  
type
The component's type.
<public>  
uid
The component's instance unique identifier.

Fields borrowed from class ch.Navs: active

Fields borrowed from class ch.Uiobject: DOMParent,originalContent,position,staticContent

Visibility Name Description
<public>  
hide()
Hides component's content.
<protected>  
innerHide()
Hides component's content.
<protected>  
innerShow()
Shows component's content.
<public>  
show()
Shows component's content.

Methods borrowed from class ch.Navs: configBehavior, isActive

Methods borrowed from class ch.Uiobject: content, prevent

Methods borrowed from class ch.Object: callbacks, off, on, once, trigger

Visibility Name Description
<public>  
ready
Triggers when the component is ready to use (Since 0.8.0).

Events borrowed from class ch.Navs: hide, onHide, onShow, show

Classdetail

Parameters

  • conf: Object, Optional. Object with configuration properties.
  • conf.open: Boolean, Optional. Shows the expando open when component was loaded. By default, the value is false.
  • conf.fx: Boolean, Optional. Enable or disable UI effects. By default, the effects are disable.

Returns

  • itself

Examples

// Create a new expando with configuration.
var me = $(".example").expando({
    "open": true,
    "fx": true
});
// Create a new expando without configuration.
var me = $(".example").expando();

Properties detail

$content (protected, jQuery)

The component's trigger.

$trigger (protected, jQuery)

The component's trigger.

element (public, HTMLElement)

The element reference.

that (private, object)

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

type (public, string)

The component's type.

uid (public, number)

The component's instance unique identifier.

Methods detail

hide (public)

Hides component's content.

Returns
  • itself

innerHide (protected)

Hides component's content.

Returns
  • itself

innerShow (protected)

Shows component's content.

Returns
  • itself

show (public)

Shows component's content.

Returns
  • itself

Events detail

ready (public)

Triggers when the component is ready to use (Since 0.8.0).

Examples
// Following the first example, using 'me' as expando's instance controller:
me.on("ready",function () {
	this.show();
});