API: inputEx inputEx.CheckBox (YUI Library)

Class inputEx.CheckBox - extends inputEx.Field

Create a checkbox.

Constructor

inputEx.CheckBox

Parameters:

options
                                                    <Object>

Added options for CheckBoxes:

sentValues: 2D vector of values for checked/unchecked states (default is [true, false])

Properties inherited from inputEx.Field:


                                    
                                        
                                        options

Methods

disable

Disable the field

enable

Enable the field

getValue

Get the state value

Returns: Any: one of [checkedValue,uncheckedValue]

initEvents

Clear the previous events and listen for the "change" event

onChange

Function called when the checkbox is toggled

Parameters:: e <Event> The original 'change' event

renderComponent


                                        
                                        
                                        
                                        void
                                            renderComponent
                                           (
                                            )

Render the checkbox and the hidden field

setOptions

Adds the CheckBox specific options

Parameters:: options <Object> Options object as passed to the constructor

setValue


                                        
                                        
                                        
                                        void
                                            setValue
                                           (
                                                
                                                        
                                                         value
                                                    
                                                
                                                        , 
                                                         [sendUpdatedEvt]
                                                    
                                                
                                            )

Set the value of the checkedbox

Parameters:: value <Any> The value schould be one of [checkedValue,uncheckedValue]; [sendUpdatedEvt] <boolean> (optional) Wether this setValue should fire the updatedEvt or not (default is true, pass false to NOT send the event)

Methods inherited from inputEx.Field:


                                                                                    
                                            clear,
                                            
                                                                                    
                                            close,
                                            
                                                                                    
                                            destroy,
                                            
                                                                                    
                                            disable,
                                            
                                                                                    
                                            displayMessage,
                                            
                                                                                    
                                            enable,
                                            
                                                                                    
                                            fireUpdatedEvt,
                                            
                                                                                    
                                            focus,
                                            
                                                                                    
                                            getEl,
                                            
                                                                                    
                                            getParentField,
                                            
                                                                                    
                                            getState,
                                            
                                                                                    
                                            getStateString,
                                            
                                                                                    
                                            getValue,
                                            
                                                                                    
                                            hide,
                                            
                                                                                    
                                            initEvents,
                                            
                                                                                    
                                            isDisabled,
                                            
                                                                                    
                                            isEmpty,
                                            
                                                                                    
                                            onBlur,
                                            
                                                                                    
                                            onChange,
                                            
                                                                                    
                                            onFocus,
                                            
                                                                                    
                                            render,
                                            
                                                                                    
                                            renderComponent,
                                            
                                                                                    
                                            setClassFromState,
                                            
                                                                                    
                                            setFieldName,
                                            
                                                                                    
                                            setOptions,
                                            
                                                                                    
                                            setParentField,
                                            
                                                                                    
                                            setValue,
                                            
                                                                                    
                                            show,
                                            
                                                                                    
                                            validate

Events inherited from inputEx.Field:


                                        
                                        updatedEvt,

inputEx-library

inputEx 0.7.1

Class inputEx.CheckBox - extends inputEx.Field

Constructor

Properties inherited from inputEx.Field:

Methods

disable

enable

getValue

initEvents

onChange

renderComponent

setOptions

setValue

Methods inherited from inputEx.Field:

Events inherited from inputEx.Field:

Modules

Classes

Files

Methods