sync
[roojs1] / docs / symbols / Roo.Toolbar.Item.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.Toolbar.Item</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.Toolbar.Item-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.Toolbar.Item-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.Toolbar.Item-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.Toolbar.Item-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 <!-- ============================== class title / details ============================ -->
46     
47     
48     <h1 class="classTitle">
49                                 
50                                 Class Roo.Toolbar.Item
51                         </h1>
52                         
53     <table cellspacing="0" class="class-summary-table">
54         
55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.Toolbar</td></tr>
56         
57         <tr><td class="label">Defined In:</td><td class="hd-info">
58                         
59                                         <a href="./src/Roo_Toolbar.js.html">Roo/Toolbar.js</a>.
60                         
61         </td></tr>
62         <tr><td class="label">Class:</td><td class="hd-info">Item</td></tr>
63         
64         
65         <tr><td class="label">Subclasses:</td><td class="hd-info">
66                 <a href="./Roo.Toolbar.Fill.html#constructor" roo:cls="Roo.Toolbar.Fill.html#constructor">Roo.Toolbar.Fill</a>, <a href="./Roo.Toolbar.Separator.html#constructor" roo:cls="Roo.Toolbar.Separator.html#constructor">Roo.Toolbar.Separator</a>, <a href="./Roo.Toolbar.Spacer.html#constructor" roo:cls="Roo.Toolbar.Spacer.html#constructor">Roo.Toolbar.Spacer</a>, <a href="./Roo.Toolbar.TextItem.html#constructor" roo:cls="Roo.Toolbar.TextItem.html#constructor">Roo.Toolbar.TextItem</a>
67
68         
69         
70         </td></tr>
71         
72         
73         
74     </table>
75
76     
77 <!-- ============================== class summary ========================== -->                        
78     <div class="description">
79         The base class that other classes should extend in order to get some basic common toolbar item functionality.
80     </div>
81
82         
83 <!-- ============================== Class comment block... ========================== -->                                       
84
85 <div class="comments">
86         <b>Class Comments / Notes</B> =>  
87         <u onclick="parent.CommentDialog.showCommentId = 'Roo.Toolbar.Item';">[Add Your comment/notes about this class]</u>
88         <br/>
89         <iframe frameborder="0"  id="comments-Roo.Toolbar" style="border: none;width:100%;" 
90                 src="/blog.php/GtkDjsComments/Roo.Toolbar.Item.html"></iframe>
91 </div>
92         
93
94                 
95 <!-- ============================== config options ========================== -->                                               
96                  
97     
98     
99                 
100     <div class="hr"></div>
101     <a id="Roo.Toolbar.Item-configs"></a>
102                 
103     
104     
105      <table cellspacing="0" class="member-table">
106       <caption class="Empty">Config Options - Has None</caption>
107      </table>
108     
109     
110      
111                 
112   
113   
114   
115   
116   
117   
118   
119   
120   <!-- ============================== public properties ==================== -->        
121   
122   
123   
124     <a id="Roo.Toolbar.Item-props"></a>      
125     
126     
127
128     
129     
130      <table cellspacing="0" class="member-table">
131       <caption class="Empty">Public Properties - Has None</caption>
132      </table>
133     
134     
135      
136     
137   <!-- ============================== methods summary / details ======================== -->
138   
139   
140   <a id="Roo.Toolbar.Item-methods"></a>
141         <!-- constructor?? -->
142         
143         <!-- static's first 
144         
145         
146         -->
147         
148         <!-- then dynamics first -->
149         
150   
151   
152     
153     
154     
155       <table cellspacing="0" class="member-table">
156       <caption>Public Methods</caption>
157         <tr>
158             <th class="sig-header" colspan="2">Method</th>            
159             <th class="msource-header">Defined By</th>
160
161         </tr>
162         
163         
164         
165          
166         
167         
168           
169           <tr class="method-row config-row-alt0 expandable notInherited">
170             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
171            
172            
173             <td class="sig">
174                 <a id="Roo.Toolbar-method-Item"   name=".Item"></a>
175                 <div class="fixedFont">
176                         <span class="attributes">new <B>Roo.Toolbar.</B></span><b class="itemname">Item</b>
177                                 
178                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>el</i></B>) 
179                         
180                                 
181                         
182                 </div>
183                 <div class="mdesc">
184                 
185                  
186                         <div class="short">Create a new Roo.Toolbar.Item</div> 
187                  
188                  
189                     <div class="long">
190                         
191                         
192                         
193                                 Create a new Roo.Toolbar.Item
194                         
195                         
196                                 <dl class="detailList">
197                                 <dt class="heading">Parameters:</dt>
198                                 
199                                         <dt>
200                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>el</b>
201                                                 
202                                         </dt>
203                                         <dd></dd>
204                                 
205                                 </dl>
206                         
207                         
208                         
209                         
210                         
211                         
212                         
213
214                     
215                     
216                      
217                     </div>                    
218                 </div>
219
220             </td>
221             <td class="msource">
222                 &nbsp;
223             </td>
224         </tr>
225         
226           
227           <tr class="method-row config-row-alt1 expandable notInherited">
228             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
229            
230            
231             <td class="sig">
232                 <a id="Roo.Toolbar.Item-method-destroy"   name=".destroy"></a>
233                 <div class="fixedFont">
234                         <span class="attributes"></span><b class="itemname">destroy</b>
235                                 
236                                  () 
237                         
238                                 
239                         
240                 </div>
241                 <div class="mdesc">
242                 
243                    <div class="short">Removes and destroys this item.</div> 
244                  
245                  
246                  
247                     <div class="long">
248                         
249                                 Removes and destroys this item.
250                     
251                                 
252                         
253                         
254                         
255                         
256                         
257                         
258                         
259                         
260                         
261                         
262
263                     
264                     
265                      
266                     </div>                    
267                 </div>
268
269             </td>
270             <td class="msource">
271                 
272                         Roo.Toolbar.Item
273                 &nbsp;
274             </td>
275         </tr>
276         
277           
278           <tr class="method-row config-row-alt0 expandable notInherited">
279             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
280            
281            
282             <td class="sig">
283                 <a id="Roo.Toolbar.Item-method-disable"   name=".disable"></a>
284                 <div class="fixedFont">
285                         <span class="attributes"></span><b class="itemname">disable</b>
286                                 
287                                  () 
288                         
289                                 
290                         
291                 </div>
292                 <div class="mdesc">
293                 
294                    <div class="short">Disables this item.</div> 
295                  
296                  
297                  
298                     <div class="long">
299                         
300                                 Disables this item.
301                     
302                                 
303                         
304                         
305                         
306                         
307                         
308                         
309                         
310                         
311                         
312                         
313
314                     
315                     
316                      
317                     </div>                    
318                 </div>
319
320             </td>
321             <td class="msource">
322                 
323                         Roo.Toolbar.Item
324                 &nbsp;
325             </td>
326         </tr>
327         
328           
329           <tr class="method-row config-row-alt1 expandable notInherited">
330             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
331            
332            
333             <td class="sig">
334                 <a id="Roo.Toolbar.Item-method-enable"   name=".enable"></a>
335                 <div class="fixedFont">
336                         <span class="attributes"></span><b class="itemname">enable</b>
337                                 
338                                  () 
339                         
340                                 
341                         
342                 </div>
343                 <div class="mdesc">
344                 
345                    <div class="short">Enables this item.</div> 
346                  
347                  
348                  
349                     <div class="long">
350                         
351                                 Enables this item.
352                     
353                                 
354                         
355                         
356                         
357                         
358                         
359                         
360                         
361                         
362                         
363                         
364
365                     
366                     
367                      
368                     </div>                    
369                 </div>
370
371             </td>
372             <td class="msource">
373                 
374                         Roo.Toolbar.Item
375                 &nbsp;
376             </td>
377         </tr>
378         
379           
380           <tr class="method-row config-row-alt0 expandable notInherited">
381             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
382            
383            
384             <td class="sig">
385                 <a id="Roo.Toolbar.Item-method-focus"   name=".focus"></a>
386                 <div class="fixedFont">
387                         <span class="attributes"></span><b class="itemname">focus</b>
388                                 
389                                  () 
390                         
391                                 
392                         
393                 </div>
394                 <div class="mdesc">
395                 
396                    <div class="short">Try to focus this item.</div> 
397                  
398                  
399                  
400                     <div class="long">
401                         
402                                 Try to focus this item.
403                     
404                                 
405                         
406                         
407                         
408                         
409                         
410                         
411                         
412                         
413                         
414                         
415
416                     
417                     
418                      
419                     </div>                    
420                 </div>
421
422             </td>
423             <td class="msource">
424                 
425                         Roo.Toolbar.Item
426                 &nbsp;
427             </td>
428         </tr>
429         
430           
431           <tr class="method-row config-row-alt1 expandable notInherited">
432             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
433            
434            
435             <td class="sig">
436                 <a id="Roo.Toolbar.Item-method-getEl"   name=".getEl"></a>
437                 <div class="fixedFont">
438                         <span class="attributes"></span><b class="itemname">getEl</b>
439                                 
440                                  () 
441                         
442                                 
443                                          : 
444                                         
445                                                 
446                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
447                                         
448                                         
449                                         
450                                 
451                         
452                 </div>
453                 <div class="mdesc">
454                 
455                    <div class="short">Get this item's HTML Element</div> 
456                  
457                  
458                  
459                     <div class="long">
460                         
461                                 Get this item's HTML Element
462                     
463                                 
464                         
465                         
466                         
467                         
468                         
469                         
470                         
471                         
472                                 <dl class="detailList">
473                                 <dt class="heading">Returns:</dt>
474                                 
475                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  </dd>
476                                 
477                                 </dl>
478                         
479                         
480                         
481
482                     
483                     
484                      
485                     </div>                    
486                 </div>
487
488             </td>
489             <td class="msource">
490                 
491                         Roo.Toolbar.Item
492                 &nbsp;
493             </td>
494         </tr>
495         
496           
497           <tr class="method-row config-row-alt0 expandable notInherited">
498             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
499            
500            
501             <td class="sig">
502                 <a id="Roo.Toolbar.Item-method-hide"   name=".hide"></a>
503                 <div class="fixedFont">
504                         <span class="attributes"></span><b class="itemname">hide</b>
505                                 
506                                  () 
507                         
508                                 
509                         
510                 </div>
511                 <div class="mdesc">
512                 
513                    <div class="short">Hides this item.</div> 
514                  
515                  
516                  
517                     <div class="long">
518                         
519                                 Hides this item.
520                     
521                                 
522                         
523                         
524                         
525                         
526                         
527                         
528                         
529                         
530                         
531                         
532
533                     
534                     
535                      
536                     </div>                    
537                 </div>
538
539             </td>
540             <td class="msource">
541                 
542                         Roo.Toolbar.Item
543                 &nbsp;
544             </td>
545         </tr>
546         
547           
548           <tr class="method-row config-row-alt1 expandable notInherited">
549             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
550            
551            
552             <td class="sig">
553                 <a id="Roo.Toolbar.Item-method-setVisible"   name=".setVisible"></a>
554                 <div class="fixedFont">
555                         <span class="attributes"></span><b class="itemname">setVisible</b>
556                                 
557                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>) 
558                         
559                                 
560                         
561                 </div>
562                 <div class="mdesc">
563                 
564                    <div class="short">Convenience function for boolean show/hide.</div> 
565                  
566                  
567                  
568                     <div class="long">
569                         
570                                 Convenience function for boolean show/hide.
571                     
572                                 
573                         
574                         
575                         
576                         
577                                 <dl class="detailList">
578                                 <dt class="heading">Parameters:</dt>
579                                 
580                                         <dt>
581                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>visible</b>
582                                                 
583                                         </dt>
584                                         <dd>true to show/false to hide</dd>
585                                 
586                                 </dl>
587                         
588                         
589                         
590                         
591                         
592                         
593                         
594
595                     
596                     
597                      
598                     </div>                    
599                 </div>
600
601             </td>
602             <td class="msource">
603                 
604                         Roo.Toolbar.Item
605                 &nbsp;
606             </td>
607         </tr>
608         
609           
610           <tr class="method-row config-row-alt0 expandable notInherited">
611             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
612            
613            
614             <td class="sig">
615                 <a id="Roo.Toolbar.Item-method-show"   name=".show"></a>
616                 <div class="fixedFont">
617                         <span class="attributes"></span><b class="itemname">show</b>
618                                 
619                                  () 
620                         
621                                 
622                         
623                 </div>
624                 <div class="mdesc">
625                 
626                    <div class="short">Shows this item.</div> 
627                  
628                  
629                  
630                     <div class="long">
631                         
632                                 Shows this item.
633                     
634                                 
635                         
636                         
637                         
638                         
639                         
640                         
641                         
642                         
643                         
644                         
645
646                     
647                     
648                      
649                     </div>                    
650                 </div>
651
652             </td>
653             <td class="msource">
654                 
655                         Roo.Toolbar.Item
656                 &nbsp;
657             </td>
658         </tr>
659         
660                                                        
661     </table>
662
663   
664   <!-- ============================== events summary / details ======================== -->
665   
666   
667   <a id="Roo.Toolbar.Item-events"></a>
668     
669   
670         
671    
672     
673      <table cellspacing="0" class="member-table">
674       <caption class="Empty">Events - Has None</caption>
675      </table>
676     
677     
678   
679     
680     
681   
682   
683   
684  
685 <!-- ============================== footer ================================= -->
686                 <div class="fineprint" style="clear:both">
687                         
688                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
689                         Based on 
690                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
691                 </div>
692         </body>
693 </html>