a054ebbcc9984515c6a3aa641d2c6512d5bf15b4
[roojs1] / docs / symbols / Roo.MasterTemplate.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.MasterTemplate</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.MasterTemplate-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.MasterTemplate-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.MasterTemplate-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.MasterTemplate-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.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.MasterTemplate 
48
49                    </pre>
50                 </div>
51        
52 <!-- ============================== class title / details ============================ -->
53     
54     
55     <h1 class="classTitle">
56                                 
57                                 Class Roo.MasterTemplate
58                         </h1>
59                         
60     <table cellspacing="0" class="class-summary-table">
61         
62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
63         
64         <tr><td class="label">Defined In:</td><td class="hd-info">
65                         
66                                         <a href="./src/Roo_MasterTemplate.js.html">Roo/MasterTemplate.js</a>.
67                         
68         </td></tr>
69         <tr><td class="label">Class:</td><td class="hd-info">MasterTemplate</td></tr>
70         
71         
72         
73         
74                 <tr><td class="label">Extends:</td><td class="hd-info">
75                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
76         
77                 </td></tr>    
78         
79         
80     </table>
81
82     
83 <!-- ============================== class summary ========================== -->                        
84     <div class="description">
85         Provides a template that can have child templates. The syntax is:<br/><pre><code><br/>var t = new Roo.MasterTemplate(<br/>      '&lt;select name="{name}"&gt;',<br/>            '&lt;tpl name="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;',<br/>     '&lt;/select&gt;'<br/>);<br/>t.add('options', {value: 'foo', text: 'bar'});<br/>// or you can add multiple child elements in one shot<br/>t.addAll('options', [<br/>    {value: 'foo', text: 'bar'},<br/>    {value: 'foo2', text: 'bar2'},<br/>    {value: 'foo3', text: 'bar3'}<br/>]);<br/>// then append, applying the master template values<br/>t.append('my-form', {name: 'my-select'});<br/></code></pre><br/>A name attribute for the child template is not required if you have only one child<br/>template or you want to refer to them by index.
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.MasterTemplate';">[Add Your comment/notes about this class]</u>
94         <br/>
95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;" 
96                 src="/blog.php/GtkDjsComments/Roo.MasterTemplate.html"></iframe>
97 </div>
98         
99
100                 
101 <!-- ============================== config options ========================== -->                                               
102                  
103     
104     
105                 
106     <div class="hr"></div>
107     <a id="Roo.MasterTemplate-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">
128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
129                     <td class="sig">
130
131                         <a id="Roo.Template-cfg-html" name=".html"></a>
132                         <div class="fixedFont">
133                                 <b  class="itemname">html</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
134                                 
135                                 
136                         </div>
137                   
138                         <div class="mdesc">
139                             <div class="short">The HTML fragment or an array of fragments to join("") or multiple arguments to join("")</div> 
140                         </div>
141                         
142                         <div class="mdesc">
143                             <div class="long">The HTML fragment or an array of fragments to join("") or multiple arguments to join("")</div> 
144                         </div>
145                         
146                         
147
148                     </td>
149                     <td class="msource">
150                         
151                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
152                                 
153                     </td>
154                 </tr>
155         
156         
157                 <tr class="config-row expandable config-row-alt1">
158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
159                     <td class="sig">
160
161                         <a id="Roo.Template-cfg-url" name=".url"></a>
162                         <div class="fixedFont">
163                                 <b  class="itemname">url</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 Url to load the template from.</div> 
170                         </div>
171                         
172                         <div class="mdesc">
173                             <div class="long">The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..<br/>                   it should be fixed so that template is observable...</div> 
174                         </div>
175                         
176                         
177
178                     </td>
179                     <td class="msource">
180                         
181                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
182                                 
183                     </td>
184                 </tr>
185         
186         
187     </table>
188                 
189   
190   
191   
192   
193   
194   
195   
196   
197   <!-- ============================== public properties ==================== -->        
198   
199   
200   
201     <a id="Roo.MasterTemplate-props"></a>      
202     
203     
204
205     
206     
207      <table cellspacing="0" class="member-table">
208       <caption class="Empty">Public Properties - Has None</caption>
209      </table>
210     
211     
212      
213     
214   <!-- ============================== methods summary / details ======================== -->
215   
216   
217   <a id="Roo.MasterTemplate-methods"></a>
218         <!-- constructor?? -->
219         
220         <!-- static's first 
221         
222         
223         -->
224         
225         <!-- then dynamics first -->
226         
227   
228   
229     
230     
231     
232       <table cellspacing="0" class="member-table">
233       <caption>Public Methods</caption>
234         <tr>
235             <th class="sig-header" colspan="2">Method</th>            
236             <th class="msource-header">Defined By</th>
237
238         </tr>
239         
240         
241         
242          
243         
244         
245           
246           <tr class="method-row config-row-alt0 notInherited">
247             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
248            
249            
250             <td class="sig">
251                 <a id="Roo-method-MasterTemplate"   name=".MasterTemplate"></a>
252                 <div class="fixedFont">
253                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">MasterTemplate</b>
254                                 
255                                  () 
256                         
257                                 
258                         
259                 </div>
260                 <div class="mdesc">
261                 
262                  
263                         <div class="short">Create a new Roo.MasterTemplate</div> 
264                  
265                  
266                     <div class="long">
267                         
268                         
269                         
270                                 Create a new Roo.MasterTemplate
271                         
272                         
273                         
274                         
275                         
276                         
277                         
278                         
279
280                     
281                     
282                      
283                     </div>                    
284                 </div>
285
286             </td>
287             <td class="msource">
288                 &nbsp;
289             </td>
290         </tr>
291         
292           
293           <tr class="method-row config-row-alt1 expandable notInherited">
294             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
295            
296            
297             <td class="sig">
298                 <a id="Roo.MasterTemplate-method-from"   name=".from"></a>
299                 <div class="fixedFont">
300                         <span class="attributes">Roo.MasterTemplate.</span><b class="itemname">from</b>
301                                 
302                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>) 
303                         
304                                 
305                         
306                 </div>
307                 <div class="mdesc">
308                 
309                    <div class="short">Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.</div> 
310                  
311                  
312                  
313                     <div class="long">
314                         
315                                 Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g.<br/>var tpl = Roo.MasterTemplate.from('element-id');
316                     
317                                 
318                         
319                         
320                         
321                         
322                                 <dl class="detailList">
323                                 <dt class="heading">Parameters:</dt>
324                                 
325                                         <dt>
326                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
327                                                 
328                                         </dt>
329                                         <dd></dd>
330                                 
331                                         <dt>
332                                                 <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>
333                                                 
334                                         </dt>
335                                         <dd></dd>
336                                 
337                                 </dl>
338                         
339                         
340                         
341                         
342                         
343                         
344                         
345
346                     
347                     
348                      
349                     </div>                    
350                 </div>
351
352             </td>
353             <td class="msource">
354                 
355                         Roo.MasterTemplate
356                 &nbsp;
357             </td>
358         </tr>
359         
360           
361           <tr class="method-row config-row-alt0 expandable notInherited">
362             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
363            
364            
365             <td class="sig">
366                 <a id="Roo.MasterTemplate-method-add"   name=".add"></a>
367                 <div class="fixedFont">
368                         <span class="attributes"></span><b class="itemname">add</b>
369                                 
370                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>name</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>) 
371                         
372                                 
373                                          : 
374                                         
375                                                 
376                                                 MasterTemplate
377                                         
378                                         
379                                         
380                                 
381                         
382                 </div>
383                 <div class="mdesc">
384                 
385                    <div class="short">Applies the passed values to a child template.</div> 
386                  
387                  
388                  
389                     <div class="long">
390                         
391                                 Applies the passed values to a child template.
392                     
393                                 
394                         
395                         
396                         
397                         
398                                 <dl class="detailList">
399                                 <dt class="heading">Parameters:</dt>
400                                 
401                                         <dt>
402                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>name</b>
403                                                 
404                                         </dt>
405                                         <dd>(optional) The name or index of the child template</dd>
406                                 
407                                         <dt>
408                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span>  <b>values</b>
409                                                 
410                                         </dt>
411                                         <dd>The values to be applied to the template</dd>
412                                 
413                                 </dl>
414                         
415                         
416                         
417                         
418                         
419                                 <dl class="detailList">
420                                 <dt class="heading">Returns:</dt>
421                                 
422                                         <dd><span class="fixedFont">MasterTemplate</span>  this</dd>
423                                 
424                                 </dl>
425                         
426                         
427                         
428
429                     
430                     
431                      
432                     </div>                    
433                 </div>
434
435             </td>
436             <td class="msource">
437                 
438                         Roo.MasterTemplate
439                 &nbsp;
440             </td>
441         </tr>
442         
443           
444           <tr class="method-row config-row-alt1 expandable notInherited">
445             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
446            
447            
448             <td class="sig">
449                 <a id="Roo.MasterTemplate-method-addAll"   name=".addAll"></a>
450                 <div class="fixedFont">
451                         <span class="attributes"></span><b class="itemname">addAll</b>
452                                 
453                                  () 
454                         
455                                 
456                         
457                 </div>
458                 <div class="mdesc">
459                 
460                    <div class="short">Alias for fill().</div> 
461                  
462                  
463                  
464                     <div class="long">
465                         
466                                 Alias for fill().
467                     
468                                 
469                         
470                         
471                         
472                         
473                         
474                         
475                         
476                         
477                         
478                         
479
480                     
481                     
482                      
483                     </div>                    
484                 </div>
485
486             </td>
487             <td class="msource">
488                 
489                         Roo.MasterTemplate
490                 &nbsp;
491             </td>
492         </tr>
493         
494           
495           <tr class="method-row config-row-alt0 expandable">
496             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
497            
498            
499             <td class="sig">
500                 <a id="Roo.Template-method-append"   name=".append"></a>
501                 <div class="fixedFont">
502                         <span class="attributes"></span><b class="itemname">append</b>
503                                 
504                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>returnElement</i></B>) 
505                         
506                                 
507                                          : 
508                                         
509                                                 
510                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
511                                         
512                                         
513                                         
514                                 
515                         
516                 </div>
517                 <div class="mdesc">
518                 
519                    <div class="short">Applies the supplied values to the template and appends the new node(s) to el.</div> 
520                  
521                  
522                  
523                     <div class="long">
524                         
525                                 Applies the supplied values to the template and appends the new node(s) to el.
526                     
527                                 
528                         
529                         
530                         
531                         
532                                 <dl class="detailList">
533                                 <dt class="heading">Parameters:</dt>
534                                 
535                                         <dt>
536                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
537                                                 
538                                         </dt>
539                                         <dd>The context element</dd>
540                                 
541                                         <dt>
542                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
543                                                 
544                                         </dt>
545                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
546                                 
547                                         <dt>
548                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>returnElement</b>
549                                                 
550                                         </dt>
551                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
552                                 
553                                 </dl>
554                         
555                         
556                         
557                         
558                         
559                                 <dl class="detailList">
560                                 <dt class="heading">Returns:</dt>
561                                 
562                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element</span>  The new node or Element</dd>
563                                 
564                                 </dl>
565                         
566                         
567                         
568
569                     
570                     
571                      
572                     </div>                    
573                 </div>
574
575             </td>
576             <td class="msource">
577                 
578                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
579                 &nbsp;
580             </td>
581         </tr>
582         
583           
584           <tr class="method-row config-row-alt1 expandable">
585             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
586            
587            
588             <td class="sig">
589                 <a id="Roo.Template-method-apply"   name=".apply"></a>
590                 <div class="fixedFont">
591                         <span class="attributes"></span><b class="itemname">apply</b>
592                                 
593                                  () 
594                         
595                                 
596                         
597                 </div>
598                 <div class="mdesc">
599                 
600                    <div class="short">Alias for {<b>link</b> <b>applyTemplate</b>}</div> 
601                  
602                  
603                  
604                     <div class="long">
605                         
606                                 Alias for {<b>link</b> <b>applyTemplate</b>}
607                     
608                                 
609                         
610                         
611                         
612                         
613                         
614                         
615                         
616                         
617                         
618                         
619
620                     
621                     
622                      
623                     </div>                    
624                 </div>
625
626             </td>
627             <td class="msource">
628                 
629                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
630                 &nbsp;
631             </td>
632         </tr>
633         
634           
635           <tr class="method-row config-row-alt0 expandable">
636             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
637            
638            
639             <td class="sig">
640                 <a id="Roo.Template-method-applyTemplate"   name=".applyTemplate"></a>
641                 <div class="fixedFont">
642                         <span class="attributes"></span><b class="itemname">applyTemplate</b>
643                                 
644                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>) 
645                         
646                                 
647                                          : 
648                                         
649                                                 
650                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
651                                         
652                                         
653                                         
654                                 
655                         
656                 </div>
657                 <div class="mdesc">
658                 
659                    <div class="short">Returns an HTML fragment of this template with the specified values applied.</div> 
660                  
661                  
662                  
663                     <div class="long">
664                         
665                                 Returns an HTML fragment of this template with the specified values applied.
666                     
667                                 
668                         
669                         
670                         
671                         
672                                 <dl class="detailList">
673                                 <dt class="heading">Parameters:</dt>
674                                 
675                                         <dt>
676                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
677                                                 
678                                         </dt>
679                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
680                                 
681                                 </dl>
682                         
683                         
684                         
685                         
686                         
687                                 <dl class="detailList">
688                                 <dt class="heading">Returns:</dt>
689                                 
690                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The HTML fragment</dd>
691                                 
692                                 </dl>
693                         
694                         
695                         
696
697                     
698                     
699                      
700                     </div>                    
701                 </div>
702
703             </td>
704             <td class="msource">
705                 
706                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
707                 &nbsp;
708             </td>
709         </tr>
710         
711           
712           <tr class="method-row config-row-alt1 expandable">
713             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
714            
715            
716             <td class="sig">
717                 <a id="Roo.Template-method-compile"   name=".compile"></a>
718                 <div class="fixedFont">
719                         <span class="attributes"></span><b class="itemname">compile</b>
720                                 
721                                  () 
722                         
723                                 
724                                          : 
725                                         
726                                                 
727                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
728                                         
729                                         
730                                         
731                                 
732                         
733                 </div>
734                 <div class="mdesc">
735                 
736                    <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div> 
737                  
738                  
739                  
740                     <div class="long">
741                         
742                                 Compiles the template into an internal function, eliminating the RegEx overhead.
743                     
744                                 
745                         
746                         
747                         
748                         
749                         
750                         
751                         
752                         
753                                 <dl class="detailList">
754                                 <dt class="heading">Returns:</dt>
755                                 
756                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
757                                 
758                                 </dl>
759                         
760                         
761                         
762
763                     
764                     
765                      
766                     </div>                    
767                 </div>
768
769             </td>
770             <td class="msource">
771                 
772                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
773                 &nbsp;
774             </td>
775         </tr>
776         
777           
778           <tr class="method-row config-row-alt0 expandable notInherited">
779             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
780            
781            
782             <td class="sig">
783                 <a id="Roo.MasterTemplate-method-fill"   name=".fill"></a>
784                 <div class="fixedFont">
785                         <span class="attributes"></span><b class="itemname">fill</b>
786                                 
787                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>name</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>values</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>reset</i></B>) 
788                         
789                                 
790                                          : 
791                                         
792                                                 
793                                                 MasterTemplate
794                                         
795                                         
796                                         
797                                 
798                         
799                 </div>
800                 <div class="mdesc">
801                 
802                    <div class="short">Applies all the passed values to a child template.</div> 
803                  
804                  
805                  
806                     <div class="long">
807                         
808                                 Applies all the passed values to a child template.
809                     
810                                 
811                         
812                         
813                         
814                         
815                                 <dl class="detailList">
816                                 <dt class="heading">Parameters:</dt>
817                                 
818                                         <dt>
819                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>name</b>
820                                                 
821                                         </dt>
822                                         <dd>(optional) The name or index of the child template</dd>
823                                 
824                                         <dt>
825                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  <b>values</b>
826                                                 
827                                         </dt>
828                                         <dd>The values to be applied to the template, this should be an array of objects.</dd>
829                                 
830                                         <dt>
831                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>reset</b>
832                                                 
833                                         </dt>
834                                         <dd>(optional) True to reset the template first</dd>
835                                 
836                                 </dl>
837                         
838                         
839                         
840                         
841                         
842                                 <dl class="detailList">
843                                 <dt class="heading">Returns:</dt>
844                                 
845                                         <dd><span class="fixedFont">MasterTemplate</span>  this</dd>
846                                 
847                                 </dl>
848                         
849                         
850                         
851
852                     
853                     
854                      
855                     </div>                    
856                 </div>
857
858             </td>
859             <td class="msource">
860                 
861                         Roo.MasterTemplate
862                 &nbsp;
863             </td>
864         </tr>
865         
866           
867           <tr class="method-row config-row-alt1 expandable">
868             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
869            
870            
871             <td class="sig">
872                 <a id="Roo.Template-method-insertAfter"   name=".insertAfter"></a>
873                 <div class="fixedFont">
874                         <span class="attributes"></span><b class="itemname">insertAfter</b>
875                                 
876                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>returnElement</i></B>) 
877                         
878                                 
879                                          : 
880                                         
881                                                 
882                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
883                                         
884                                         
885                                         
886                                 
887                         
888                 </div>
889                 <div class="mdesc">
890                 
891                    <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div> 
892                  
893                  
894                  
895                     <div class="long">
896                         
897                                 Applies the supplied values to the template and inserts the new node(s) after el.
898                     
899                                 
900                         
901                         
902                         
903                         
904                                 <dl class="detailList">
905                                 <dt class="heading">Parameters:</dt>
906                                 
907                                         <dt>
908                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
909                                                 
910                                         </dt>
911                                         <dd>The context element</dd>
912                                 
913                                         <dt>
914                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
915                                                 
916                                         </dt>
917                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
918                                 
919                                         <dt>
920                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>returnElement</b>
921                                                 
922                                         </dt>
923                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
924                                 
925                                 </dl>
926                         
927                         
928                         
929                         
930                         
931                                 <dl class="detailList">
932                                 <dt class="heading">Returns:</dt>
933                                 
934                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element</span>  The new node or Element</dd>
935                                 
936                                 </dl>
937                         
938                         
939                         
940
941                     
942                     
943                      
944                     </div>                    
945                 </div>
946
947             </td>
948             <td class="msource">
949                 
950                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
951                 &nbsp;
952             </td>
953         </tr>
954         
955           
956           <tr class="method-row config-row-alt0 expandable">
957             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
958            
959            
960             <td class="sig">
961                 <a id="Roo.Template-method-insertBefore"   name=".insertBefore"></a>
962                 <div class="fixedFont">
963                         <span class="attributes"></span><b class="itemname">insertBefore</b>
964                                 
965                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>returnElement</i></B>) 
966                         
967                                 
968                                          : 
969                                         
970                                                 
971                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
972                                         
973                                         
974                                         
975                                 
976                         
977                 </div>
978                 <div class="mdesc">
979                 
980                    <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div> 
981                  
982                  
983                  
984                     <div class="long">
985                         
986                                 Applies the supplied values to the template and inserts the new node(s) before el.
987                     
988                                 
989                         
990                         
991                         
992                         
993                                 <dl class="detailList">
994                                 <dt class="heading">Parameters:</dt>
995                                 
996                                         <dt>
997                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
998                                                 
999                                         </dt>
1000                                         <dd>The context element</dd>
1001                                 
1002                                         <dt>
1003                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
1004                                                 
1005                                         </dt>
1006                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
1007                                 
1008                                         <dt>
1009                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>returnElement</b>
1010                                                 
1011                                         </dt>
1012                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
1013                                 
1014                                 </dl>
1015                         
1016                         
1017                         
1018                         
1019                         
1020                                 <dl class="detailList">
1021                                 <dt class="heading">Returns:</dt>
1022                                 
1023                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element</span>  The new node or Element</dd>
1024                                 
1025                                 </dl>
1026                         
1027                         
1028                         
1029
1030                     
1031                     
1032                      
1033                     </div>                    
1034                 </div>
1035
1036             </td>
1037             <td class="msource">
1038                 
1039                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1040                 &nbsp;
1041             </td>
1042         </tr>
1043         
1044           
1045           <tr class="method-row config-row-alt1 expandable">
1046             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1047            
1048            
1049             <td class="sig">
1050                 <a id="Roo.Template-method-insertFirst"   name=".insertFirst"></a>
1051                 <div class="fixedFont">
1052                         <span class="attributes"></span><b class="itemname">insertFirst</b>
1053                                 
1054                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>returnElement</i></B>) 
1055                         
1056                                 
1057                                          : 
1058                                         
1059                                                 
1060                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
1061                                         
1062                                         
1063                                         
1064                                 
1065                         
1066                 </div>
1067                 <div class="mdesc">
1068                 
1069                    <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div> 
1070                  
1071                  
1072                  
1073                     <div class="long">
1074                         
1075                                 Applies the supplied values to the template and inserts the new node(s) as the first child of el.
1076                     
1077                                 
1078                         
1079                         
1080                         
1081                         
1082                                 <dl class="detailList">
1083                                 <dt class="heading">Parameters:</dt>
1084                                 
1085                                         <dt>
1086                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
1087                                                 
1088                                         </dt>
1089                                         <dd>The context element</dd>
1090                                 
1091                                         <dt>
1092                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
1093                                                 
1094                                         </dt>
1095                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
1096                                 
1097                                         <dt>
1098                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>returnElement</b>
1099                                                 
1100                                         </dt>
1101                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
1102                                 
1103                                 </dl>
1104                         
1105                         
1106                         
1107                         
1108                         
1109                                 <dl class="detailList">
1110                                 <dt class="heading">Returns:</dt>
1111                                 
1112                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element</span>  The new node or Element</dd>
1113                                 
1114                                 </dl>
1115                         
1116                         
1117                         
1118
1119                     
1120                     
1121                      
1122                     </div>                    
1123                 </div>
1124
1125             </td>
1126             <td class="msource">
1127                 
1128                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1129                 &nbsp;
1130             </td>
1131         </tr>
1132         
1133           
1134           <tr class="method-row config-row-alt0 expandable">
1135             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1136            
1137            
1138             <td class="sig">
1139                 <a id="Roo.Template-method-overwrite"   name=".overwrite"></a>
1140                 <div class="fixedFont">
1141                         <span class="attributes"></span><b class="itemname">overwrite</b>
1142                                 
1143                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>returnElement</i></B>) 
1144                         
1145                                 
1146                                          : 
1147                                         
1148                                                 
1149                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
1150                                         
1151                                         
1152                                         
1153                                 
1154                         
1155                 </div>
1156                 <div class="mdesc">
1157                 
1158                    <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div> 
1159                  
1160                  
1161                  
1162                     <div class="long">
1163                         
1164                                 Applies the supplied values to the template and overwrites the content of el with the new node(s).
1165                     
1166                                 
1167                         
1168                         
1169                         
1170                         
1171                                 <dl class="detailList">
1172                                 <dt class="heading">Parameters:</dt>
1173                                 
1174                                         <dt>
1175                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
1176                                                 
1177                                         </dt>
1178                                         <dd>The context element</dd>
1179                                 
1180                                         <dt>
1181                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>values</b>
1182                                                 
1183                                         </dt>
1184                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
1185                                 
1186                                         <dt>
1187                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>returnElement</b>
1188                                                 
1189                                         </dt>
1190                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
1191                                 
1192                                 </dl>
1193                         
1194                         
1195                         
1196                         
1197                         
1198                                 <dl class="detailList">
1199                                 <dt class="heading">Returns:</dt>
1200                                 
1201                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element</span>  The new node or Element</dd>
1202                                 
1203                                 </dl>
1204                         
1205                         
1206                         
1207
1208                     
1209                     
1210                      
1211                     </div>                    
1212                 </div>
1213
1214             </td>
1215             <td class="msource">
1216                 
1217                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1218                 &nbsp;
1219             </td>
1220         </tr>
1221         
1222           
1223           <tr class="method-row config-row-alt1 expandable notInherited">
1224             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1225            
1226            
1227             <td class="sig">
1228                 <a id="Roo.MasterTemplate-method-reset"   name=".reset"></a>
1229                 <div class="fixedFont">
1230                         <span class="attributes"></span><b class="itemname">reset</b>
1231                                 
1232                                  () 
1233                         
1234                                 
1235                                          : 
1236                                         
1237                                                 
1238                                                 MasterTemplate
1239                                         
1240                                         
1241                                         
1242                                 
1243                         
1244                 </div>
1245                 <div class="mdesc">
1246                 
1247                    <div class="short">Resets the template for reuse</div> 
1248                  
1249                  
1250                  
1251                     <div class="long">
1252                         
1253                                 Resets the template for reuse
1254                     
1255                                 
1256                         
1257                         
1258                         
1259                         
1260                         
1261                         
1262                         
1263                         
1264                                 <dl class="detailList">
1265                                 <dt class="heading">Returns:</dt>
1266                                 
1267                                         <dd><span class="fixedFont">MasterTemplate</span>  this</dd>
1268                                 
1269                                 </dl>
1270                         
1271                         
1272                         
1273
1274                     
1275                     
1276                      
1277                     </div>                    
1278                 </div>
1279
1280             </td>
1281             <td class="msource">
1282                 
1283                         Roo.MasterTemplate
1284                 &nbsp;
1285             </td>
1286         </tr>
1287         
1288           
1289           <tr class="method-row config-row-alt0 expandable">
1290             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1291            
1292            
1293             <td class="sig">
1294                 <a id="Roo.Template-method-set"   name=".set"></a>
1295                 <div class="fixedFont">
1296                         <span class="attributes"></span><b class="itemname">set</b>
1297                                 
1298                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>compile</i></B>) 
1299                         
1300                                 
1301                                          : 
1302                                         
1303                                                 
1304                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1305                                         
1306                                         
1307                                         
1308                                 
1309                         
1310                 </div>
1311                 <div class="mdesc">
1312                 
1313                    <div class="short">Sets the HTML used as the template and optionally compiles it.</div> 
1314                  
1315                  
1316                  
1317                     <div class="long">
1318                         
1319                                 Sets the HTML used as the template and optionally compiles it.
1320                     
1321                                 
1322                         
1323                         
1324                         
1325                         
1326                                 <dl class="detailList">
1327                                 <dt class="heading">Parameters:</dt>
1328                                 
1329                                         <dt>
1330                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>html</b>
1331                                                 
1332                                         </dt>
1333                                         <dd></dd>
1334                                 
1335                                         <dt>
1336                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>compile</b>
1337                                                 
1338                                         </dt>
1339                                         <dd>(optional) True to compile the template (defaults to undefined)</dd>
1340                                 
1341                                 </dl>
1342                         
1343                         
1344                         
1345                         
1346                         
1347                                 <dl class="detailList">
1348                                 <dt class="heading">Returns:</dt>
1349                                 
1350                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
1351                                 
1352                                 </dl>
1353                         
1354                         
1355                         
1356
1357                     
1358                     
1359                      
1360                     </div>                    
1361                 </div>
1362
1363             </td>
1364             <td class="msource">
1365                 
1366                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1367                 &nbsp;
1368             </td>
1369         </tr>
1370         
1371                                                        
1372     </table>
1373
1374   
1375   <!-- ============================== events summary / details ======================== -->
1376   
1377   
1378   <a id="Roo.MasterTemplate-events"></a>
1379     
1380   
1381         
1382    
1383     
1384      <table cellspacing="0" class="member-table">
1385       <caption class="Empty">Events - Has None</caption>
1386      </table>
1387     
1388     
1389   
1390     
1391     
1392   
1393   
1394   
1395  
1396 <!-- ============================== footer ================================= -->
1397                 <div class="fineprint" style="clear:both">
1398                         
1399                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Wed May 02 2012 11:27:33 GMT+0800 (HKT)
1400                         Based on 
1401                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
1402                 </div>
1403         </body>
1404 </html>