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