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 / RadioGroup.html
diff --git a/docs/source/RadioGroup.html b/docs/source/RadioGroup.html
index 27ef23a..cf82f1f 100644 (file)
--- a/docs/source/RadioGroup.html
+++ b/docs/source/RadioGroup.html
@@ -1,133 +1,119 @@
+<!DOCTYPE html>
 <html>
 <head>
 <html>
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
   <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>
+  <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>
 </head>
-<body  onload="prettyPrint();">
-    <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
-<div id="cls-Ext.form.RadioGroup"></div>/**
- * @class Ext.form.RadioGroup
- * @extends Ext.form.CheckboxGroup
- * A grouping container for {@link Ext.form.Radio} controls.
- * @constructor
- * Creates a new RadioGroup
- * @param {Object} config Configuration options
- * @xtype radiogroup
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-form-RadioGroup'>/**
+</span> * A {@link Ext.form.FieldContainer field container} which has a specialized layout for arranging
+ * {@link Ext.form.field.Radio} 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 radio buttons as a whole.
+ *
+ * # Validation
+ *
+ * Individual radio buttons themselves have no default validation behavior, but
+ * sometimes you want to require a user to select one of a group of radios. RadioGroup
+ * allows this by setting the config `{@link #allowBlank}:false`; when the user does not check at
+ * one of the radio buttons, 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;
+ *
+ * # Layout
+ *
+ * The default layout for RadioGroup makes it easy to arrange the radio buttons 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 Radio components at any depth will still be managed by the RadioGroup's validation.
+ *
+ * # Example usage
+ *
+ *     @example
+ *     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' }
+ *             ]
+ *         }]
+ *     });
+ *
  */
  */
-Ext.form.RadioGroup = Ext.extend(Ext.form.CheckboxGroup, {
-    <div id="cfg-Ext.form.RadioGroup-items"></div>/**
-     * @cfg {Array} items An Array of {@link Ext.form.Radio Radio}s or Radio config objects
-     * to arrange in the group.
+Ext.define('Ext.form.RadioGroup', {
+    extend: 'Ext.form.CheckboxGroup',
+    alias: 'widget.radiogroup',
+
+<span id='Ext-form-RadioGroup-cfg-items'>    /**
+</span>     * @cfg {Ext.form.field.Radio[]/Object[]} items
+     * An Array of {@link Ext.form.field.Radio Radio}s or Radio config objects to arrange in the group.
      */
      */
-    <div id="cfg-Ext.form.RadioGroup-allowBlank"></div>/**
-     * @cfg {Boolean} allowBlank True to allow every item in the group to be blank (defaults to true).
-     * If allowBlank = false and no items are selected at validation time, {@link @blankText} will
+<span id='Ext-form-RadioGroup-cfg-allowBlank'>    /**
+</span>     * @cfg {Boolean} allowBlank True to allow every item in the group to be blank.
+     * If allowBlank = false and no items are selected at validation time, {@link #blankText} will
      * be used as the error text.
      */
     allowBlank : true,
      * be used as the error text.
      */
     allowBlank : true,
-    <div id="cfg-Ext.form.RadioGroup-blankText"></div>/**
-     * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails
-     * (defaults to 'You must select one item in this group')
+<span id='Ext-form-RadioGroup-cfg-blankText'>    /**
+</span>     * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails
      */
     blankText : 'You must select one item in this group',
      */
     blankText : 'You must select one item in this group',
-    
+
     // private
     // private
-    defaultType : 'radio',
-    
+    defaultType : 'radiofield',
+
     // private
     // private
-    groupCls : 'x-form-radio-group',
-    
-    <div id="event-Ext.form.RadioGroup-change"></div>/**
-     * @event change
-     * Fires when the state of a child radio changes.
-     * @param {Ext.form.RadioGroup} this
-     * @param {Ext.form.Radio} checked The checked radio
-     */
-    
-    <div id="method-Ext.form.RadioGroup-getValue"></div>/**
-     * Gets the selected {@link Ext.form.Radio} in the group, if it exists.
-     * @return {Ext.form.Radio} The selected radio.
-     */
-    getValue : function(){
-        var out = null;
-        this.eachItem(function(item){
-            if(item.checked){
-                out = item;
-                return false;
-            }
-        });
-        return out;
+    groupCls : Ext.baseCSSPrefix + 'form-radio-group',
+
+    getBoxes: function() {
+        return this.query('[isRadio]');
     },
     },
-    
-    <div id="method-Ext.form.RadioGroup-onSetValue"></div>/**
-     * Sets the checked radio in the group.
-     * @param {String/Ext.form.Radio} id The radio to check.
-     * @param {Boolean} value The value to set the radio.
-     * @return {Ext.form.RadioGroup} this
+
+<span id='Ext-form-RadioGroup-method-setValue'>    /**
+</span>     * Sets the value of the radio group. The radio with corresponding name and value will be set.
+     * This method is simpler than {@link Ext.form.CheckboxGroup#setValue} because only 1 value is allowed
+     * for each name.
+     * 
+     * @param {Object} value The map from names to values to be set.
+     * @return {Ext.form.CheckboxGroup} this
      */
      */
-    onSetValue : function(id, value){
-        if(arguments.length > 1){
-            var f = this.getBox(id);
-            if(f){
-                f.setValue(value);
-                if(f.checked){
-                    this.eachItem(function(item){
-                        if (item !== f){
-                            item.setValue(false);
-                        }
-                    });
-                }
-            }
-        }else{
-            this.setValueForItem(id);
+    setValue: function(value) {
+        var me = this;
+        if (Ext.isObject(value)) {
+            Ext.Object.each(value, function(name, cbValue) {
+                var radios = Ext.form.RadioManager.getWithValue(name, cbValue);
+                radios.each(function(cb) {
+                    cb.setValue(true);
+                });
+            });
         }
         }
-    },
-    
-    setValueForItem : function(val){
-        val = String(val).split(',')[0];
-        this.eachItem(function(item){
-            item.setValue(val == item.inputValue);
-        });
-    },
-    
-    // private
-    fireChecked : function(){
-        if(!this.checkTask){
-            this.checkTask = new Ext.util.DelayedTask(this.bufferChecked, this);
-        }
-        this.checkTask.delay(10);
-    },
-    
-    // private
-    bufferChecked : function(){
-        var out = null;
-        this.eachItem(function(item){
-            if(item.checked){
-                out = item;
-                return false;
-            }
-        });
-        this.fireEvent('change', this, out);
-    },
-    
-    onDestroy : function(){
-        if(this.checkTask){
-            this.checkTask.cancel();
-            this.checkTask = null;
-        }
-        Ext.form.RadioGroup.superclass.onDestroy.call(this);
+        return me;
     }
     }
-
 });
 });
-
-Ext.reg('radiogroup', Ext.form.RadioGroup);
-</pre>    
+</pre>
 </body>
 </body>
-</html>
\ No newline at end of file
+</html>
Mirror of ExtJS by Sencha Inc. <http://www.sencha.com/>.