git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Template.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.Template</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.Template-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.Template-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.Template-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.Template-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.Template
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_Template.js.html">Roo/Template.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Template</td></tr>
  63
  64
  65         <tr><td class="label">Subclasses:</td><td class="hd-info">
  66                 <a href="./Roo.DomTemplate.html#constructor" roo:cls="Roo.DomTemplate.html#constructor">Roo.DomTemplate</a>, <a href="./Roo.MasterTemplate.html#constructor" roo:cls="Roo.MasterTemplate.html#constructor">Roo.MasterTemplate</a>, <a href="./Roo.XTemplate.html#constructor" roo:cls="Roo.XTemplate.html#constructor">Roo.XTemplate</a>
  67
  68
  69
  70         </td></tr>
  71
  72
  73
  74     </table>
  75
  76
  77 <!-- ============================== class summary ========================== -->
  78     <div class="description">
  79         Represents an HTML fragment template. Templates can be precompiled for greater performance.<br/>For a list of available format functions, see {<b>link</b> Roo.util.Format}.<br /><br/>Usage:<br/><pre><code><br/>var t = new Roo.Template({<br/>    html :  '&lt;div name="{id}"&gt;' + <br/>        '&lt;span class="{cls}"&gt;{name:trim} {someval:this.myformat}{value:ellipsis(10)}&lt;/span&gt;' +<br/>        '&lt;/div&gt;',<br/>    myformat: function (value, allValues) {<br/>        return 'XX' + value;<br/>    }<br/>});<br/>t.append('some-element', {id: 'myid', cls: 'myclass', name: 'foo', value: 'bar'});<br/></code></pre><br/>For more information see this blog post with examples:<br/> <a href="http://www.cnitblog.com/seeyeah/archive/2011/12/30/38728.html/">DomHelper<br/>     - Create Elements using DOM, HTML fragments and Templates</a>.
  80     </div>
  81
  82
  83 <!-- ============================== Class comment block... ========================== -->
  84
  85 <div class="comments">
  86         <b>Class Comments / Notes</B> =>
  87         <u onclick="parent.CommentDialog.showCommentId = 'Roo.Template';">[Add Your comment/notes about this class]</u>
  88         <br/>
  89         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  90                 src="/blog.php/GtkDjsComments/Roo.Template.html"></iframe>
  91 </div>
  92
  93
  94
  95 <!-- ============================== config options ========================== -->
  96
  97
  98
  99
 100     <div class="hr"></div>
 101     <a id="Roo.Template-configs"></a>
 102
 103
 104
 105
 106
 107       <table cellspacing="0" class="member-table">
 108       <caption>Config Options (Usually are also Properties)</caption>
 109
 110
 111         <tr>
 112             <th class="sig-header" colspan="2">Options</th>
 113
 114             <th class="msource-header">Defined By</th>
 115         </tr>
 116
 117
 118
 119
 120
 121                 <tr class="config-row expandable config-row-alt0 notInherited">
 122                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 123                     <td class="sig">
 124
 125                         <a id="Roo.Template-cfg-html" name=".html"></a>
 126                         <div class="fixedFont">
 127                                 <b  class="itemname">html</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 128
 129
 130                         </div>
 131
 132                         <div class="mdesc">
 133                             <div class="short">The HTML fragment or an array of fragments to join("") or multiple arguments to join("")</div>
 134                         </div>
 135
 136                         <div class="mdesc">
 137                             <div class="long">
 138                     The HTML fragment or an array of fragments to join("") or multiple arguments to join("")
 139
 140                 </div>
 141                         </div>
 142
 143
 144
 145                     </td>
 146                     <td class="msource">
 147
 148                         Roo.Template
 149
 150                     </td>
 151                 </tr>
 152
 153
 154                 <tr class="config-row expandable config-row-alt1 notInherited">
 155                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 156                     <td class="sig">
 157
 158                         <a id="Roo.Template-cfg-url" name=".url"></a>
 159                         <div class="fixedFont">
 160                                 <b  class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 161
 162
 163                         </div>
 164
 165                         <div class="mdesc">
 166                             <div class="short">The Url to load the template from.</div>
 167                         </div>
 168
 169                         <div class="mdesc">
 170                             <div class="long">
 171                     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...
 172
 173                 </div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.Template
 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.Template-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.Template-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 expandable notInherited">
 247             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 248
 249
 250             <td class="sig">
 251                 <a id="Roo-method-Template"   name=".Template"></a>
 252                 <div class="fixedFont">
 253                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Template</b>
 254
 255                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
 256
 257
 258
 259                 </div>
 260                 <div class="mdesc">
 261
 262
 263                         <div class="short">Create a new Roo.Template</div>
 264
 265
 266                     <div class="long">
 267
 268
 269
 270                                 Create a new Roo.Template
 271
 272
 273                                 <dl class="detailList">
 274                                 <dt class="heading">Parameters:</dt>
 275
 276                                         <dt>
 277                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>cfg</b>
 278
 279                                         </dt>
 280                                         <dd>- Configuration object.</dd>
 281
 282                                 </dl>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294                     </div>
 295                 </div>
 296
 297             </td>
 298             <td class="msource">
 299                 &nbsp;
 300             </td>
 301         </tr>
 302
 303
 304           <tr class="method-row config-row-alt1 expandable notInherited">
 305             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 306
 307
 308             <td class="sig">
 309                 <a id="Roo.Template-method-from"   name=".from"></a>
 310                 <div class="fixedFont">
 311                         <span class="attributes">Roo.Template.</span><b class="itemname">from</b>
 312
 313                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>el</i></B>)
 314
 315
 316
 317                 </div>
 318                 <div class="mdesc">
 319
 320                    <div class="short">Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.</div>
 321
 322
 323
 324                     <div class="long">
 325
 326                                 Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.
 327
 328
 329
 330
 331
 332
 333                                 <dl class="detailList">
 334                                 <dt class="heading">Parameters:</dt>
 335
 336                                         <dt>
 337                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
 338
 339                                         </dt>
 340                                         <dd>A DOM element or its id</dd>
 341
 342                                 </dl>
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354                     </div>
 355                 </div>
 356
 357             </td>
 358             <td class="msource">
 359
 360                         Roo.Template
 361                 &nbsp;
 362             </td>
 363         </tr>
 364
 365
 366           <tr class="method-row config-row-alt0 expandable notInherited">
 367             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 368
 369
 370             <td class="sig">
 371                 <a id="Roo.Template-method-append"   name=".append"></a>
 372                 <div class="fixedFont">
 373                         <span class="attributes"></span><b class="itemname">append</b>
 374
 375                                  (<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>)
 376
 377
 378                                          :
 379
 380
 381                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 382
 383
 384
 385
 386
 387                 </div>
 388                 <div class="mdesc">
 389
 390                    <div class="short">Applies the supplied values to the template and appends the new node(s) to el.</div>
 391
 392
 393
 394                     <div class="long">
 395
 396                                 Applies the supplied values to the template and appends the new node(s) to el.
 397
 398
 399
 400
 401
 402
 403                                 <dl class="detailList">
 404                                 <dt class="heading">Parameters:</dt>
 405
 406                                         <dt>
 407                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 408
 409                                         </dt>
 410                                         <dd>The context element</dd>
 411
 412                                         <dt>
 413                                                 <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>
 414
 415                                         </dt>
 416                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 417
 418                                         <dt>
 419                                                 <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>
 420
 421                                         </dt>
 422                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 423
 424                                 </dl>
 425
 426
 427
 428
 429
 430                                 <dl class="detailList">
 431                                 <dt class="heading">Returns:</dt>
 432
 433                                         <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>
 434
 435                                 </dl>
 436
 437
 438
 439
 440
 441
 442
 443                     </div>
 444                 </div>
 445
 446             </td>
 447             <td class="msource">
 448
 449                         Roo.Template
 450                 &nbsp;
 451             </td>
 452         </tr>
 453
 454
 455           <tr class="method-row config-row-alt1 expandable notInherited">
 456             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 457
 458
 459             <td class="sig">
 460                 <a id="Roo.Template-method-apply"   name=".apply"></a>
 461                 <div class="fixedFont">
 462                         <span class="attributes"></span><b class="itemname">apply</b>
 463
 464                                  ()
 465
 466
 467
 468                 </div>
 469                 <div class="mdesc">
 470
 471                    <div class="short">Alias for {<b>link</b> <b>applyTemplate</b>}</div>
 472
 473
 474
 475                     <div class="long">
 476
 477                                 Alias for {<b>link</b> <b>applyTemplate</b>}
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494                     </div>
 495                 </div>
 496
 497             </td>
 498             <td class="msource">
 499
 500                         Roo.Template
 501                 &nbsp;
 502             </td>
 503         </tr>
 504
 505
 506           <tr class="method-row config-row-alt0 expandable notInherited">
 507             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 508
 509
 510             <td class="sig">
 511                 <a id="Roo.Template-method-applyTemplate"   name=".applyTemplate"></a>
 512                 <div class="fixedFont">
 513                         <span class="attributes"></span><b class="itemname">applyTemplate</b>
 514
 515                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
 516
 517
 518                                          :
 519
 520
 521                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 522
 523
 524
 525
 526
 527                 </div>
 528                 <div class="mdesc">
 529
 530                    <div class="short">Returns an HTML fragment of this template with the specified values applied.</div>
 531
 532
 533
 534                     <div class="long">
 535
 536                                 Returns an HTML fragment of this template with the specified values applied.
 537
 538
 539
 540
 541
 542
 543                                 <dl class="detailList">
 544                                 <dt class="heading">Parameters:</dt>
 545
 546                                         <dt>
 547                                                 <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>
 548
 549                                         </dt>
 550                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 551
 552                                 </dl>
 553
 554
 555
 556
 557
 558                                 <dl class="detailList">
 559                                 <dt class="heading">Returns:</dt>
 560
 561                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The HTML fragment</dd>
 562
 563                                 </dl>
 564
 565
 566
 567
 568
 569
 570
 571                     </div>
 572                 </div>
 573
 574             </td>
 575             <td class="msource">
 576
 577                         Roo.Template
 578                 &nbsp;
 579             </td>
 580         </tr>
 581
 582
 583           <tr class="method-row config-row-alt1 expandable notInherited">
 584             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 585
 586
 587             <td class="sig">
 588                 <a id="Roo.Template-method-compile"   name=".compile"></a>
 589                 <div class="fixedFont">
 590                         <span class="attributes"></span><b class="itemname">compile</b>
 591
 592                                  ()
 593
 594
 595                                          :
 596
 597
 598                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 599
 600
 601
 602
 603
 604                 </div>
 605                 <div class="mdesc">
 606
 607                    <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div>
 608
 609
 610
 611                     <div class="long">
 612
 613                                 Compiles the template into an internal function, eliminating the RegEx overhead.
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624                                 <dl class="detailList">
 625                                 <dt class="heading">Returns:</dt>
 626
 627                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
 628
 629                                 </dl>
 630
 631
 632
 633
 634
 635
 636
 637                     </div>
 638                 </div>
 639
 640             </td>
 641             <td class="msource">
 642
 643                         Roo.Template
 644                 &nbsp;
 645             </td>
 646         </tr>
 647
 648
 649           <tr class="method-row config-row-alt0 expandable notInherited">
 650             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 651
 652
 653             <td class="sig">
 654                 <a id="Roo.Template-method-insertAfter"   name=".insertAfter"></a>
 655                 <div class="fixedFont">
 656                         <span class="attributes"></span><b class="itemname">insertAfter</b>
 657
 658                                  (<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>)
 659
 660
 661                                          :
 662
 663
 664                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 665
 666
 667
 668
 669
 670                 </div>
 671                 <div class="mdesc">
 672
 673                    <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div>
 674
 675
 676
 677                     <div class="long">
 678
 679                                 Applies the supplied values to the template and inserts the new node(s) after el.
 680
 681
 682
 683
 684
 685
 686                                 <dl class="detailList">
 687                                 <dt class="heading">Parameters:</dt>
 688
 689                                         <dt>
 690                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 691
 692                                         </dt>
 693                                         <dd>The context element</dd>
 694
 695                                         <dt>
 696                                                 <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>
 697
 698                                         </dt>
 699                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 700
 701                                         <dt>
 702                                                 <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>
 703
 704                                         </dt>
 705                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 706
 707                                 </dl>
 708
 709
 710
 711
 712
 713                                 <dl class="detailList">
 714                                 <dt class="heading">Returns:</dt>
 715
 716                                         <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>
 717
 718                                 </dl>
 719
 720
 721
 722
 723
 724
 725
 726                     </div>
 727                 </div>
 728
 729             </td>
 730             <td class="msource">
 731
 732                         Roo.Template
 733                 &nbsp;
 734             </td>
 735         </tr>
 736
 737
 738           <tr class="method-row config-row-alt1 expandable notInherited">
 739             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 740
 741
 742             <td class="sig">
 743                 <a id="Roo.Template-method-insertBefore"   name=".insertBefore"></a>
 744                 <div class="fixedFont">
 745                         <span class="attributes"></span><b class="itemname">insertBefore</b>
 746
 747                                  (<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>)
 748
 749
 750                                          :
 751
 752
 753                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 754
 755
 756
 757
 758
 759                 </div>
 760                 <div class="mdesc">
 761
 762                    <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div>
 763
 764
 765
 766                     <div class="long">
 767
 768                                 Applies the supplied values to the template and inserts the new node(s) before el.
 769
 770
 771
 772
 773
 774
 775                                 <dl class="detailList">
 776                                 <dt class="heading">Parameters:</dt>
 777
 778                                         <dt>
 779                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 780
 781                                         </dt>
 782                                         <dd>The context element</dd>
 783
 784                                         <dt>
 785                                                 <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>
 786
 787                                         </dt>
 788                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 789
 790                                         <dt>
 791                                                 <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>
 792
 793                                         </dt>
 794                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 795
 796                                 </dl>
 797
 798
 799
 800
 801
 802                                 <dl class="detailList">
 803                                 <dt class="heading">Returns:</dt>
 804
 805                                         <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>
 806
 807                                 </dl>
 808
 809
 810
 811
 812
 813
 814
 815                     </div>
 816                 </div>
 817
 818             </td>
 819             <td class="msource">
 820
 821                         Roo.Template
 822                 &nbsp;
 823             </td>
 824         </tr>
 825
 826
 827           <tr class="method-row config-row-alt0 expandable notInherited">
 828             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 829
 830
 831             <td class="sig">
 832                 <a id="Roo.Template-method-insertFirst"   name=".insertFirst"></a>
 833                 <div class="fixedFont">
 834                         <span class="attributes"></span><b class="itemname">insertFirst</b>
 835
 836                                  (<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>)
 837
 838
 839                                          :
 840
 841
 842                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 843
 844
 845
 846
 847
 848                 </div>
 849                 <div class="mdesc">
 850
 851                    <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div>
 852
 853
 854
 855                     <div class="long">
 856
 857                                 Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 858
 859
 860
 861
 862
 863
 864                                 <dl class="detailList">
 865                                 <dt class="heading">Parameters:</dt>
 866
 867                                         <dt>
 868                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 869
 870                                         </dt>
 871                                         <dd>The context element</dd>
 872
 873                                         <dt>
 874                                                 <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>
 875
 876                                         </dt>
 877                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 878
 879                                         <dt>
 880                                                 <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>
 881
 882                                         </dt>
 883                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 884
 885                                 </dl>
 886
 887
 888
 889
 890
 891                                 <dl class="detailList">
 892                                 <dt class="heading">Returns:</dt>
 893
 894                                         <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>
 895
 896                                 </dl>
 897
 898
 899
 900
 901
 902
 903
 904                     </div>
 905                 </div>
 906
 907             </td>
 908             <td class="msource">
 909
 910                         Roo.Template
 911                 &nbsp;
 912             </td>
 913         </tr>
 914
 915
 916           <tr class="method-row config-row-alt1 expandable notInherited">
 917             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 918
 919
 920             <td class="sig">
 921                 <a id="Roo.Template-method-overwrite"   name=".overwrite"></a>
 922                 <div class="fixedFont">
 923                         <span class="attributes"></span><b class="itemname">overwrite</b>
 924
 925                                  (<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>)
 926
 927
 928                                          :
 929
 930
 931                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 932
 933
 934
 935
 936
 937                 </div>
 938                 <div class="mdesc">
 939
 940                    <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div>
 941
 942
 943
 944                     <div class="long">
 945
 946                                 Applies the supplied values to the template and overwrites the content of el with the new node(s).
 947
 948
 949
 950
 951
 952
 953                                 <dl class="detailList">
 954                                 <dt class="heading">Parameters:</dt>
 955
 956                                         <dt>
 957                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 958
 959                                         </dt>
 960                                         <dd>The context element</dd>
 961
 962                                         <dt>
 963                                                 <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>
 964
 965                                         </dt>
 966                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 967
 968                                         <dt>
 969                                                 <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>
 970
 971                                         </dt>
 972                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 973
 974                                 </dl>
 975
 976
 977
 978
 979
 980                                 <dl class="detailList">
 981                                 <dt class="heading">Returns:</dt>
 982
 983                                         <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>
 984
 985                                 </dl>
 986
 987
 988
 989
 990
 991
 992
 993                     </div>
 994                 </div>
 995
 996             </td>
 997             <td class="msource">
 998
 999                         Roo.Template
1000                 &nbsp;
1001             </td>
1002         </tr>
1003
1004
1005           <tr class="method-row config-row-alt0 expandable notInherited">
1006             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1007
1008
1009             <td class="sig">
1010                 <a id="Roo.Template-method-set"   name=".set"></a>
1011                 <div class="fixedFont">
1012                         <span class="attributes"></span><b class="itemname">set</b>
1013
1014                                  (<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>)
1015
1016
1017                                          :
1018
1019
1020                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1021
1022
1023
1024
1025
1026                 </div>
1027                 <div class="mdesc">
1028
1029                    <div class="short">Sets the HTML used as the template and optionally compiles it.</div>
1030
1031
1032
1033                     <div class="long">
1034
1035                                 Sets the HTML used as the template and optionally compiles it.
1036
1037
1038
1039
1040
1041
1042                                 <dl class="detailList">
1043                                 <dt class="heading">Parameters:</dt>
1044
1045                                         <dt>
1046                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>html</b>
1047
1048                                         </dt>
1049                                         <dd></dd>
1050
1051                                         <dt>
1052                                                 <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>
1053
1054                                         </dt>
1055                                         <dd>(optional) True to compile the template (defaults to undefined)</dd>
1056
1057                                 </dl>
1058
1059
1060
1061
1062
1063                                 <dl class="detailList">
1064                                 <dt class="heading">Returns:</dt>
1065
1066                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
1067
1068                                 </dl>
1069
1070
1071
1072
1073
1074
1075
1076                     </div>
1077                 </div>
1078
1079             </td>
1080             <td class="msource">
1081
1082                         Roo.Template
1083                 &nbsp;
1084             </td>
1085         </tr>
1086
1087
1088     </table>
1089
1090
1091   <!-- ============================== events summary / details ======================== -->
1092
1093
1094   <a id="Roo.Template-events"></a>
1095
1096
1097
1098
1099
1100      <table cellspacing="0" class="member-table">
1101       <caption class="Empty">Events - Has None</caption>
1102      </table>
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112 <!-- ============================== footer ================================= -->
1113                 <div class="fineprint" style="clear:both">
1114
1115                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
1116                         Based on
1117                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1118                 </div>
1119         </body>
1120 </html>