Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / Radio.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js"><div id="cls-Ext.form.Radio"></div>/**
10  * @class Ext.form.Radio
11  * @extends Ext.form.Checkbox
12  * Single radio field.  Same as Checkbox, but provided as a convenience for automatically setting the input type.
13  * Radio grouping is handled automatically by the browser if you give each radio in a group the same name.
14  * @constructor
15  * Creates a new Radio
16  * @param {Object} config Configuration options
17  * @xtype radio
18  */
19 Ext.form.Radio = Ext.extend(Ext.form.Checkbox, {
20     inputType: 'radio',
21
22     <div id="method-Ext.form.Radio-markInvalid"></div>/**
23      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
24      * @method
25      */
26     markInvalid : Ext.emptyFn,
27     <div id="method-Ext.form.Radio-clearInvalid"></div>/**
28      * Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
29      * @method
30      */
31     clearInvalid : Ext.emptyFn,
32
33     <div id="method-Ext.form.Radio-getGroupValue"></div>/**
34      * If this radio is part of a group, it will return the selected value
35      * @return {String}
36      */
37     getGroupValue : function(){
38         var p = this.el.up('form') || Ext.getBody();
39         var c = p.child('input[name='+this.el.dom.name+']:checked', true);
40         return c ? c.value : null;
41     },
42
43     // private
44     onClick : function(){
45         if(this.el.dom.checked != this.checked){
46                         var els = this.getCheckEl().select('input[name=' + this.el.dom.name + ']');
47                         els.each(function(el){
48                                 if(el.dom.id == this.id){
49                                         this.setValue(true);
50                                 }else{
51                                         Ext.getCmp(el.dom.id).setValue(false);
52                                 }
53                         }, this);
54                 }
55     },
56
57     <div id="method-Ext.form.Radio-setValue"></div>/**
58      * Sets either the checked/unchecked status of this Radio, or, if a string value
59      * is passed, checks a sibling Radio of the same name whose value is the value specified.
60      * @param value {String/Boolean} Checked value, or the value of the sibling radio button to check.
61      * @return {Ext.form.Field} this
62      */
63     setValue : function(v){
64         if (typeof v == 'boolean') {
65             Ext.form.Radio.superclass.setValue.call(this, v);
66         } else {
67             var r = this.getCheckEl().child('input[name=' + this.el.dom.name + '][value=' + v + ']', true);
68             if(r){
69                 Ext.getCmp(r.id).setValue(true);
70             }
71         }
72         return this;
73     },
74     
75     // private
76     getCheckEl: function(){
77         if(this.inGroup){
78             return this.el.up('.x-form-radio-group')
79         }
80         return this.el.up('form') || Ext.getBody();
81     }
82 });
83 Ext.reg('radio', Ext.form.Radio);
84 </pre>    \r
85 </body>\r
86 </html>