docs/symbols/Roo.form.Radio.html
[roojs1] / docs / symbols / Roo.form.Radio.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
3
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
6         <head>
7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8                 <meta name="generator" content="JsDoc Toolkit" />
9                 
10                 
11                 <title>JsDoc Reference - Roo.form.Radio</title>
12                 
13                 
14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
15         <link rel="stylesheet" type="text/css" href="../default.css" />
16         
17         
18         <script type="text/javascript" src="../page.js">
19         
20         </script>
21          
22                 
23         </head>
24
25         <body onload="RooDocsPage.onload();">
26          
27         
28 <div class="body-wrap">
29
30     <!-- ============================== links to methods. ================================= --> 
31
32     <div class="top-tools">
33     <!--
34         <a class="inner-link" href="#Roo.form.Radio-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.form.Radio-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.form.Radio-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.form.Radio-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
39         -->
40     </div>
41
42     
43 <!-- ============================== inheritance Block. ================================= -->    
44         
45                 <div class="inheritance res-block">
46                    <pre class="res-block-inner"><a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>
47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Radio 
48
49                    </pre>
50                 </div>
51        
52 <!-- ============================== class title / details ============================ -->
53     
54     
55     <h1 class="classTitle">
56                                 
57                                 Class Roo.form.Radio
58                         </h1>
59                         
60     <table cellspacing="0" class="class-summary-table">
61         
62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
63         
64         <tr><td class="label">Defined In:</td><td class="hd-info">
65                         
66                                         <a href="./src/Roo_form_Radio.js.html">Roo/form/Radio.js</a>.
67                         
68         </td></tr>
69         <tr><td class="label">Class:</td><td class="hd-info">Radio</td></tr>
70         
71         
72         
73         
74                 <tr><td class="label">Extends:</td><td class="hd-info">
75                         <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>
76         
77                 </td></tr>    
78         
79         
80     </table>
81
82     
83 <!-- ============================== class summary ========================== -->                        
84     <div class="description">
85         Single radio field.  Same as Checkbox, but provided as a convenience for automatically setting the input type.<br/>Radio grouping is handled automatically by the browser if you give each radio in a group the same name.
86     </div>
87
88         
89 <!-- ============================== Class comment block... ========================== -->                                       
90
91 <div class="comments">
92         <b>Class Comments / Notes</B> =>  
93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Radio';">[Add Your comment/notes about this class]</u>
94         <br/>
95         <iframe frameborder="0"  id="comments-Roo.form" style="border: none;width:100%;" 
96                 src="/blog.php/GtkDjsComments/Roo.form.Radio.html"></iframe>
97 </div>
98         
99
100                 
101 <!-- ============================== config options ========================== -->                                               
102                  
103     
104     
105                 
106     <div class="hr"></div>
107     <a id="Roo.form.Radio-configs"></a>
108                 
109     
110     
111      <table cellspacing="0" class="member-table">
112       <caption class="Empty">Config Options - Has None</caption>
113      </table>
114     
115     
116      
117                 
118   
119   
120   
121   
122   
123   
124   
125   
126   <!-- ============================== public properties ==================== -->        
127   
128   
129   
130     <a id="Roo.form.Radio-props"></a>      
131     
132     
133
134     
135     
136      <table cellspacing="0" class="member-table">
137       <caption class="Empty">Public Properties - Has None</caption>
138      </table>
139     
140     
141      
142     
143   <!-- ============================== methods summary / details ======================== -->
144   
145   
146   <a id="Roo.form.Radio-methods"></a>
147         <!-- constructor?? -->
148         
149         <!-- static's first 
150         
151         
152         -->
153         
154         <!-- then dynamics first -->
155         
156   
157   
158     
159     
160     
161       <table cellspacing="0" class="member-table">
162       <caption>Public Methods</caption>
163         <tr>
164             <th class="sig-header" colspan="2">Method</th>            
165             <th class="msource-header">Defined By</th>
166
167         </tr>
168         
169         
170         
171          
172         
173         
174           
175           <tr class="method-row config-row-alt0 expandable notInherited">
176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
177            
178            
179             <td class="sig">
180                 <a id="Roo.form-method-Radio"   name=".Radio"></a>
181                 <div class="fixedFont">
182                         <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Radio</b>
183                                 
184                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
185                         
186                                 
187                         
188                 </div>
189                 <div class="mdesc">
190                 
191                  
192                         <div class="short">Create a new Roo.form.Radio</div> 
193                  
194                  
195                     <div class="long">
196                         
197                         
198                         
199                                 Create a new Roo.form.Radio
200                         
201                         
202                                 <dl class="detailList">
203                                 <dt class="heading">Parameters:</dt>
204                                 
205                                         <dt>
206                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
207                                                 
208                                         </dt>
209                                         <dd>Configuration options</dd>
210                                 
211                                 </dl>
212                         
213                         
214                         
215                         
216                         
217                         
218                         
219
220                     
221                     
222                      
223                     </div>                    
224                 </div>
225
226             </td>
227             <td class="msource">
228                 &nbsp;
229             </td>
230         </tr>
231         
232           
233           <tr class="method-row config-row-alt1 expandable notInherited">
234             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
235            
236            
237             <td class="sig">
238                 <a id="Roo.form.Radio-method-getGroupValue"   name=".getGroupValue"></a>
239                 <div class="fixedFont">
240                         <span class="attributes"></span><b class="itemname">getGroupValue</b>
241                                 
242                                  () 
243                         
244                                 
245                                          : 
246                                         
247                                                 
248                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
249                                         
250                                         
251                                         
252                                 
253                         
254                 </div>
255                 <div class="mdesc">
256                 
257                    <div class="short">If this radio is part of a group, it will return the selected value</div> 
258                  
259                  
260                  
261                     <div class="long">
262                         
263                                 If this radio is part of a group, it will return the selected value
264                     
265                                 
266                         
267                         
268                         
269                         
270                         
271                         
272                         
273                         
274                                 <dl class="detailList">
275                                 <dt class="heading">Returns:</dt>
276                                 
277                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
278                                 
279                                 </dl>
280                         
281                         
282                         
283
284                     
285                     
286                      
287                     </div>                    
288                 </div>
289
290             </td>
291             <td class="msource">
292                 
293                         Roo.form.Radio
294                 &nbsp;
295             </td>
296         </tr>
297         
298                                                        
299     </table>
300
301   
302   <!-- ============================== events summary / details ======================== -->
303   
304   
305   <a id="Roo.form.Radio-events"></a>
306     
307   
308         
309    
310     
311      <table cellspacing="0" class="member-table">
312       <caption class="Empty">Events - Has None</caption>
313      </table>
314     
315     
316   
317     
318     
319   
320   
321   
322  
323 <!-- ============================== footer ================================= -->
324                 <div class="fineprint" style="clear:both">
325                         
326                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:27 GMT+0800 (HKT)
327                         Based on 
328                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
329                 </div>
330         </body>
331 </html>