Chico UI

ch.TabNavigator (Class)

Documentation updated on Fri May 18 2012 12:47:10 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

TabNavigator UI-Component for static and dinamic content.

Summary

Visibility Name Description
<protected>  
$content
The component's content.
<protected>  
$triggers
The component's triggers container.
<public>  
children
Children instances associated to this controller.
<public> <static>  
ch.TabNavigator.contentCallback
This callback is triggered when async request fails.
<public>  
element
The element reference.
<private>  
hash
The actual location hash, is used to know if there's a specific tab selected.
<private>  
hashed
A boolean property to know if the some tag should be selected.
<private>  
selected
Get wich tab is selected.
<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.Uiobject: DOMParent,originalContent,position,staticContent

Visibility Name Description
<private>  
createTabs()
Create controller's children.
<public>  
getSelected()
Deprecated - Returns the selected child's index.
<private>  
select()
Select a child to show its content.

Methods borrowed from class ch.Uiobject: content, prevent

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

Visibility Name Description
<public>  
onContentError
Callback function
<public>  
onContentLoad
Callback function
<public>  
onSelect
Callback function
<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. By default, the value is 1.

Returns

  • itself

Examples

// Create a new Tab Navigator with configuration.
var me = $(".example").tabNavigator({
    "selected": 2
});
// Create a new Tab Navigator without configuration.
var me = $(".example").tabNavigator();

Properties detail

$content (protected, jQuery)

The component's content.

$triggers (protected, jQuery)

The component's triggers container.

children (public, collection)

Children instances associated to this controller.

contentCallback (publicstatic, Chico-UI Object)

This callback is triggered when async request fails.

Returns
  • (Chico-UI Object)

element (public, HTMLElement)

The element reference.

hash (private, string)

The actual location hash, is used to know if there's a specific tab selected.

hashed (private, boolean)

A boolean property to know if the some tag should be selected.

selected (private, number)

Get wich tab is selected.

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

createTabs (private)

Create controller's children.

getSelected (public, number)

Deprecated - Returns the selected child's index.

Returns
  • selected Tab's index. (number)

select (private)

Select a child to show its content.

Events detail

onContentError (public)

Callback function

onContentLoad (public)

Callback function

onSelect (public)

Callback function

ready (public)

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

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