Properties Methods Events Config Options Direct Link
Observable
  Component
    BoxComponent
      Field
        CheckboxGroup

Class Ext.form.CheckboxGroup

Package:Ext.form
Defined In:CheckboxGroup.js
Class:CheckboxGroup
Subclasses:RadioGroup
Extends:Field

A grouping container for Ext.form.Checkbox controls.

Sample usage:

var myCheckboxGroup = new Ext.form.CheckboxGroup({
    id:'myGroup',
    xtype: 'checkboxgroup',
    fieldLabel: 'Single Column',
    itemCls: 'x-check-group-alt',
    // Put all controls in a single column with width 100%
    columns: 1,
    items: [
        {boxLabel: 'Item 1', name: 'cb-col-1'},
        {boxLabel: 'Item 2', name: 'cb-col-2', checked: true},
        {boxLabel: 'Item 3', name: 'cb-col-3'}
    ]
});

Config Options

Config OptionsDefined By
 allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
Component
 cls : String
A custom CSS class to apply to the field's underlying element (defaults to '').
Field
 data : Mixed
The initial set of data to apply to the tpl to update the content area of the Component.
Component
 disabledClass : String
CSS class added to the component when it is disabled (defaults to 'x-item-disabled').
Component
 fieldClass : String
The default CSS class for the field (defaults to 'x-form-field')
Field
 focusClass : String
The CSS class to use when the field receives focus (defaults to 'x-form-focus')
Field
 hidden : Boolean
Render this component hidden (default is false). If true, the hide method will be called internally.
Component
 invalidClass : String
The CSS class to use when marking a field invalid (defaults to 'x-form-invalid')
Field
 items : Array
An Array of Checkboxes or Checkbox config objects to arrange in the group.
CheckboxGroup
 msgFx : String
Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
Field
 pageX : Number
The page level x coordinate for this component if contained within a positioning container.
BoxComponent
 pageY : Number
The page level y coordinate for this component if contained within a positioning container.
BoxComponent
 preventMark : Boolean
true to disable marking the field invalid. Defaults to false.
Field
 submitValue : Boolean
False to clear the name attribute on the field so that it is not submitted during a form post. Defaults to true.
Field
 validateOnBlur : Boolean
Whether the field should validate when it loses focus (defaults to true).
Field
 validationDelay : Number
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
Field
 value : Mixed
A value to initialize this field with (defaults to undefined).
Field
 x : Number
The local x (left) coordinate for this component if contained within a positioning container.
BoxComponent
 y : Number
The local y (top) coordinate for this component if contained within a positioning container.
BoxComponent

Public Properties

PropertyDefined By
 disabled : Boolean
True if this component is disabled. Read-only.
Component
 hidden : Boolean
True if this component is hidden. Read-only.
Component
 initialConfig : Object
This Component's initial configuration specification. Read-only.
Component
 rendered : Boolean
True if this component has been rendered. Read-only.
Component

Public Methods

MethodDefined By

Public Events

EventDefined By