Class: InputElementCheckbox

InputElementCheckbox

A checkbox object, derived from labeled object

new InputElementCheckbox()

Source:

Extends

Methods

appendTo(parent)

Appends the derived object and any label to a DOM node
Parameters:
Name Type Description
parent Object The DOM element to which this is added
Inherited From:
Source:

clearChecked()

Sets the checkbox to unchecked.
Source:

disable()

Disables the object
Inherited From:
Source:

enable()

Enables the object
Inherited From:
Source:

getValue() → {string}

Retrieves the value attribute of a checkbox
Source:
Returns:
the value associated with the checkbox object
Type
string

isChecked() → {boolean}

Returns the checkbox state.
Source:
Returns:
Whether the checkbox is checked or not
Type
boolean

onChange(listener)

Attaches an onchange handler to the object
Parameters:
Name Type Description
listener function The event listener to add
Inherited From:
Source:

onClick(listener)

Attaches an onclick handler to the object
Parameters:
Name Type Description
listener function The event listener to add
Inherited From:
Source:

setChecked()

Sets the checkbox to checked.
Source:

setLabel(text)

Sets the text for the associated label.
Parameters:
Name Type Description
text string The label for the including object.
Inherited From:
Source:

setTextAlign(text)

Sets the text alignment for the associated label. Default is left.
Parameters:
Name Type Description
text string The desired alignment, either 'left' or 'right'
Inherited From:
Source:

setValue(vstring)

Provides a mechanism to store a value for a checkbox
Parameters:
Name Type Description
vstring string The string value to be assigned to the checkbox
Source: