vegui. checkbox. class.js
Constants
VUI_CHECKBOX	VegUI element type for VegUICheckBox
VegUICheckBox	The checkbox widget
Hierarchy	extends VegUINode
Type	VUI_CHECKBOX
Child Elements:	These child elements are all accessable over *this.[child_name] even though they may not all be direct children of this element
Tutorials	http://www.vegui.org- /site- /blog- /13- /vegui-tutorial-08---the-checkbox-widget.html
Properties
Object Properties
Template Properties
Functions
VegUICheckBox	Constructor
build_cb	Builds the checkbox
set_cb	Sets the most common template properties for the checkbox
tgl_check	Toggles checkbox to be checked or unchecked

Constants

VUI_CHECKBOX

VegUI element type for VegUICheckBox

VegUICheckBox

The checkbox widget

Summary

Hierarchy	extends VegUINode
Type	VUI_CHECKBOX
Child Elements:	These child elements are all accessable over *this.[child_name] even though they may not all be direct children of this element
Tutorials	http://www.vegui.org- /site- /blog- /13- /vegui-tutorial-08---the-checkbox-widget.html
Properties
Object Properties
Template Properties
Functions
VegUICheckBox	Constructor
build_cb	Builds the checkbox
set_cb	Sets the most common template properties for the checkbox
tgl_check	Toggles checkbox to be checked or unchecked

Hierarchy

extends VegUINode

Inherits all properties and methods from VegUINode

VegUINode
   |
   |
   +--> VegUICheckBox

Type

VUI_CHECKBOX

Child Elements:

These child elements are all accessable over *this.[child_name] even though they may not all be direct children of this element

BtnCheck	VUI_BUTTON Button that represents the check box
Label	VUI_NODE Node that holds the text that appears besides the buttton

Tutorials

http://www.vegui.org- /site- /blog- /13- /vegui-tutorial-08---the-checkbox-widget.html

Properties

Object Properties

isChecked	bool holds the checked status of the checkbox, true if it is checked, false if it is unchecked
labelTxt	string text of the label
cClass	string Css class to use for BtnCheck when checked
ucClass	string Css class to use for BtnCheck when unchecked

Template Properties

T.labelTxt	labelTxt
T.cClass	cClass
T.ucClass	ucClass
T.checked	bool if ture checkbox will be checked by default

Functions

VegUICheckBox

function VegUICheckBox( refName,
Parent,
Manager )

Constructor

Parameters

string refName	name of the object
<VegUIElement Parent>	parent element of the object
VegUIElement Manager	manager element of the object

build_cb

this.build = this.build_cb = function( toNode )

Builds the checkbox

private function

You should always use the VegUIManager::build_element function to build elements.

Alias

build()

Parameters

if submitted the created HTML node will be appended to toNode

Returns

null	on failure
int	1 on success

set_cb

this.set = this.set_cb = function( x,
y,
w,
h,
label,
checked,
cClass,
ucClass )

Sets the most common template properties for the checkbox

Alias

set()

Parameters

int x	x position (pixels)
int y	y position (pixels)
int w	width (pixels)
int h	height (pixels)
string label	text to be displayed in the label
bool checked	if true the checkbox will be checked by default
string cClass	CSS class to use for BtnCheck when checked
string ucClass	CSS class to use for BtnCheck when unchecked

Example

myCheckBox.set(5,5,150,20,'Enable Something!',false,'cb_checked','ch_unchecked');

tgl_check

this.tgl_check = function( b,
noOnChange )

Toggles checkbox to be checked or unchecked

Parameters

bool b	true = checked , false = unchecked
bool noOnChange	if true will prevent VegUINode::onchange from being called

Example

// checkbox will be set to unchecked

myCheckBox.tgl_check(false);

// checkbox will be set to checked

myCheckBox.tgl_check(true);

// set onchange event for the checkbox

myCheckBox.event_add('onchange', function(a) {
  alert(a[0].isChecked);
});

// checkbox will be set to checked and the onchange
// event will fire

myCheckBox.tgl_check(true);

// onchange event will not fire

myCheckBox.tgl_check(true, true);

The checkbox widget

VegUI element type for VegUICheckBox

function VegUICheckBox( refName,
Parent,
Manager )

Constructor

this.build = this.build_cb = function( toNode )

Builds the checkbox

this.set = this.set_cb = function( x,
y,
w,
h,
label,
checked,
cClass,
ucClass )

Sets the most common template properties for the checkbox

this.tgl_check = function( b,
noOnChange )

Toggles checkbox to be checked or unchecked

The most basic VegUI Element.

string text of the label

string Css class to use for BtnCheck when checked

string Css class to use for BtnCheck when unchecked

function VegUINode( refName,
Parent,
Manager )

this.build_element = function( VegUIObj,
toNode )

builds a VegUIElement.

this.build = this.build_node = function( toNode,
takeNode )

build a HTML node from the template properties of this element.

this.set = this.set_node = function( nodeType,
w,
h,
x,
y,
pos,
z )

Template Function

varies from element to element

vegui. checkbox. class.js

Constants

VUI_CHECKBOX

VegUICheckBox

Hierarchy

Type

Child Elements:

Tutorials

Properties

Object Properties

Template Properties

Functions

VegUICheckBox

Parameters

See also

build_cb

Alias

Parameters

Returns

See also

set_cb

Alias

Parameters

See also

Example

tgl_check

Parameters

Example