Checkbox Class

Show Source

Form input that can be either checked or unchecked. The input consists of a square box with a checkmark when activated and text label.

Constructors

Checkbox( parent, config )

Show Source

Used to instantiate this class

parent	DOM element in which to render this component
config	Configuration settings (optional). See config options for more information.

Config Options

label

Label for the checkbox (optional). Accepts either a string or a DOM element.

Show Source

value

Value associated with the checkbox (optional). Note that this is different than the checkbox state. Use the isChecked() method to determine whether the checkbox is checked.

Show Source

checked

If true, the checkbox will initially render with a check. Default is false.

Show Source

disabled

If true, the component will be disabled when rendered. Default is false.

Show Source

style

Style for individual elements within the component. Note that you can provide CSS class names instead of individual style definitions.

Show Source

Events

onClick( checked )

Called whenever the checkbox is clicked.

Show Source

onChange( checked )

Called whenever the checkbox value is changed.

Show Source

Public Methods

enable( )

Used to enable the checkbox.

Show Source

disable( )

Used to disable the checkbox.

Show Source

select( silent )

Used to add a check to the checkbox.

Show Source

deselect( silent )

Used to remove the check from the checkbox.

Show Source

toggle( )

Used to toggle the checkbox state.

Show Source

getValue( )

Returns the value associated with the checkbox. Note that this is different than the checkbox state. Use the isChecked() method to determine whether the checkbox is checked. The value is defined in the config used to instantiate this class.

Show Source

isChecked( )

Returns true if the checkbox is checked.

Show Source