inputEx Documentation Back to homepage

### inputEx Documentation > inputEx.CheckBox 0.2.2

## Static Class inputEx.CheckBox - extends inputEx.Field

Create a checkbox.

### Constructor

inputEx.CheckBox `( options )`

Parameters:
  `options <Object>` - Added options for CheckBoxes:
  - sentValues: 2D vector of values for checked/unchecked states (default is [true, false])

### Properties

#### static groupOptions `- Object`

group Options for each field

#### options `- Object`

Configuration object to set the options for this class and the parent classes. See constructor details for options added by this class.

### Methods

#### disable

`disable()`
Disable the field

#### enable

`enable()`
Enable the field

#### getValue

`<Any> getValue()`
Get the state value
Returns:

`<Any>` one of [checkedValue,uncheckedValue]

#### initEvents

`initEvents()`
Clear the previous events and listen for the "change" event

#### onChange

`onChange(e)`
Function called when the checkbox is toggled
Parameters:

`e <Event>` - The original 'change' event

#### renderComponent

`renderComponent()`
Render the checkbox and the hidden field

#### setOptions

`setOptions(options)`
Adds the CheckBox specific options
Parameters:

`options <Object>` - Options object (inputEx inputParams) as passed to the constructor

#### setValue

`setValue(value[,sendUpdatedEvt])`
Set the value of the checkedbox
Parameters:

`value <Any>` - The value schould be one of [checkedValue,uncheckedValue]

`sendUpdatedEvt <boolean>` optional - (optional) Wether this setValue should fire the updatedEvt or not (default is true, pass false to NOT send the event)

#### Methods inherited from class inputEx.Field:

`focus, getEl, validate, fireUpdatedEvt, show, close, onBlur, onFocus, getStateString, setClassFromState, render, updatedEvt, getState, hide, displayMessage, destroy, isEmpty, clear,`

Copyright (c) 2007-2009 Eric Abouaf. All rights reserved.
Generated by JsDoc Toolkit 2.0.0 on Wed, 04 Mar 2009 15:41:30 GMT using neyricjslibs-template.