git.ithinksw.org / extjs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / CheckboxGroup.html
diff --git a/docs/source/CheckboxGroup.html b/docs/source/CheckboxGroup.html
index ae9c4c6..6efa745 100644 (file)
--- a/docs/source/CheckboxGroup.html
+++ b/docs/source/CheckboxGroup.html
@@ -1,50 +1,65 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-form.CheckboxGroup-method-constructor'><span id='Ext-form.CheckboxGroup'>/**
-</span></span> * @class Ext.form.CheckboxGroup
- * @extends Ext.form.FieldContainer
- * &lt;p&gt;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.&lt;/p&gt;
- * &lt;p&gt;&lt;b&gt;Validation:&lt;/b&gt; Individual checkbox fields themselves have no default validation behavior, but
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-form-CheckboxGroup'>/**
+</span> * 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.
+ *
+ * # Validation
+ *
+ * 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
  * sometimes you want to require a user to select at least one of a group of checkboxes. CheckboxGroup
- * allows this by setting the config &lt;tt&gt;{@link #allowBlank}:false&lt;/tt&gt;; when the user does not check at
+ * allows this by setting the config `{@link #allowBlank}:false`; when the user does not check at
  * least one of the checkboxes, the entire group will be highlighted as invalid and the
  * 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.&lt;/p&gt;
- * &lt;p&gt;&lt;b&gt;Layout:&lt;/b&gt; The default layout for CheckboxGroup makes it easy to arrange the checkboxes into
+ * {@link #blankText error message} will be displayed according to the {@link #msgTarget} config.
+ *
+ * # Layout
+ *
+ * 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
  * 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.&lt;/p&gt;
- * {@img Ext.form.RadioGroup/Ext.form.RadioGroup.png Ext.form.RadioGroup component}
- * &lt;p&gt;Example usage:&lt;/p&gt;
- * &lt;pre&gt;&lt;code&gt;
-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'}
-        ]
-    }]
-});
- * &lt;/code&gt;&lt;/pre&gt;
- * @constructor
- * Creates a new CheckboxGroup
- * @param {Object} config Configuration options
- * @xtype checkboxgroup
+ * the checkbox components at any depth will still be managed by the CheckboxGroup's validation.
+ *
+ *     @example
+ *     Ext.create('Ext.form.Panel', {
+ *         title: 'Checkbox Group',
+ *         width: 300,
+ *         height: 125,
+ *         bodyPadding: 10,
+ *         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' }
+ *             ]
+ *         }]
+ *     });
  */
 Ext.define('Ext.form.CheckboxGroup', {
     extend:'Ext.form.FieldContainer',
  */
 Ext.define('Ext.form.CheckboxGroup', {
     extend:'Ext.form.FieldContainer',
@@ -54,48 +69,51 @@ Ext.define('Ext.form.CheckboxGroup', {
     alias: 'widget.checkboxgroup',
     requires: ['Ext.layout.container.CheckboxGroup', 'Ext.form.field.Base'],
 
     alias: 'widget.checkboxgroup',
     requires: ['Ext.layout.container.CheckboxGroup', 'Ext.form.field.Base'],
 
-<span id='Ext-form.CheckboxGroup-cfg-name'>    /**
+<span id='Ext-form-CheckboxGroup-cfg-name'>    /**
 </span>     * @cfg {String} name
      * @hide
      */
 
 </span>     * @cfg {String} name
      * @hide
      */
 
-<span id='Ext-form.CheckboxGroup-cfg-items'>    /**
-</span>     * @cfg {Array} items An Array of {@link Ext.form.field.Checkbox Checkbox}es or Checkbox config objects
-     * to arrange in the group.
+<span id='Ext-form-CheckboxGroup-cfg-items'>    /**
+</span>     * @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.
      */
 
      */
 
-<span id='Ext-form.CheckboxGroup-cfg-columns'>    /**
-</span>     * @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:
-     * &lt;ul&gt;&lt;li&gt;&lt;b&gt;'auto'&lt;/b&gt; : &lt;p class=&quot;sub-desc&quot;&gt;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.&lt;/p&gt;&lt;/li&gt;
-     * &lt;li&gt;&lt;b&gt;Number&lt;/b&gt; : &lt;p class=&quot;sub-desc&quot;&gt;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}.&lt;/p&gt;&lt;/li&gt;
-     * &lt;li&gt;&lt;b&gt;Array&lt;/b&gt; : &lt;p class=&quot;sub-desc&quot;&gt;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.&lt;/p&gt;&lt;/li&gt;&lt;/ul&gt;
+<span id='Ext-form-CheckboxGroup-cfg-columns'>    /**
+</span>     * @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',
 
      */
     columns : 'auto',
 
-<span id='Ext-form.CheckboxGroup-cfg-vertical'>    /**
-</span>     * @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.
+<span id='Ext-form-CheckboxGroup-cfg-vertical'>    /**
+</span>     * @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,
 
      */
     vertical : false,
 
-<span id='Ext-form.CheckboxGroup-cfg-allowBlank'>    /**
-</span>     * @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.
+<span id='Ext-form-CheckboxGroup-cfg-allowBlank'>    /**
+</span>     * @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,
 
      */
     allowBlank : true,
 
-<span id='Ext-form.CheckboxGroup-cfg-blankText'>    /**
-</span>     * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails (defaults to &quot;You must
-     * select at least one item in this group&quot;)
+<span id='Ext-form-CheckboxGroup-cfg-blankText'>    /**
+</span>     * @cfg {String} blankText
+     * Error text to display if the {@link #allowBlank} validation fails
      */
     blankText : &quot;You must select at least one item in this group&quot;,
 
      */
     blankText : &quot;You must select at least one item in this group&quot;,
 
@@ -105,7 +123,7 @@ Ext.define('Ext.form.CheckboxGroup', {
     // private
     groupCls : Ext.baseCSSPrefix + 'form-check-group',
 
     // private
     groupCls : Ext.baseCSSPrefix + 'form-check-group',
 
-<span id='Ext-form.CheckboxGroup-cfg-fieldBodyCls'>    /**
+<span id='Ext-form-CheckboxGroup-cfg-fieldBodyCls'>    /**
 </span>     * @cfg {String} fieldBodyCls
      * An extra CSS class to be applied to the body content element in addition to {@link #baseBodyCls}.
      * Defaults to 'x-form-checkboxgroup-body'.
 </span>     * @cfg {String} fieldBodyCls
      * An extra CSS class to be applied to the body content element in addition to {@link #baseBodyCls}.
      * Defaults to 'x-form-checkboxgroup-body'.
@@ -121,11 +139,11 @@ Ext.define('Ext.form.CheckboxGroup', {
         me.initField();
     },
 
         me.initField();
     },
 
-<span id='Ext-form.CheckboxGroup-method-initValue'>    /**
-</span>     * @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.
+<span id='Ext-form-CheckboxGroup-method-initValue'>    /**
+</span>     * 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
      */
     initValue: function() {
         var me = this,
      */
     initValue: function() {
         var me = this,
@@ -136,9 +154,10 @@ Ext.define('Ext.form.CheckboxGroup', {
         }
     },
 
         }
     },
 
-<span id='Ext-form.CheckboxGroup-method-onFieldAdded'>    /**
-</span>     * @protected
-     * When a checkbox is added to the group, monitor it for changes
+<span id='Ext-form-CheckboxGroup-method-onFieldAdded'>    /**
+</span>     * When a checkbox is added to the group, monitor it for changes
+     * @param {Object} field
+     * @protected
      */
     onFieldAdded: function(field) {
         var me = this;
      */
     onFieldAdded: function(field) {
         var me = this;
@@ -162,10 +181,10 @@ Ext.define('Ext.form.CheckboxGroup', {
         return toQueryString(value1) === toQueryString(value2);
     },
 
         return toQueryString(value1) === toQueryString(value2);
     },
 
-<span id='Ext-form.CheckboxGroup-method-getErrors'>    /**
-</span>     * 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
+<span id='Ext-form-CheckboxGroup-method-getErrors'>    /**
+</span>     * 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 = [];
      */
     getErrors: function() {
         var errors = [];
@@ -175,25 +194,25 @@ Ext.define('Ext.form.CheckboxGroup', {
         return errors;
     },
 
         return errors;
     },
 
-<span id='Ext-form.CheckboxGroup-method-getBoxes'>    /**
+<span id='Ext-form-CheckboxGroup-method-getBoxes'>    /**
 </span>     * @private Returns all checkbox components within the container
      */
     getBoxes: function() {
         return this.query('[isCheckbox]');
     },
 
 </span>     * @private Returns all checkbox components within the container
      */
     getBoxes: function() {
         return this.query('[isCheckbox]');
     },
 
-<span id='Ext-form.CheckboxGroup-method-eachBox'>    /**
+<span id='Ext-form-CheckboxGroup-method-eachBox'>    /**
 </span>     * @private Convenience function which calls the given function for every checkbox in the group
      * @param {Function} fn The function to call
 </span>     * @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);
     },
 
      */
     eachBox: function(fn, scope) {
         Ext.Array.forEach(this.getBoxes(), fn, scope || this);
     },
 
-<span id='Ext-form.CheckboxGroup-method-getChecked'>    /**
+<span id='Ext-form-CheckboxGroup-method-getChecked'>    /**
 </span>     * Returns an Array of all checkboxes in the container which are currently checked
 </span>     * 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) {
      */
     getChecked: function() {
         return Ext.Array.filter(this.getBoxes(), function(cb) {
@@ -216,9 +235,9 @@ Ext.define('Ext.form.CheckboxGroup', {
         this.readOnly = readOnly;
     },
 
         this.readOnly = readOnly;
     },
 
-<span id='Ext-form.CheckboxGroup-method-reset'>    /**
-</span>     * 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.
+<span id='Ext-form-CheckboxGroup-method-reset'>    /**
+</span>     * 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() {
      * See {@link Ext.form.Basic}.{@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad}
      */
     reset: function() {
@@ -248,52 +267,55 @@ Ext.define('Ext.form.CheckboxGroup', {
     },
 
 
     },
 
 
-<span id='Ext-form.CheckboxGroup-method-setValue'>    /**
-</span>     * &lt;p&gt;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:&lt;/p&gt;
-     * &lt;ul&gt;
-     *   &lt;li&gt;A single Boolean or String value will be passed to the &lt;code&gt;setValue&lt;/code&gt; method of the
-     *   checkbox with that name. See the rules in {@link Ext.form.field.Checkbox#setValue} for accepted values.&lt;/li&gt;
-     *   &lt;li&gt;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.&lt;/li&gt;
-     * &lt;/ul&gt;
-     * &lt;p&gt;If a checkbox's name is not in the mapping at all, it will be unchecked.&lt;/p&gt;
-     * &lt;p&gt;An example:&lt;/p&gt;
-     * &lt;pre&gt;&lt;code&gt;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']
-});&lt;/code&gt;&lt;/pre&gt;
-     * &lt;p&gt;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.&lt;/p&gt;
+<span id='Ext-form-CheckboxGroup-method-setValue'>    /**
+</span>     * 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
      */
      * @param {Object} value The mapping of checkbox names to values.
      * @return {Ext.form.CheckboxGroup} this
      */
@@ -318,16 +340,18 @@ myCheckboxGroup.setValue({
     },
 
 
     },
 
 
-<span id='Ext-form.CheckboxGroup-method-getValue'>    /**
-</span>     * &lt;p&gt;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.&lt;/p&gt;
-     * &lt;p&gt;The object format returned from this method can also be passed directly to the {@link #setValue} method.&lt;/p&gt;
-     * &lt;p&gt;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.&lt;/p&gt;
+<span id='Ext-form-CheckboxGroup-method-getValue'>    /**
+</span>     * 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 = {};
      */
     getValue: function() {
         var values = {};
@@ -389,4 +413,6 @@ myCheckboxGroup.setValue({
 
 });
 
 
 });
 
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.