Chico UI

ch.Menu (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

Menu is a UI-Component.

Summary

Visibility Name Description
<public>  
element
The element reference.
<static>  
ch.Menu.onSelect
Callback function
<private>  
selected
Indicates witch child is opened
<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.Controllers: children

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

Visibility Name Description
<private>  
configureAccordion()
Binds controller's own click to expando triggers
<private>  
createLayout()
Inits an Expando component on each list inside main HTML code snippet
<private>  
select()
Opens specific Expando child and optionally grandson

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).

Classdetail

Parameters

  • conf: Object, Optional. Object with configuration properties.
  • conf.selected: Number, Optional. Selects a child that will be open when component was loaded.
  • conf.fx: Boolean, Optional. Enable or disable UI effects. By default, the effects are disable.

Returns

  • itself

Requires

Examples

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

Properties detail

element (public, HTMLElement)

The element reference.

onSelect (static)

Callback function

selected (private, number)

Indicates witch child is opened

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

configureAccordion (private)

Binds controller's own click to expando triggers

createLayout (private)

Inits an Expando component on each list inside main HTML code snippet

select (private)

Opens specific Expando child and optionally grandson

Events detail

ready (public)

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

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