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