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