X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/RadioGroup.html?ds=sidebyside diff --git a/docs/source/RadioGroup.html b/docs/source/RadioGroup.html index 27ef23ae..cf82f1fc 100644 --- a/docs/source/RadioGroup.html +++ b/docs/source/RadioGroup.html @@ -1,133 +1,119 @@ + - + The source code - - + + + + - -
/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
-
/** - * @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 + +
/**
+ * 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.</p>
+ *
+ * # 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, {
-    
/** - * @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', + + /** + * @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. */ -
/** - * @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 + /** + * @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, -
/** - * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails - * (defaults to 'You must select one item in this group') + /** + * @cfg {String} blankText Error text to display if the {@link #allowBlank} validation fails */ blankText : 'You must select one item in this group', - + // private - defaultType : 'radio', - + defaultType : 'radiofield', + // private - groupCls : 'x-form-radio-group', - -
/** - * @event change - * Fires when the state of a child radio changes. - * @param {Ext.form.RadioGroup} this - * @param {Ext.form.Radio} checked The checked radio - */ - -
/** - * 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]'); }, - -
/** - * 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 + + /** + * 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); -
+
- \ No newline at end of file +