Class GSCheckbox

A checkbox control.

Class Summary
Constructor Attributes Constructor Name and Description
 
GSCheckbox(parent, options)
Creates a new GSCheckbox
Property Summary
Property Attributes Property Name and Description
<static>  
GSCheckbox.CHECKED
The checkbox checked state
<static>  
GSCheckbox.PARTIALLY_CHECKED
The checkbox partially checked state
<static>  
GSCheckbox.UNCHECKED
The checkbox unchecked state
Method Summary
Method Attributes Method Name and Description
 
Checks this checkbox
 
Partially checks this checkbox
 
setStyles(styles)
Sets the specified styles for this checkbox
 
Unchecks this checkbox
Class Detail
GSCheckbox(parent, options)
Creates a new GSCheckbox
Parameters:
{HTMLElement} parent
the checkbox parent element
{Object} options Optional
an object literal specifying the checkbox options to set:
{boolean} options.checked
the initial state of this checkbox
{Object} options.styles
an object literal specifying CSS styles to be set on the checkbox
{Function} options.onClick
a function to be executed when the checkbox is clicked
Property Detail
<static> {int} GSCheckbox.CHECKED
The checkbox checked state

<static> {int} GSCheckbox.PARTIALLY_CHECKED
The checkbox partially checked state

<static> {int} GSCheckbox.UNCHECKED
The checkbox unchecked state
Method Detail
check()
Checks this checkbox

partialCheck()
Partially checks this checkbox

setStyles(styles)
Sets the specified styles for this checkbox
Parameters:
{Object} styles
an object literal specifying the styles to set

uncheck()
Unchecks this checkbox

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Mar 07 2012 11:47:28 GMT+1300 (NZDT)