Chico UI

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

Abstract class of all floats UI-Objects.

Summary

Visibility Name Description
<protected>  
$container
Inner function that resolves the component's layout and returns a static reference.
<protected>  
$content
Inner reference to content container.
<protected>  
active
Flag that indicates if the float is active and rendered on the DOM tree.
<protected>  
source
Content configuration property.
<protected>  
that
Reference to a internal component instance, saves all the information and configuration properties.

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

Visibility Name Description
<private>  
closable()
Closable behavior.
<protected>  
contentCallback()
This callback is triggered when async data is loaded into component's content, when ajax content comes back.
<protected>  
contentError()
This callback is triggered when async request fails.
<private>  
createClose()
Creates close button.
<private>  
createCone()
Creates a 'cone', is a visual asset for floats.
<public>  
height()
Sets or gets the height of the Float element.
<public>  
hide()
Triggers the innerHide method and returns the public scope to keep method chaining.
<protected>  
innerHide()
Inner hide method.
<protected>  
innerShow()
Inner show method.
<public>  
isActive()
Returns a Boolean if the component's core behavior is active.
<public>  
show()
Triggers the innerShow method, returns the public scope to keep method chaining and sets new content if receive a parameter.
<protected>  
size(prop, data)
Getter and setter for size attributes on any float component.
<public>  
width()
Sets or gets the width property of the component's layout.

Methods borrowed from class ch.Uiobject: content, prevent

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

Visibility Name Description
<public>  
hide
Triggers when component is not longer visible.
<public>  
ready
Triggers when the component is ready to use.
<public>  
show
Triggers when component is visible.

Classdetail

Returns

  • itself

Requires

See

Properties detail

$container (protected, jQuery)

Inner function that resolves the component's layout and returns a static reference.

$content (protected, jQuery)

Inner reference to content container. Here is where the content will be added.

See
  • ch.Object#content

active (protected, boolean)

Flag that indicates if the float is active and rendered on the DOM tree.

source (protected, string)

Content configuration property.

that (protected, object)

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

Methods detail

closable (private)

Closable behavior.

contentCallback (protected)

This callback is triggered when async data is loaded into component's content, when ajax content comes back.

Returns
  • itself

contentError (protected, this)

This callback is triggered when async request fails.

Returns
  • (this)

createClose (private)

Creates close button.

createCone (private)

Creates a 'cone', is a visual asset for floats.

height (public)

Sets or gets the height of the Float element.

Examples
// to set the height
me.height(300);
// to get the height
me.height // 300
Returns
  • itself
See

hide (public)

Triggers the innerHide method and returns the public scope to keep method chaining.

Returns
  • itself

innerHide (protected)

Inner hide method. Hides the component and detach it from DOM tree.

Returns
  • itself

innerShow (protected)

Inner show method. Attach the component layout to the DOM tree.

Returns
  • itself

isActive (public)

Returns a Boolean if the component's core behavior is active. That means it will return 'true' if the component is on and it will return false otherwise.

Returns
  • boolean

show (public)

Triggers the innerShow method, returns the public scope to keep method chaining and sets new content if receive a parameter.

Returns
  • itself
See
  • ch.Floats#content

size (protected)

Getter and setter for size attributes on any float component.

Parameters
  • prop: String. Property that will be setted or getted, like "width" or "height".
  • data: String, Optional. Only for setter. It's the new value of defined property.
Returns
  • itself

width (public)

Sets or gets the width property of the component's layout. Use it without arguments to get the value. To set a new value pass an argument, could be a Number or CSS value like '300' or '300px'.

Examples
// to set the width
me.width(700);
// to get the width
me.width // 700
Returns
  • itself
See

Events detail

hide (public)

Triggers when component is not longer visible.

ready (public)

Triggers when the component is ready to use.

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

show (public)

Triggers when component is visible.