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