/** - * @class Ext.form.CheckboxGroup - * @extends Ext.form.Field - *A grouping container for {@link Ext.form.Checkbox} controls.
- *Sample usage:
- *+ * </code></pre> * @constructor * Creates a new CheckboxGroup * @param {Object} config Configuration options * @xtype checkboxgroup */ -Ext.form.CheckboxGroup = Ext.extend(Ext.form.Field, { - /** - * @cfg {Array} items An Array of {@link Ext.form.Checkbox Checkbox}es or Checkbox config objects +Ext.define('Ext.form.CheckboxGroup', { + extend:'Ext.form.FieldContainer', + mixins: { + field: 'Ext.form.field.Field' + }, + alias: 'widget.checkboxgroup', + requires: ['Ext.layout.container.CheckboxGroup', 'Ext.form.field.Base'], + + /** + * @cfg {String} name + * @hide + */ + + /** + * @cfg {Array} items An Array of {@link Ext.form.field.Checkbox Checkbox}es or Checkbox config objects * to arrange in the group. */ - /** - * @cfg {String/Number/Array} columns Specifies the number of columns to use when displaying grouped + + /** + * @cfg {String/Number/Array} columns Specifies the number of columns to use when displaying grouped * checkbox/radio controls using automatic layout. This config can take several types of values: - *-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'} - ] +Sencha Documentation Project /** + * @class Ext.form.CheckboxGroup + * @extends Ext.form.FieldContainer + * <p>A {@link Ext.form.FieldContainer field container} which has a specialized layout for arranging + * {@link Ext.form.field.Checkbox} controls into columns, and provides convenience {@link Ext.form.field.Field} methods + * for {@link #getValue getting}, {@link #setValue setting}, and {@link #validate validating} the group + * of checkboxes as a whole.</p> + * <p><b>Validation:</b> Individual checkbox fields themselves have no default validation behavior, but + * sometimes you want to require a user to select at least one of a group of checkboxes. CheckboxGroup + * allows this by setting the config <tt>{@link #allowBlank}:false</tt>; when the user does not check at + * least one of the checkboxes, the entire group will be highlighted as invalid and the + * {@link #blankText error message} will be displayed according to the {@link #msgTarget} config.</p> + * <p><b>Layout:</b> The default layout for CheckboxGroup makes it easy to arrange the checkboxes into + * columns; see the {@link #columns} and {@link #vertical} config documentation for details. You may also + * use a completely different layout by setting the {@link #layout} to one of the other supported layout + * types; for instance you may wish to use a custom arrangement of hbox and vbox containers. In that case + * the checkbox components at any depth will still be managed by the CheckboxGroup's validation.</p> + * {@img Ext.form.RadioGroup/Ext.form.RadioGroup.png Ext.form.RadioGroup component} + * <p>Example usage:</p> + * <pre><code> +Ext.create('Ext.form.Panel', { + title: 'RadioGroup Example', + width: 300, + height: 125, + bodyPadding: 10, + renderTo: Ext.getBody(), + items:[{ + xtype: 'radiogroup', + fieldLabel: 'Two Columns', + // Arrange radio buttons into two columns, distributed vertically + columns: 2, + vertical: true, + items: [ + {boxLabel: 'Item 1', name: 'rb', inputValue: '1'}, + {boxLabel: 'Item 2', name: 'rb', inputValue: '2', checked: true}, + {boxLabel: 'Item 3', name: 'rb', inputValue: '3'}, + {boxLabel: 'Item 4', name: 'rb', inputValue: '4'}, + {boxLabel: 'Item 5', name: 'rb', inputValue: '5'}, + {boxLabel: 'Item 6', name: 'rb', inputValue: '6'} + ] + }] }); - *
The controls will be rendered one per column on one row and the width - * of each column will be evenly distributed based on the width of the overall field container. This is the default.
If you specific a number (e.g., 3) that number of columns will be - * created and the contained controls will be automatically distributed based on the value of {@link #vertical}.
You can also specify an array of column widths, mixing integer + * <ul><li><b>'auto'</b> : <p class="sub-desc">The controls will be rendered one per column on one row and the width + * of each column will be evenly distributed based on the width of the overall field container. This is the default.</p></li> + * <li><b>Number</b> : <p class="sub-desc">If you specific a number (e.g., 3) that number of columns will be + * created and the contained controls will be automatically distributed based on the value of {@link #vertical}.</p></li> + * <li><b>Array</b> : <p class="sub-desc">You can also specify an array of column widths, mixing integer * (fixed width) and float (percentage width) values as needed (e.g., [100, .25, .75]). Any integer values will * be rendered first, then any float values will be calculated as a percentage of the remaining space. Float * values do not have to add up to 1 (100%) although if you want the controls to take up the entire field - * container you should do so.
-// call with name and value
-myCheckboxGroup.setValue('cb-col-1', true);
-// call with an array of boolean values
-myCheckboxGroup.setValue([true, false, false]);
-// call with an object literal specifying item:value pairs
-myCheckboxGroup.setValue({
- 'cb-col-2': false,
- 'cb-col-3': true
+ /**
+ * <p>Sets the value(s) of all checkboxes in the group. The expected format is an Object of
+ * name-value pairs corresponding to the names of the checkboxes in the group. Each pair can
+ * have either a single or multiple values:</p>
+ * <ul>
+ * <li>A single Boolean or String value will be passed to the <code>setValue</code> method of the
+ * checkbox with that name. See the rules in {@link Ext.form.field.Checkbox#setValue} for accepted values.</li>
+ * <li>An Array of String values will be matched against the {@link Ext.form.field.Checkbox#inputValue inputValue}
+ * of checkboxes in the group with that name; those checkboxes whose inputValue exists in the array will be
+ * checked and others will be unchecked.</li>
+ * </ul>
+ * <p>If a checkbox's name is not in the mapping at all, it will be unchecked.</p>
+ * <p>An example:</p>
+ * <pre><code>var myCheckboxGroup = new Ext.form.CheckboxGroup({
+ columns: 3,
+ items: [{
+ name: 'cb1',
+ boxLabel: 'Single 1'
+ }, {
+ name: 'cb2',
+ boxLabel: 'Single 2'
+ }, {
+ name: 'cb3',
+ boxLabel: 'Single 3'
+ }, {
+ name: 'cbGroup',
+ boxLabel: 'Grouped 1'
+ inputValue: 'value1'
+ }, {
+ name: 'cbGroup',
+ boxLabel: 'Grouped 2'
+ inputValue: 'value2'
+ }, {
+ name: 'cbGroup',
+ boxLabel: 'Grouped 3'
+ inputValue: 'value3'
+ }]
});
-// use comma separated string to set items with name to true (checked)
-myCheckboxGroup.setValue('cb-col-1,cb-col-3');
- *