git.roojs.org Git - roojs1/blob - docs/symbols/Roo.XTemplate.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.XTemplate</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.XTemplate-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.XTemplate-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.XTemplate-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.XTemplate-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.XTemplate
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.XTemplate
  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_XTemplate.js.html">Roo/XTemplate.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">XTemplate</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 nested templates for loops or conditionals. The syntax is:<br/><pre><code><br/>var t = new Roo.MasterTemplate(<br/>   '&lt;select name="{name}"&gt;',<br/>            '&lt;tpl for="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;',<br/>      '&lt;/select&gt;'<br/>);<br/> <br/>// then append, applying the master template values<br/> </code></pre><br/><br/>Supported features:<br/><br/> Tags:<br/>   {a_variable} - output encoded.<br/>   {a_variable.format:("Y-m-d")} - call a method on the variable<br/>   {a_variable:raw} - unencoded output<br/>   {a_variable:toFixed(1,2)} - Roo.util.Format."toFixed"<br/>   {a_variable:this.method_on_template(...)} - call a method on the template object.<br/> <br/> Tpl:<br/>     <tpl for="a_variable or condition.."></tpl><br/>     <tpl if="a_variable or condition"></tpl><br/>     <tpl exec="some javascript"></tpl><br/><br/>     <tpl for="."></tpl> - just iterate the property..<br/>     <tpl for=".."></tpl> - iterates witht the parent (probably the template)
  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.XTemplate';">[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.XTemplate.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.XTemplate-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.XTemplate-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.XTemplate-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-XTemplate"   name=".XTemplate"></a>
 252                 <div class="fixedFont">
 253                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">XTemplate</b>
 254
 255                                  ()
 256
 257
 258
 259                 </div>
 260                 <div class="mdesc">
 261
 262
 263                         <div class="short">Create a new Roo.XTemplate</div>
 264
 265
 266                     <div class="long">
 267
 268
 269
 270                                 Create a new Roo.XTemplate
 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">
 294             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 295
 296
 297             <td class="sig">
 298                 <a id="Roo.Template-method-append"   name=".append"></a>
 299                 <div class="fixedFont">
 300                         <span class="attributes"></span><b class="itemname">append</b>
 301
 302                                  (<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>)
 303
 304
 305                                          :
 306
 307
 308                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 309
 310
 311
 312
 313
 314                 </div>
 315                 <div class="mdesc">
 316
 317                    <div class="short">Applies the supplied values to the template and appends the new node(s) to el.</div>
 318
 319
 320
 321                     <div class="long">
 322
 323                                 Applies the supplied values to the template and appends the new node(s) to el.
 324
 325
 326
 327
 328
 329
 330                                 <dl class="detailList">
 331                                 <dt class="heading">Parameters:</dt>
 332
 333                                         <dt>
 334                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 335
 336                                         </dt>
 337                                         <dd>The context element</dd>
 338
 339                                         <dt>
 340                                                 <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>
 341
 342                                         </dt>
 343                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 344
 345                                         <dt>
 346                                                 <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>
 347
 348                                         </dt>
 349                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 350
 351                                 </dl>
 352
 353
 354
 355
 356
 357                                 <dl class="detailList">
 358                                 <dt class="heading">Returns:</dt>
 359
 360                                         <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>
 361
 362                                 </dl>
 363
 364
 365
 366
 367
 368
 369
 370                     </div>
 371                 </div>
 372
 373             </td>
 374             <td class="msource">
 375
 376                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 377                 &nbsp;
 378             </td>
 379         </tr>
 380
 381
 382           <tr class="method-row config-row-alt0 expandable">
 383             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 384
 385
 386             <td class="sig">
 387                 <a id="Roo.Template-method-apply"   name=".apply"></a>
 388                 <div class="fixedFont">
 389                         <span class="attributes"></span><b class="itemname">apply</b>
 390
 391                                  ()
 392
 393
 394
 395                 </div>
 396                 <div class="mdesc">
 397
 398                    <div class="short">Alias for {<b>link</b> <b>applyTemplate</b>}</div>
 399
 400
 401
 402                     <div class="long">
 403
 404                                 Alias for {<b>link</b> <b>applyTemplate</b>}
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421                     </div>
 422                 </div>
 423
 424             </td>
 425             <td class="msource">
 426
 427                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 428                 &nbsp;
 429             </td>
 430         </tr>
 431
 432
 433           <tr class="method-row config-row-alt1 expandable">
 434             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 435
 436
 437             <td class="sig">
 438                 <a id="Roo.Template-method-applyTemplate"   name=".applyTemplate"></a>
 439                 <div class="fixedFont">
 440                         <span class="attributes"></span><b class="itemname">applyTemplate</b>
 441
 442                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
 443
 444
 445                                          :
 446
 447
 448                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 449
 450
 451
 452
 453
 454                 </div>
 455                 <div class="mdesc">
 456
 457                    <div class="short">Returns an HTML fragment of this template with the specified values applied.</div>
 458
 459
 460
 461                     <div class="long">
 462
 463                                 Returns an HTML fragment of this template with the specified values applied.
 464
 465
 466
 467
 468
 469
 470                                 <dl class="detailList">
 471                                 <dt class="heading">Parameters:</dt>
 472
 473                                         <dt>
 474                                                 <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>
 475
 476                                         </dt>
 477                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 478
 479                                 </dl>
 480
 481
 482
 483
 484
 485                                 <dl class="detailList">
 486                                 <dt class="heading">Returns:</dt>
 487
 488                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The HTML fragment</dd>
 489
 490                                 </dl>
 491
 492
 493
 494
 495
 496
 497
 498                     </div>
 499                 </div>
 500
 501             </td>
 502             <td class="msource">
 503
 504                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 505                 &nbsp;
 506             </td>
 507         </tr>
 508
 509
 510           <tr class="method-row config-row-alt0 expandable">
 511             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 512
 513
 514             <td class="sig">
 515                 <a id="Roo.Template-method-compile"   name=".compile"></a>
 516                 <div class="fixedFont">
 517                         <span class="attributes"></span><b class="itemname">compile</b>
 518
 519                                  ()
 520
 521
 522                                          :
 523
 524
 525                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 526
 527
 528
 529
 530
 531                 </div>
 532                 <div class="mdesc">
 533
 534                    <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div>
 535
 536
 537
 538                     <div class="long">
 539
 540                                 Compiles the template into an internal function, eliminating the RegEx overhead.
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551                                 <dl class="detailList">
 552                                 <dt class="heading">Returns:</dt>
 553
 554                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
 555
 556                                 </dl>
 557
 558
 559
 560
 561
 562
 563
 564                     </div>
 565                 </div>
 566
 567             </td>
 568             <td class="msource">
 569
 570                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 571                 &nbsp;
 572             </td>
 573         </tr>
 574
 575
 576           <tr class="method-row config-row-alt1 expandable">
 577             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 578
 579
 580             <td class="sig">
 581                 <a id="Roo.Template-method-insertAfter"   name=".insertAfter"></a>
 582                 <div class="fixedFont">
 583                         <span class="attributes"></span><b class="itemname">insertAfter</b>
 584
 585                                  (<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>)
 586
 587
 588                                          :
 589
 590
 591                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 592
 593
 594
 595
 596
 597                 </div>
 598                 <div class="mdesc">
 599
 600                    <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div>
 601
 602
 603
 604                     <div class="long">
 605
 606                                 Applies the supplied values to the template and inserts the new node(s) after el.
 607
 608
 609
 610
 611
 612
 613                                 <dl class="detailList">
 614                                 <dt class="heading">Parameters:</dt>
 615
 616                                         <dt>
 617                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 618
 619                                         </dt>
 620                                         <dd>The context element</dd>
 621
 622                                         <dt>
 623                                                 <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>
 624
 625                                         </dt>
 626                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 627
 628                                         <dt>
 629                                                 <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>
 630
 631                                         </dt>
 632                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 633
 634                                 </dl>
 635
 636
 637
 638
 639
 640                                 <dl class="detailList">
 641                                 <dt class="heading">Returns:</dt>
 642
 643                                         <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>
 644
 645                                 </dl>
 646
 647
 648
 649
 650
 651
 652
 653                     </div>
 654                 </div>
 655
 656             </td>
 657             <td class="msource">
 658
 659                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 660                 &nbsp;
 661             </td>
 662         </tr>
 663
 664
 665           <tr class="method-row config-row-alt0 expandable">
 666             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 667
 668
 669             <td class="sig">
 670                 <a id="Roo.Template-method-insertBefore"   name=".insertBefore"></a>
 671                 <div class="fixedFont">
 672                         <span class="attributes"></span><b class="itemname">insertBefore</b>
 673
 674                                  (<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>)
 675
 676
 677                                          :
 678
 679
 680                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 681
 682
 683
 684
 685
 686                 </div>
 687                 <div class="mdesc">
 688
 689                    <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div>
 690
 691
 692
 693                     <div class="long">
 694
 695                                 Applies the supplied values to the template and inserts the new node(s) before el.
 696
 697
 698
 699
 700
 701
 702                                 <dl class="detailList">
 703                                 <dt class="heading">Parameters:</dt>
 704
 705                                         <dt>
 706                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 707
 708                                         </dt>
 709                                         <dd>The context element</dd>
 710
 711                                         <dt>
 712                                                 <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>
 713
 714                                         </dt>
 715                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 716
 717                                         <dt>
 718                                                 <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>
 719
 720                                         </dt>
 721                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 722
 723                                 </dl>
 724
 725
 726
 727
 728
 729                                 <dl class="detailList">
 730                                 <dt class="heading">Returns:</dt>
 731
 732                                         <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>
 733
 734                                 </dl>
 735
 736
 737
 738
 739
 740
 741
 742                     </div>
 743                 </div>
 744
 745             </td>
 746             <td class="msource">
 747
 748                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 749                 &nbsp;
 750             </td>
 751         </tr>
 752
 753
 754           <tr class="method-row config-row-alt1 expandable">
 755             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 756
 757
 758             <td class="sig">
 759                 <a id="Roo.Template-method-insertFirst"   name=".insertFirst"></a>
 760                 <div class="fixedFont">
 761                         <span class="attributes"></span><b class="itemname">insertFirst</b>
 762
 763                                  (<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>)
 764
 765
 766                                          :
 767
 768
 769                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 770
 771
 772
 773
 774
 775                 </div>
 776                 <div class="mdesc">
 777
 778                    <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div>
 779
 780
 781
 782                     <div class="long">
 783
 784                                 Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 785
 786
 787
 788
 789
 790
 791                                 <dl class="detailList">
 792                                 <dt class="heading">Parameters:</dt>
 793
 794                                         <dt>
 795                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 796
 797                                         </dt>
 798                                         <dd>The context element</dd>
 799
 800                                         <dt>
 801                                                 <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>
 802
 803                                         </dt>
 804                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 805
 806                                         <dt>
 807                                                 <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>
 808
 809                                         </dt>
 810                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 811
 812                                 </dl>
 813
 814
 815
 816
 817
 818                                 <dl class="detailList">
 819                                 <dt class="heading">Returns:</dt>
 820
 821                                         <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>
 822
 823                                 </dl>
 824
 825
 826
 827
 828
 829
 830
 831                     </div>
 832                 </div>
 833
 834             </td>
 835             <td class="msource">
 836
 837                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 838                 &nbsp;
 839             </td>
 840         </tr>
 841
 842
 843           <tr class="method-row config-row-alt0 expandable">
 844             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 845
 846
 847             <td class="sig">
 848                 <a id="Roo.Template-method-overwrite"   name=".overwrite"></a>
 849                 <div class="fixedFont">
 850                         <span class="attributes"></span><b class="itemname">overwrite</b>
 851
 852                                  (<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>)
 853
 854
 855                                          :
 856
 857
 858                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 859
 860
 861
 862
 863
 864                 </div>
 865                 <div class="mdesc">
 866
 867                    <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div>
 868
 869
 870
 871                     <div class="long">
 872
 873                                 Applies the supplied values to the template and overwrites the content of el with the new node(s).
 874
 875
 876
 877
 878
 879
 880                                 <dl class="detailList">
 881                                 <dt class="heading">Parameters:</dt>
 882
 883                                         <dt>
 884                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 885
 886                                         </dt>
 887                                         <dd>The context element</dd>
 888
 889                                         <dt>
 890                                                 <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>
 891
 892                                         </dt>
 893                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 894
 895                                         <dt>
 896                                                 <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>
 897
 898                                         </dt>
 899                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 900
 901                                 </dl>
 902
 903
 904
 905
 906
 907                                 <dl class="detailList">
 908                                 <dt class="heading">Returns:</dt>
 909
 910                                         <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>
 911
 912                                 </dl>
 913
 914
 915
 916
 917
 918
 919
 920                     </div>
 921                 </div>
 922
 923             </td>
 924             <td class="msource">
 925
 926                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 927                 &nbsp;
 928             </td>
 929         </tr>
 930
 931
 932           <tr class="method-row config-row-alt1 expandable">
 933             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 934
 935
 936             <td class="sig">
 937                 <a id="Roo.Template-method-set"   name=".set"></a>
 938                 <div class="fixedFont">
 939                         <span class="attributes"></span><b class="itemname">set</b>
 940
 941                                  (<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>)
 942
 943
 944                                          :
 945
 946
 947                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 948
 949
 950
 951
 952
 953                 </div>
 954                 <div class="mdesc">
 955
 956                    <div class="short">Sets the HTML used as the template and optionally compiles it.</div>
 957
 958
 959
 960                     <div class="long">
 961
 962                                 Sets the HTML used as the template and optionally compiles it.
 963
 964
 965
 966
 967
 968
 969                                 <dl class="detailList">
 970                                 <dt class="heading">Parameters:</dt>
 971
 972                                         <dt>
 973                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>html</b>
 974
 975                                         </dt>
 976                                         <dd></dd>
 977
 978                                         <dt>
 979                                                 <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>
 980
 981                                         </dt>
 982                                         <dd>(optional) True to compile the template (defaults to undefined)</dd>
 983
 984                                 </dl>
 985
 986
 987
 988
 989
 990                                 <dl class="detailList">
 991                                 <dt class="heading">Returns:</dt>
 992
 993                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
 994
 995                                 </dl>
 996
 997
 998
 999
1000
1001
1002
1003                     </div>
1004                 </div>
1005
1006             </td>
1007             <td class="msource">
1008
1009                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1010                 &nbsp;
1011             </td>
1012         </tr>
1013
1014
1015     </table>
1016
1017
1018   <!-- ============================== events summary / details ======================== -->
1019
1020
1021   <a id="Roo.XTemplate-events"></a>
1022
1023
1024
1025
1026
1027      <table cellspacing="0" class="member-table">
1028       <caption class="Empty">Events - Has None</caption>
1029      </table>
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039 <!-- ============================== footer ================================= -->
1040                 <div class="fineprint" style="clear:both">
1041
1042                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Sat Apr 07 2012 11:50:40 GMT+0800 (HKT)
1043                         Based on
1044                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1045                 </div>
1046         </body>
1047 </html>