X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/src/form/CheckboxGroup.js diff --git a/src/form/CheckboxGroup.js b/src/form/CheckboxGroup.js index 952b1cc3..40d00d66 100644 --- a/src/form/CheckboxGroup.js +++ b/src/form/CheckboxGroup.js @@ -14,9 +14,9 @@ If you are unsure which license is appropriate for your use, please contact the */ /** * 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. + * {@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. * * # Validation * @@ -34,33 +34,29 @@ If you are unsure which license is appropriate for your use, please contact the * 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. * - * {@img Ext.form.CheckboxGroup/Ext.form.CheckboxGroup.png Ext.form.CheckboxGroup component} - * - * # Example usage - * + * @example * Ext.create('Ext.form.Panel', { * title: 'Checkbox Group', * width: 300, * height: 125, * bodyPadding: 10, - * renderTo: Ext.getBody(), - * items:[{ + * renderTo: Ext.getBody(), + * items:[{ * xtype: 'checkboxgroup', * 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'} + * { 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' } * ] * }] * }); - * */ Ext.define('Ext.form.CheckboxGroup', { extend:'Ext.form.FieldContainer', @@ -76,42 +72,45 @@ Ext.define('Ext.form.CheckboxGroup', { */ /** - * @cfg {Array} items An Array of {@link Ext.form.field.Checkbox Checkbox}es or Checkbox config objects - * to arrange in the group. + * @cfg {Ext.form.field.Checkbox[]/Object[]} 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 - * checkbox/radio controls using automatic layout. This config can take several types of values: - * + * @cfg {String/Number/Number[]} 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: + * + * - 'auto' - 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. + * - Number - 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}. + * - Array - 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. */ columns : 'auto', /** - * @cfg {Boolean} vertical True to distribute contained controls across columns, completely filling each column - * top to bottom before starting on the next column. The number of controls in each column will be automatically - * calculated to keep columns as even as possible. The default value is false, so that controls will be added - * to columns one at a time, completely filling each row left to right before starting on the next row. + * @cfg {Boolean} vertical + * True to distribute contained controls across columns, completely filling each column top to bottom before + * starting on the next column. The number of controls in each column will be automatically calculated to keep + * columns as even as possible. The default value is false, so that controls will be added to columns one at a time, + * completely filling each row left to right before starting on the next row. */ vertical : false, /** - * @cfg {Boolean} allowBlank False to validate that at least one item in the group is checked (defaults to true). - * If no items are selected at validation time, {@link #blankText} will be used as the error text. + * @cfg {Boolean} allowBlank + * False to validate that at least one item in the group is checked. If no items are selected at + * validation time, {@link #blankText} will be used as the error text. */ allowBlank : true, /** - * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails (defaults to "You must - * select at least one item in this group") + * @cfg {String} blankText + * Error text to display if the {@link #allowBlank} validation fails */ blankText : "You must select at least one item in this group", @@ -138,10 +137,10 @@ Ext.define('Ext.form.CheckboxGroup', { }, /** + * Initializes the field's value based on the initial config. If the {@link #value} config is specified then we use + * that to set the value; otherwise we initialize the originalValue by querying the values of all sub-checkboxes + * after they have been initialized. * @protected - * Initializes the field's value based on the initial config. If the {@link #value} config is specified - * then we use that to set the value; otherwise we initialize the originalValue by querying the values of - * all sub-checkboxes after they have been initialized. */ initValue: function() { var me = this, @@ -153,8 +152,9 @@ Ext.define('Ext.form.CheckboxGroup', { }, /** - * @protected * When a checkbox is added to the group, monitor it for changes + * @param {Object} field + * @protected */ onFieldAdded: function(field) { var me = this; @@ -179,9 +179,9 @@ Ext.define('Ext.form.CheckboxGroup', { }, /** - * Runs CheckboxGroup's validations and returns an array of any errors. The only error by default - * is if allowBlank is set to true and no items are checked. - * @return {Array} Array of all validation errors + * Runs CheckboxGroup's validations and returns an array of any errors. The only error by default is if allowBlank + * is set to true and no items are checked. + * @return {String[]} Array of all validation errors */ getErrors: function() { var errors = []; @@ -201,7 +201,7 @@ Ext.define('Ext.form.CheckboxGroup', { /** * @private Convenience function which calls the given function for every checkbox in the group * @param {Function} fn The function to call - * @param {Object} scope Optional scope object + * @param {Object} scope (Optional) scope object */ eachBox: function(fn, scope) { Ext.Array.forEach(this.getBoxes(), fn, scope || this); @@ -209,7 +209,7 @@ Ext.define('Ext.form.CheckboxGroup', { /** * Returns an Array of all checkboxes in the container which are currently checked - * @return {Array} Array of Ext.form.field.Checkbox components + * @return {Ext.form.field.Checkbox[]} Array of Ext.form.field.Checkbox components */ getChecked: function() { return Ext.Array.filter(this.getBoxes(), function(cb) { @@ -233,8 +233,8 @@ Ext.define('Ext.form.CheckboxGroup', { }, /** - * Resets the checked state of all {@link Ext.form.field.Checkbox checkboxes} in the group to their - * originally loaded values and clears any validation messages. + * Resets the checked state of all {@link Ext.form.field.Checkbox checkboxes} in the group to their originally + * loaded values and clears any validation messages. * See {@link Ext.form.Basic}.{@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} */ reset: function() { @@ -265,51 +265,54 @@ Ext.define('Ext.form.CheckboxGroup', { /** - *

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:

- * - *

If a checkbox's name is not in the mapping at all, it will be unchecked.

- *

An example:

- * 
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'
-    }]
-});
-
-myCheckboxGroup.setValue({
-    cb1: true,
-    cb3: false,
-    cbGroup: ['value1', 'value3']
-});
- *

The above code will cause the checkbox named 'cb1' to be checked, as well as the first and third - * checkboxes named 'cbGroup'. The other three checkboxes will be unchecked.

+ * 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: + * + * - A single Boolean or String value will be passed to the `setValue` method of the checkbox with that name. + * See the rules in {@link Ext.form.field.Checkbox#setValue} for accepted values. + * - 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. + * + * If a checkbox's name is not in the mapping at all, it will be unchecked. + * + * An example: + * + * 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' + * }] + * }); + * + * myCheckboxGroup.setValue({ + * cb1: true, + * cb3: false, + * cbGroup: ['value1', 'value3'] + * }); + * + * The above code will cause the checkbox named 'cb1' to be checked, as well as the first and third checkboxes named + * 'cbGroup'. The other three checkboxes will be unchecked. + * * @param {Object} value The mapping of checkbox names to values. * @return {Ext.form.CheckboxGroup} this */ @@ -335,15 +338,17 @@ myCheckboxGroup.setValue({ /** - *

Returns an object containing the values of all checked checkboxes within the group. Each key-value pair - * in the object corresponds to a checkbox {@link Ext.form.field.Checkbox#name name}. If there is only one checked - * checkbox with a particular name, the value of that pair will be the String - * {@link Ext.form.field.Checkbox#inputValue inputValue} of that checkbox. If there are multiple checked checkboxes - * with that name, the value of that pair will be an Array of the selected inputValues.

- *

The object format returned from this method can also be passed directly to the {@link #setValue} method.

- *

NOTE: In Ext 3, this method returned an array of Checkbox components; this was changed to make it more - * consistent with other field components and with the {@link #setValue} argument signature. If you need the old - * behavior in Ext 4+, use the {@link #getChecked} method instead.

+ * Returns an object containing the values of all checked checkboxes within the group. Each key-value pair in the + * object corresponds to a checkbox {@link Ext.form.field.Checkbox#name name}. If there is only one checked checkbox + * with a particular name, the value of that pair will be the String {@link Ext.form.field.Checkbox#inputValue + * inputValue} of that checkbox. If there are multiple checked checkboxes with that name, the value of that pair + * will be an Array of the selected inputValues. + * + * The object format returned from this method can also be passed directly to the {@link #setValue} method. + * + * NOTE: In Ext 3, this method returned an array of Checkbox components; this was changed to make it more consistent + * with other field components and with the {@link #setValue} argument signature. If you need the old behavior in + * Ext 4+, use the {@link #getChecked} method instead. */ getValue: function() { var values = {};