docs/symbols/Roo.menu.Item.html
[roojs1] / docs / symbols / Roo.menu.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.menu.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.menu.Item-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.menu.Item-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.menu.Item-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.menu.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                 <div class="inheritance res-block">
46                    <pre class="res-block-inner"><a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a>
47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.menu.Item 
48
49                    </pre>
50                 </div>
51        
52 <!-- ============================== class title / details ============================ -->
53     
54     
55     <h1 class="classTitle">
56                                 
57                                 Class Roo.menu.Item
58                         </h1>
59                         
60     <table cellspacing="0" class="class-summary-table">
61         
62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.menu</td></tr>
63         
64         <tr><td class="label">Defined In:</td><td class="hd-info">
65                         
66                                         <a href="./src/Roo_menu_Item.js.html">Roo/menu/Item.js</a>.
67                         
68         </td></tr>
69         <tr><td class="label">Class:</td><td class="hd-info">Item</td></tr>
70         
71         
72         
73         
74                 <tr><td class="label">Extends:</td><td class="hd-info">
75                         <a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a>
76         
77                 </td></tr>    
78         
79         
80     </table>
81
82     
83 <!-- ============================== class summary ========================== -->                        
84     <div class="description">
85         A base class for all menu items that require menu-related functionality (like sub-menus) and are not static<br/>display items.  Item extends the base functionality of {<b>link</b> Roo.menu.BaseItem} by adding menu-specific<br/>activation and click handling.
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.menu.Item';">[Add Your comment/notes about this class]</u>
94         <br/>
95         <iframe frameborder="0"  id="comments-Roo.menu" style="border: none;width:100%;" 
96                 src="/blog.php/GtkDjsComments/Roo.menu.Item.html"></iframe>
97 </div>
98         
99
100                 
101 <!-- ============================== config options ========================== -->                                               
102                  
103     
104     
105                 
106     <div class="hr"></div>
107     <a id="Roo.menu.Item-configs"></a>
108                 
109     
110      
111     
112         
113       <table cellspacing="0" class="member-table">   
114       <caption>Config Options (Usually are also Properties)</caption>
115     
116         
117         <tr>
118             <th class="sig-header" colspan="2">Options</th>
119             
120             <th class="msource-header">Defined By</th>
121         </tr>
122         
123         
124         
125         
126         
127                 <tr class="config-row expandable config-row-alt0 notInherited">
128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
129                     <td class="sig">
130
131                         <a id="Roo.menu.Item-cfg-canActivate" name=".canActivate"></a>
132                         <div class="fixedFont">
133                                 <b  class="itemname">canActivate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
134                                 
135                                 
136                         </div>
137                   
138                         <div class="mdesc">
139                             <div class="short">True if this item can be visually activated (defaults to true)</div> 
140                         </div>
141                         
142                         <div class="mdesc">
143                             <div class="long">True if this item can be visually activated (defaults to true)</div> 
144                         </div>
145                         
146                         
147
148                     </td>
149                     <td class="msource">
150                         
151                         Roo.menu.Item
152                                 
153                     </td>
154                 </tr>
155         
156         
157                 <tr class="config-row expandable config-row-alt1 notInherited">
158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
159                     <td class="sig">
160
161                         <a id="Roo.menu.Item-cfg-icon" name=".icon"></a>
162                         <div class="fixedFont">
163                                 <b  class="itemname">icon</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
164                                 
165                                 
166                         </div>
167                   
168                         <div class="mdesc">
169                             <div class="short">The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)</div> 
170                         </div>
171                         
172                         <div class="mdesc">
173                             <div class="long">The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)</div> 
174                         </div>
175                         
176                         
177
178                     </td>
179                     <td class="msource">
180                         
181                         Roo.menu.Item
182                                 
183                     </td>
184                 </tr>
185         
186         
187                 <tr class="config-row expandable config-row-alt0 notInherited">
188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
189                     <td class="sig">
190
191                         <a id="Roo.menu.Item-cfg-itemCls" name=".itemCls"></a>
192                         <div class="fixedFont">
193                                 <b  class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
194                                 
195                                 
196                         </div>
197                   
198                         <div class="mdesc">
199                             <div class="short">The default CSS class to use for menu items (defaults to "x-menu-item")</div> 
200                         </div>
201                         
202                         <div class="mdesc">
203                             <div class="long">The default CSS class to use for menu items (defaults to "x-menu-item")</div> 
204                         </div>
205                         
206                         
207
208                     </td>
209                     <td class="msource">
210                         
211                         Roo.menu.Item
212                                 
213                     </td>
214                 </tr>
215         
216         
217                 <tr class="config-row expandable config-row-alt1 notInherited">
218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
219                     <td class="sig">
220
221                         <a id="Roo.menu.Item-cfg-showDelay" name=".showDelay"></a>
222                         <div class="fixedFont">
223                                 <b  class="itemname">showDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
224                                 
225                                 
226                         </div>
227                   
228                         <div class="mdesc">
229                             <div class="short">Length of time in milliseconds to wait before showing this item (defaults to 200)</div> 
230                         </div>
231                         
232                         <div class="mdesc">
233                             <div class="long">Length of time in milliseconds to wait before showing this item (defaults to 200)</div> 
234                         </div>
235                         
236                         
237
238                     </td>
239                     <td class="msource">
240                         
241                         Roo.menu.Item
242                                 
243                     </td>
244                 </tr>
245         
246         
247     </table>
248                 
249   
250   
251   
252   
253   
254   
255   
256   
257   <!-- ============================== public properties ==================== -->        
258   
259   
260   
261     <a id="Roo.menu.Item-props"></a>      
262     
263     
264
265     
266     
267      <table cellspacing="0" class="member-table">
268       <caption class="Empty">Public Properties - Has None</caption>
269      </table>
270     
271     
272      
273     
274   <!-- ============================== methods summary / details ======================== -->
275   
276   
277   <a id="Roo.menu.Item-methods"></a>
278         <!-- constructor?? -->
279         
280         <!-- static's first 
281         
282         
283         -->
284         
285         <!-- then dynamics first -->
286         
287   
288   
289     
290     
291     
292       <table cellspacing="0" class="member-table">
293       <caption>Public Methods</caption>
294         <tr>
295             <th class="sig-header" colspan="2">Method</th>            
296             <th class="msource-header">Defined By</th>
297
298         </tr>
299         
300         
301         
302          
303         
304         
305           
306           <tr class="method-row config-row-alt0 expandable notInherited">
307             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
308            
309            
310             <td class="sig">
311                 <a id="Roo.menu-method-Item"   name=".Item"></a>
312                 <div class="fixedFont">
313                         <span class="attributes">new <B>Roo.menu.</B></span><b class="itemname">Item</b>
314                                 
315                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
316                         
317                                 
318                         
319                 </div>
320                 <div class="mdesc">
321                 
322                  
323                         <div class="short">Create a new Roo.menu.Item</div> 
324                  
325                  
326                     <div class="long">
327                         
328                         
329                         
330                                 Create a new Roo.menu.Item
331                         
332                         
333                                 <dl class="detailList">
334                                 <dt class="heading">Parameters:</dt>
335                                 
336                                         <dt>
337                                                 <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>
338                                                 
339                                         </dt>
340                                         <dd>Configuration options</dd>
341                                 
342                                 </dl>
343                         
344                         
345                         
346                         
347                         
348                         
349                         
350
351                     
352                     
353                      
354                     </div>                    
355                 </div>
356
357             </td>
358             <td class="msource">
359                 &nbsp;
360             </td>
361         </tr>
362         
363           
364           <tr class="method-row config-row-alt1 expandable notInherited">
365             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
366            
367            
368             <td class="sig">
369                 <a id="Roo.menu.Item-method-setText"   name=".setText"></a>
370                 <div class="fixedFont">
371                         <span class="attributes"></span><b class="itemname">setText</b>
372                                 
373                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>) 
374                         
375                                 
376                         
377                 </div>
378                 <div class="mdesc">
379                 
380                    <div class="short">Sets the text to display in this menu item</div> 
381                  
382                  
383                  
384                     <div class="long">
385                         
386                                 Sets the text to display in this menu item
387                     
388                                 
389                         
390                         
391                         
392                         
393                                 <dl class="detailList">
394                                 <dt class="heading">Parameters:</dt>
395                                 
396                                         <dt>
397                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>text</b>
398                                                 
399                                         </dt>
400                                         <dd>The text to display</dd>
401                                 
402                                 </dl>
403                         
404                         
405                         
406                         
407                         
408                         
409                         
410
411                     
412                     
413                      
414                     </div>                    
415                 </div>
416
417             </td>
418             <td class="msource">
419                 
420                         Roo.menu.Item
421                 &nbsp;
422             </td>
423         </tr>
424         
425                                                        
426     </table>
427
428   
429   <!-- ============================== events summary / details ======================== -->
430   
431   
432   <a id="Roo.menu.Item-events"></a>
433     
434   
435         
436    
437     
438      <table cellspacing="0" class="member-table">
439       <caption class="Empty">Events - Has None</caption>
440      </table>
441     
442     
443   
444     
445     
446   
447   
448   
449  
450 <!-- ============================== footer ================================= -->
451                 <div class="fineprint" style="clear:both">
452                         
453                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:43:13 GMT+0800 (HKT)
454                         Based on 
455                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
456                 </div>
457         </body>
458 </html>