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">The HTML fragment or an array of fragments to join("") or multiple arguments to join("")</div>
 138                         </div>
 139
 140
 141
 142                     </td>
 143                     <td class="msource">
 144
 145                         Roo.Template
 146
 147                     </td>
 148                 </tr>
 149
 150
 151                 <tr class="config-row expandable config-row-alt1 notInherited">
 152                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 153                     <td class="sig">
 154
 155                         <a id="Roo.Template-cfg-url" name=".url"></a>
 156                         <div class="fixedFont">
 157                                 <b  class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 158
 159
 160                         </div>
 161
 162                         <div class="mdesc">
 163                             <div class="short">The Url to load the template from.</div>
 164                         </div>
 165
 166                         <div class="mdesc">
 167                             <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>
 168                         </div>
 169
 170
 171
 172                     </td>
 173                     <td class="msource">
 174
 175                         Roo.Template
 176
 177                     </td>
 178                 </tr>
 179
 180
 181     </table>
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191   <!-- ============================== public properties ==================== -->
 192
 193
 194
 195     <a id="Roo.Template-props"></a>
 196
 197
 198
 199
 200
 201      <table cellspacing="0" class="member-table">
 202       <caption class="Empty">Public Properties - Has None</caption>
 203      </table>
 204
 205
 206
 207
 208   <!-- ============================== methods summary / details ======================== -->
 209
 210
 211   <a id="Roo.Template-methods"></a>
 212         <!-- constructor?? -->
 213
 214         <!-- static's first
 215
 216
 217         -->
 218
 219         <!-- then dynamics first -->
 220
 221
 222
 223
 224
 225
 226       <table cellspacing="0" class="member-table">
 227       <caption>Public Methods</caption>
 228         <tr>
 229             <th class="sig-header" colspan="2">Method</th>
 230             <th class="msource-header">Defined By</th>
 231
 232         </tr>
 233
 234
 235
 236
 237
 238
 239
 240           <tr class="method-row config-row-alt0 expandable notInherited">
 241             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 242
 243
 244             <td class="sig">
 245                 <a id="Roo-method-Template"   name=".Template"></a>
 246                 <div class="fixedFont">
 247                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Template</b>
 248
 249                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
 250
 251
 252
 253                 </div>
 254                 <div class="mdesc">
 255
 256
 257                         <div class="short">Create a new Roo.Template</div>
 258
 259
 260                     <div class="long">
 261
 262
 263
 264                                 Create a new Roo.Template
 265
 266
 267                                 <dl class="detailList">
 268                                 <dt class="heading">Parameters:</dt>
 269
 270                                         <dt>
 271                                                 <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>
 272
 273                                         </dt>
 274                                         <dd>- Configuration object.</dd>
 275
 276                                 </dl>
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288                     </div>
 289                 </div>
 290
 291             </td>
 292             <td class="msource">
 293                 &nbsp;
 294             </td>
 295         </tr>
 296
 297
 298           <tr class="method-row config-row-alt1 expandable notInherited">
 299             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 300
 301
 302             <td class="sig">
 303                 <a id="Roo.Template-method-from"   name=".from"></a>
 304                 <div class="fixedFont">
 305                         <span class="attributes">Roo.Template.</span><b class="itemname">from</b>
 306
 307                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>el</i></B>)
 308
 309
 310
 311                 </div>
 312                 <div class="mdesc">
 313
 314                    <div class="short">Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.</div>
 315
 316
 317
 318                     <div class="long">
 319
 320                                 Creates a template from the passed element's value (<i>display:none</i> textarea, preferred) or innerHTML.
 321
 322
 323
 324
 325
 326
 327                                 <dl class="detailList">
 328                                 <dt class="heading">Parameters:</dt>
 329
 330                                         <dt>
 331                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
 332
 333                                         </dt>
 334                                         <dd>A DOM element or its id</dd>
 335
 336                                 </dl>
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348                     </div>
 349                 </div>
 350
 351             </td>
 352             <td class="msource">
 353
 354                         Roo.Template
 355                 &nbsp;
 356             </td>
 357         </tr>
 358
 359
 360           <tr class="method-row config-row-alt0 expandable notInherited">
 361             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 362
 363
 364             <td class="sig">
 365                 <a id="Roo.Template-method-append"   name=".append"></a>
 366                 <div class="fixedFont">
 367                         <span class="attributes"></span><b class="itemname">append</b>
 368
 369                                  (<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>)
 370
 371
 372                                          :
 373
 374
 375                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 376
 377
 378
 379
 380
 381                 </div>
 382                 <div class="mdesc">
 383
 384                    <div class="short">Applies the supplied values to the template and appends the new node(s) to el.</div>
 385
 386
 387
 388                     <div class="long">
 389
 390                                 Applies the supplied values to the template and appends the new node(s) to el.
 391
 392
 393
 394
 395
 396
 397                                 <dl class="detailList">
 398                                 <dt class="heading">Parameters:</dt>
 399
 400                                         <dt>
 401                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 402
 403                                         </dt>
 404                                         <dd>The context element</dd>
 405
 406                                         <dt>
 407                                                 <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>
 408
 409                                         </dt>
 410                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 411
 412                                         <dt>
 413                                                 <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>
 414
 415                                         </dt>
 416                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 417
 418                                 </dl>
 419
 420
 421
 422
 423
 424                                 <dl class="detailList">
 425                                 <dt class="heading">Returns:</dt>
 426
 427                                         <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>
 428
 429                                 </dl>
 430
 431
 432
 433
 434
 435
 436
 437                     </div>
 438                 </div>
 439
 440             </td>
 441             <td class="msource">
 442
 443                         Roo.Template
 444                 &nbsp;
 445             </td>
 446         </tr>
 447
 448
 449           <tr class="method-row config-row-alt1 expandable notInherited">
 450             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 451
 452
 453             <td class="sig">
 454                 <a id="Roo.Template-method-apply"   name=".apply"></a>
 455                 <div class="fixedFont">
 456                         <span class="attributes"></span><b class="itemname">apply</b>
 457
 458                                  ()
 459
 460
 461
 462                 </div>
 463                 <div class="mdesc">
 464
 465                    <div class="short">Alias for {<b>link</b> <b>applyTemplate</b>}</div>
 466
 467
 468
 469                     <div class="long">
 470
 471                                 Alias for {<b>link</b> <b>applyTemplate</b>}
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488                     </div>
 489                 </div>
 490
 491             </td>
 492             <td class="msource">
 493
 494                         Roo.Template
 495                 &nbsp;
 496             </td>
 497         </tr>
 498
 499
 500           <tr class="method-row config-row-alt0 expandable notInherited">
 501             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 502
 503
 504             <td class="sig">
 505                 <a id="Roo.Template-method-applyTemplate"   name=".applyTemplate"></a>
 506                 <div class="fixedFont">
 507                         <span class="attributes"></span><b class="itemname">applyTemplate</b>
 508
 509                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
 510
 511
 512                                          :
 513
 514
 515                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 516
 517
 518
 519
 520
 521                 </div>
 522                 <div class="mdesc">
 523
 524                    <div class="short">Returns an HTML fragment of this template with the specified values applied.</div>
 525
 526
 527
 528                     <div class="long">
 529
 530                                 Returns an HTML fragment of this template with the specified values applied.
 531
 532
 533
 534
 535
 536
 537                                 <dl class="detailList">
 538                                 <dt class="heading">Parameters:</dt>
 539
 540                                         <dt>
 541                                                 <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>
 542
 543                                         </dt>
 544                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 545
 546                                 </dl>
 547
 548
 549
 550
 551
 552                                 <dl class="detailList">
 553                                 <dt class="heading">Returns:</dt>
 554
 555                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  The HTML fragment</dd>
 556
 557                                 </dl>
 558
 559
 560
 561
 562
 563
 564
 565                     </div>
 566                 </div>
 567
 568             </td>
 569             <td class="msource">
 570
 571                         Roo.Template
 572                 &nbsp;
 573             </td>
 574         </tr>
 575
 576
 577           <tr class="method-row config-row-alt1 expandable notInherited">
 578             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 579
 580
 581             <td class="sig">
 582                 <a id="Roo.Template-method-compile"   name=".compile"></a>
 583                 <div class="fixedFont">
 584                         <span class="attributes"></span><b class="itemname">compile</b>
 585
 586                                  ()
 587
 588
 589                                          :
 590
 591
 592                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 593
 594
 595
 596
 597
 598                 </div>
 599                 <div class="mdesc">
 600
 601                    <div class="short">Compiles the template into an internal function, eliminating the RegEx overhead.</div>
 602
 603
 604
 605                     <div class="long">
 606
 607                                 Compiles the template into an internal function, eliminating the RegEx overhead.
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618                                 <dl class="detailList">
 619                                 <dt class="heading">Returns:</dt>
 620
 621                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
 622
 623                                 </dl>
 624
 625
 626
 627
 628
 629
 630
 631                     </div>
 632                 </div>
 633
 634             </td>
 635             <td class="msource">
 636
 637                         Roo.Template
 638                 &nbsp;
 639             </td>
 640         </tr>
 641
 642
 643           <tr class="method-row config-row-alt0 expandable notInherited">
 644             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 645
 646
 647             <td class="sig">
 648                 <a id="Roo.Template-method-insertAfter"   name=".insertAfter"></a>
 649                 <div class="fixedFont">
 650                         <span class="attributes"></span><b class="itemname">insertAfter</b>
 651
 652                                  (<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>)
 653
 654
 655                                          :
 656
 657
 658                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 659
 660
 661
 662
 663
 664                 </div>
 665                 <div class="mdesc">
 666
 667                    <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div>
 668
 669
 670
 671                     <div class="long">
 672
 673                                 Applies the supplied values to the template and inserts the new node(s) after el.
 674
 675
 676
 677
 678
 679
 680                                 <dl class="detailList">
 681                                 <dt class="heading">Parameters:</dt>
 682
 683                                         <dt>
 684                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 685
 686                                         </dt>
 687                                         <dd>The context element</dd>
 688
 689                                         <dt>
 690                                                 <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>
 691
 692                                         </dt>
 693                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 694
 695                                         <dt>
 696                                                 <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>
 697
 698                                         </dt>
 699                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 700
 701                                 </dl>
 702
 703
 704
 705
 706
 707                                 <dl class="detailList">
 708                                 <dt class="heading">Returns:</dt>
 709
 710                                         <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>
 711
 712                                 </dl>
 713
 714
 715
 716
 717
 718
 719
 720                     </div>
 721                 </div>
 722
 723             </td>
 724             <td class="msource">
 725
 726                         Roo.Template
 727                 &nbsp;
 728             </td>
 729         </tr>
 730
 731
 732           <tr class="method-row config-row-alt1 expandable notInherited">
 733             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 734
 735
 736             <td class="sig">
 737                 <a id="Roo.Template-method-insertBefore"   name=".insertBefore"></a>
 738                 <div class="fixedFont">
 739                         <span class="attributes"></span><b class="itemname">insertBefore</b>
 740
 741                                  (<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>)
 742
 743
 744                                          :
 745
 746
 747                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 748
 749
 750
 751
 752
 753                 </div>
 754                 <div class="mdesc">
 755
 756                    <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div>
 757
 758
 759
 760                     <div class="long">
 761
 762                                 Applies the supplied values to the template and inserts the new node(s) before el.
 763
 764
 765
 766
 767
 768
 769                                 <dl class="detailList">
 770                                 <dt class="heading">Parameters:</dt>
 771
 772                                         <dt>
 773                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 774
 775                                         </dt>
 776                                         <dd>The context element</dd>
 777
 778                                         <dt>
 779                                                 <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>
 780
 781                                         </dt>
 782                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 783
 784                                         <dt>
 785                                                 <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>
 786
 787                                         </dt>
 788                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 789
 790                                 </dl>
 791
 792
 793
 794
 795
 796                                 <dl class="detailList">
 797                                 <dt class="heading">Returns:</dt>
 798
 799                                         <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>
 800
 801                                 </dl>
 802
 803
 804
 805
 806
 807
 808
 809                     </div>
 810                 </div>
 811
 812             </td>
 813             <td class="msource">
 814
 815                         Roo.Template
 816                 &nbsp;
 817             </td>
 818         </tr>
 819
 820
 821           <tr class="method-row config-row-alt0 expandable notInherited">
 822             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 823
 824
 825             <td class="sig">
 826                 <a id="Roo.Template-method-insertFirst"   name=".insertFirst"></a>
 827                 <div class="fixedFont">
 828                         <span class="attributes"></span><b class="itemname">insertFirst</b>
 829
 830                                  (<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>)
 831
 832
 833                                          :
 834
 835
 836                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 837
 838
 839
 840
 841
 842                 </div>
 843                 <div class="mdesc">
 844
 845                    <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div>
 846
 847
 848
 849                     <div class="long">
 850
 851                                 Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 852
 853
 854
 855
 856
 857
 858                                 <dl class="detailList">
 859                                 <dt class="heading">Parameters:</dt>
 860
 861                                         <dt>
 862                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 863
 864                                         </dt>
 865                                         <dd>The context element</dd>
 866
 867                                         <dt>
 868                                                 <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>
 869
 870                                         </dt>
 871                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 872
 873                                         <dt>
 874                                                 <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>
 875
 876                                         </dt>
 877                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 878
 879                                 </dl>
 880
 881
 882
 883
 884
 885                                 <dl class="detailList">
 886                                 <dt class="heading">Returns:</dt>
 887
 888                                         <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>
 889
 890                                 </dl>
 891
 892
 893
 894
 895
 896
 897
 898                     </div>
 899                 </div>
 900
 901             </td>
 902             <td class="msource">
 903
 904                         Roo.Template
 905                 &nbsp;
 906             </td>
 907         </tr>
 908
 909
 910           <tr class="method-row config-row-alt1 expandable notInherited">
 911             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 912
 913
 914             <td class="sig">
 915                 <a id="Roo.Template-method-overwrite"   name=".overwrite"></a>
 916                 <div class="fixedFont">
 917                         <span class="attributes"></span><b class="itemname">overwrite</b>
 918
 919                                  (<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>)
 920
 921
 922                                          :
 923
 924
 925                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 926
 927
 928
 929
 930
 931                 </div>
 932                 <div class="mdesc">
 933
 934                    <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div>
 935
 936
 937
 938                     <div class="long">
 939
 940                                 Applies the supplied values to the template and overwrites the content of el with the new node(s).
 941
 942
 943
 944
 945
 946
 947                                 <dl class="detailList">
 948                                 <dt class="heading">Parameters:</dt>
 949
 950                                         <dt>
 951                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 952
 953                                         </dt>
 954                                         <dd>The context element</dd>
 955
 956                                         <dt>
 957                                                 <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>
 958
 959                                         </dt>
 960                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 961
 962                                         <dt>
 963                                                 <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>
 964
 965                                         </dt>
 966                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 967
 968                                 </dl>
 969
 970
 971
 972
 973
 974                                 <dl class="detailList">
 975                                 <dt class="heading">Returns:</dt>
 976
 977                                         <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>
 978
 979                                 </dl>
 980
 981
 982
 983
 984
 985
 986
 987                     </div>
 988                 </div>
 989
 990             </td>
 991             <td class="msource">
 992
 993                         Roo.Template
 994                 &nbsp;
 995             </td>
 996         </tr>
 997
 998
 999           <tr class="method-row config-row-alt0 expandable notInherited">
1000             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1001
1002
1003             <td class="sig">
1004                 <a id="Roo.Template-method-set"   name=".set"></a>
1005                 <div class="fixedFont">
1006                         <span class="attributes"></span><b class="itemname">set</b>
1007
1008                                  (<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>)
1009
1010
1011                                          :
1012
1013
1014                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1015
1016
1017
1018
1019
1020                 </div>
1021                 <div class="mdesc">
1022
1023                    <div class="short">Sets the HTML used as the template and optionally compiles it.</div>
1024
1025
1026
1027                     <div class="long">
1028
1029                                 Sets the HTML used as the template and optionally compiles it.
1030
1031
1032
1033
1034
1035
1036                                 <dl class="detailList">
1037                                 <dt class="heading">Parameters:</dt>
1038
1039                                         <dt>
1040                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>html</b>
1041
1042                                         </dt>
1043                                         <dd></dd>
1044
1045                                         <dt>
1046                                                 <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>
1047
1048                                         </dt>
1049                                         <dd>(optional) True to compile the template (defaults to undefined)</dd>
1050
1051                                 </dl>
1052
1053
1054
1055
1056
1057                                 <dl class="detailList">
1058                                 <dt class="heading">Returns:</dt>
1059
1060                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
1061
1062                                 </dl>
1063
1064
1065
1066
1067
1068
1069
1070                     </div>
1071                 </div>
1072
1073             </td>
1074             <td class="msource">
1075
1076                         Roo.Template
1077                 &nbsp;
1078             </td>
1079         </tr>
1080
1081
1082     </table>
1083
1084
1085   <!-- ============================== events summary / details ======================== -->
1086
1087
1088   <a id="Roo.Template-events"></a>
1089
1090
1091
1092
1093
1094      <table cellspacing="0" class="member-table">
1095       <caption class="Empty">Events - Has None</caption>
1096      </table>
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106 <!-- ============================== footer ================================= -->
1107                 <div class="fineprint" style="clear:both">
1108
1109                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Wed May 02 2012 11:27:34 GMT+0800 (HKT)
1110                         Based on
1111                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1112                 </div>
1113         </body>
1114 </html>