docs/symbols/Roo.XComponent.html
[roojs1] / docs / symbols / Roo.XComponent.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.XComponent</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.XComponent-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.XComponent-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.XComponent-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.XComponent-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">Roo.data.Observable
47
48 A delayed Element creator...
49
50 Mypart.xyx = new Roo.XComponent({
51
52     parent : 'Mypart.xyz', // empty == document.element.!!
53     order : '001',
54     name : 'xxxx'
55     region : 'xxxx'
56     disabled : function() {} 
57      
58     items : [  // technically only one component..
59         {
60             xtype : 'NestedLayoutPanel',
61             // technicall
62         }
63      ]
64 })
65 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.XComponent 
66
67                    </pre>
68                 </div>
69        
70 <!-- ============================== class title / details ============================ -->
71     
72     
73     <h1 class="classTitle">
74                                 
75                                 Class Roo.XComponent
76                         </h1>
77                         
78     <table cellspacing="0" class="class-summary-table">
79         
80                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
81         
82         <tr><td class="label">Defined In:</td><td class="hd-info">
83                         
84                                         <a href="./src/Roo_Document.js.html">Roo/Document.js</a>.
85                         
86         </td></tr>
87         <tr><td class="label">Class:</td><td class="hd-info">XComponent</td></tr>
88         
89         
90         
91         
92                 <tr><td class="label">Extends:</td><td class="hd-info">
93                         Roo.data.Observable
94
95 A delayed Element creator...
96
97 Mypart.xyx = new Roo.XComponent({
98
99     parent : 'Mypart.xyz', // empty == document.element.!!
100     order : '001',
101     name : 'xxxx'
102     region : 'xxxx'
103     disabled : function() {} 
104      
105     items : [  // technically only one component..
106         {
107             xtype : 'NestedLayoutPanel',
108             // technicall
109         }
110      ]
111 })
112         
113                 </td></tr>    
114         
115         
116     </table>
117
118     
119 <!-- ============================== class summary ========================== -->                        
120     <div class="description">
121         This needs some more thought..
122     </div>
123
124         
125 <!-- ============================== Class comment block... ========================== -->                                       
126
127 <div class="comments">
128         <b>Class Comments / Notes</B> =>  
129         <u onclick="parent.CommentDialog.showCommentId = 'Roo.XComponent';">[Add Your comment/notes about this class]</u>
130         <br/>
131         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;" 
132                 src="/blog.php/GtkDjsComments/Roo.XComponent.html"></iframe>
133 </div>
134         
135
136                 
137 <!-- ============================== config options ========================== -->                                               
138                  
139     
140     
141                 
142     <div class="hr"></div>
143     <a id="Roo.XComponent-configs"></a>
144                 
145     
146     
147      <table cellspacing="0" class="member-table">
148       <caption class="Empty">Config Options - Has None</caption>
149      </table>
150     
151     
152      
153                 
154   
155   
156   
157   
158   
159   
160   
161   
162   <!-- ============================== public properties ==================== -->        
163   
164   
165   
166     <a id="Roo.XComponent-props"></a>      
167     
168     
169
170     
171     
172      <table cellspacing="0" class="member-table">
173       <caption class="Empty">Public Properties - Has None</caption>
174      </table>
175     
176     
177      
178     
179   <!-- ============================== methods summary / details ======================== -->
180   
181   
182   <a id="Roo.XComponent-methods"></a>
183         <!-- constructor?? -->
184         
185         <!-- static's first 
186         
187         
188         -->
189         
190         <!-- then dynamics first -->
191         
192   
193   
194     
195     
196     
197       <table cellspacing="0" class="member-table">
198       <caption>Public Methods</caption>
199         <tr>
200             <th class="sig-header" colspan="2">Method</th>            
201             <th class="msource-header">Defined By</th>
202
203         </tr>
204         
205         
206         
207          
208         
209         
210           
211           <tr class="method-row config-row-alt0 notInherited">
212             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
213            
214            
215             <td class="sig">
216                 <a id="Roo-method-XComponent"   name=".XComponent"></a>
217                 <div class="fixedFont">
218                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
219                                 
220                                  () 
221                         
222                                 
223                         
224                 </div>
225                 <div class="mdesc">
226                 
227                  
228                         <div class="short">Create a new Roo.XComponent</div> 
229                  
230                  
231                     <div class="long">
232                         
233                         
234                         
235                                 Create a new Roo.XComponent
236                         
237                         
238                         
239                         
240                         
241                         
242                         
243                         
244
245                     
246                     
247                      
248                     </div>                    
249                 </div>
250
251             </td>
252             <td class="msource">
253                 &nbsp;
254             </td>
255         </tr>
256         
257                                                        
258     </table>
259
260   
261   <!-- ============================== events summary / details ======================== -->
262   
263   
264   <a id="Roo.XComponent-events"></a>
265     
266   
267         
268    
269   
270     
271     
272     
273       <table cellspacing="0" class="member-table">
274                 <caption>Events</caption>
275               <thead>
276                 <tr>
277                     <th class="sig-header" colspan="2">Event</th>            
278                     <th class="msource-header">Defined By</th>
279
280                 </tr>
281               </thead>  
282         
283         
284          
285         
286         
287           <tr class="method-row expandable config-row-alt0 notInherited">
288             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
289             
290             <td class="sig">
291                 <a id="Roo.XComponent-event-*buildcomplete"></a>
292                 
293                <div class="fixedFont">
294                 <b class="itemname">buildcomplete</b> (<a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a> <B><i>c</i></B>) 
295                 
296                 </div>
297
298                 <div class="mdesc">
299
300                    <div class="short">Fires on the top level element when all elements have been built
301                    
302                 </div> 
303                     
304                     <div class="long">
305                     
306                         Fires on the top level element when all elements have been built
307                     
308                         
309                         
310                 
311                         
312                                 <dl class="detailList">
313                                 <dt class="heading">Parameters:</dt>
314                                 
315                                         <dt>
316                                                 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
317                                                 
318                                         </dt>
319                                         <dd>the top level component.</dd>
320                                 
321                                 </dl>
322                         
323                         
324                         
325                         
326                         
327                         
328                         
329
330                     
331                     
332                      
333                     </div>                    
334                 </div>
335
336             </td>
337             <td class="msource">
338                 Roo.XComponent
339             </td>
340         </tr>
341         
342           <tr class="method-row expandable config-row-alt1 notInherited">
343             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
344             
345             <td class="sig">
346                 <a id="Roo.XComponent-event-*built"></a>
347                 
348                <div class="fixedFont">
349                 <b class="itemname">built</b> (<a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a> <B><i>c</i></B>) 
350                 
351                 </div>
352
353                 <div class="mdesc">
354
355                    <div class="short">Fires when this the componnt is built
356                    
357                 </div> 
358                     
359                     <div class="long">
360                     
361                         Fires when this the componnt is built
362                     
363                         
364                         
365                 
366                         
367                                 <dl class="detailList">
368                                 <dt class="heading">Parameters:</dt>
369                                 
370                                         <dt>
371                                                 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
372                                                 
373                                         </dt>
374                                         <dd>the component</dd>
375                                 
376                                 </dl>
377                         
378                         
379                         
380                         
381                         
382                         
383                         
384
385                     
386                     
387                      
388                     </div>                    
389                 </div>
390
391             </td>
392             <td class="msource">
393                 Roo.XComponent
394             </td>
395         </tr>
396         
397                                                        
398     </table>
399
400   
401   
402   
403  
404 <!-- ============================== footer ================================= -->
405                 <div class="fineprint" style="clear:both">
406                         
407                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Thu Jul 22 2010 10:38:33 GMT+0800 (HKT)
408                         Based on 
409                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
410                 </div>
411         </body>
412 </html>