Chico UI

ch.Uiobject (Class)

Documentation updated on Fri May 18 2012 12:47:11 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 UI Objects.

Summary

Visibility Name Description
<public>  
DOMParent
DOM Parent of content, this is useful to attach DOM Content when float is hidding.
<public>  
originalContent
Component original content.
<public>  
position
Sets or gets positioning configuration.
<public>  
staticContent
Component static content.
<private>  
that
Reference to a internal component instance, saves all the information and configuration properties.
Visibility Name Description
<protected>  
content(content)
Set and get the content of a component.
<protected>  
prevent(event)
Prevent propagation and default actions.

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

Classdetail

See

Properties detail

DOMParent (public, HTMLElement)

DOM Parent of content, this is useful to attach DOM Content when float is hidding.

originalContent (public, HTMLElement)

Component original content.

position (public)

Sets or gets positioning configuration. Use it without arguments to get actual configuration. Pass an argument to define a new positioning configuration.

Examples
// Change component's position.
me.position({ 
	  offset: "0 10",
	  points: "lt lb"
});
See

staticContent (public, string)

Component static content.

that (private, object)

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

Methods detail

content (protected, string)

Set and get the content of a component. With no arguments will behave as a getter function. Send any kind of content and will be a setter function. Use a valid URL for AJAX content, use a CSS selector for a DOM content or just send a static content like HTML or Text.

Examples
// Simple static content
$(element).layer().content("Some static content");
// Get DOM content
$(element).layer().content("#hiddenContent");
// Get AJAX content
$(element).layer().content("http://chico.com/content/layer.html");
Parameters
  • content: string, Optional. Could be a simple text, html or a url to get the content with ajax.
Returns
  • content (string)
Requires

prevent (protected)

Prevent propagation and default actions.

Parameters
  • event: event. Recieves a event object