git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.XTemplate.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.XTemplate</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.XTemplate-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.XTemplate-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.XTemplate-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.XTemplate-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.XTemplate
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.XTemplate
  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_XTemplate.js.html">Roo/XTemplate.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">XTemplate</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         Provides a template that can have nested templates for loops or conditionals. The syntax is:<br/><pre><code><br/>var t = new Roo.XTemplate(<br/>        '&lt;select name="{name}"&gt;',<br/>            '&lt;tpl for="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;',<br/>      '&lt;/select&gt;'<br/>);<br/> <br/>// then append, applying the master template values<br/> </code></pre><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;tpl for="a_variable or condition.."&gt;&lt;/tpl&gt;<br/>        &lt;tpl if="a_variable or condition"&gt;&lt;/tpl&gt;<br/>        &lt;tpl exec="some javascript"&gt;&lt;/tpl&gt;<br/>        &lt;tpl name="named_template"&gt;&lt;/tpl&gt; (experimental)<br/>  <br/>        &lt;tpl for="."&gt;&lt;/tpl&gt; - just iterate the property..<br/>        &lt;tpl for=".."&gt;&lt;/tpl&gt; - iterates with the parent (probably the template) <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.XTemplate';">[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.XTemplate.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.XTemplate-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.XTemplate-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.XTemplate-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-XTemplate"   name=".XTemplate"></a>
 258                 <div class="fixedFont">
 259                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">XTemplate</b>
 260
 261                                  ()
 262
 263
 264
 265                 </div>
 266                 <div class="mdesc">
 267
 268
 269                         <div class="short">Create a new Roo.XTemplate</div>
 270
 271
 272                     <div class="long">
 273
 274
 275
 276                                 Create a new Roo.XTemplate
 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.XTemplate-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.XTemplate
 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.XTemplate-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.XTemplate
 636                 &nbsp;
 637             </td>
 638         </tr>
 639
 640
 641           <tr class="method-row config-row-alt0 expandable">
 642             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 643
 644
 645             <td class="sig">
 646                 <a id="Roo.Template-method-insertAfter"   name=".insertAfter"></a>
 647                 <div class="fixedFont">
 648                         <span class="attributes"></span><b class="itemname">insertAfter</b>
 649
 650                                  (<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>)
 651
 652
 653                                          :
 654
 655
 656                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 657
 658
 659
 660
 661
 662                 </div>
 663                 <div class="mdesc">
 664
 665                    <div class="short">Applies the supplied values to the template and inserts the new node(s) after el.</div>
 666
 667
 668
 669                     <div class="long">
 670
 671                                 Applies the supplied values to the template and inserts the new node(s) after el.
 672
 673
 674
 675
 676
 677
 678                                 <dl class="detailList">
 679                                 <dt class="heading">Parameters:</dt>
 680
 681                                         <dt>
 682                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 683
 684                                         </dt>
 685                                         <dd>The context element</dd>
 686
 687                                         <dt>
 688                                                 <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>
 689
 690                                         </dt>
 691                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 692
 693                                         <dt>
 694                                                 <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>
 695
 696                                         </dt>
 697                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 698
 699                                 </dl>
 700
 701
 702
 703
 704
 705                                 <dl class="detailList">
 706                                 <dt class="heading">Returns:</dt>
 707
 708                                         <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>
 709
 710                                 </dl>
 711
 712
 713
 714
 715
 716
 717
 718                     </div>
 719                 </div>
 720
 721             </td>
 722             <td class="msource">
 723
 724                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 725                 &nbsp;
 726             </td>
 727         </tr>
 728
 729
 730           <tr class="method-row config-row-alt1 expandable">
 731             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 732
 733
 734             <td class="sig">
 735                 <a id="Roo.Template-method-insertBefore"   name=".insertBefore"></a>
 736                 <div class="fixedFont">
 737                         <span class="attributes"></span><b class="itemname">insertBefore</b>
 738
 739                                  (<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>)
 740
 741
 742                                          :
 743
 744
 745                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 746
 747
 748
 749
 750
 751                 </div>
 752                 <div class="mdesc">
 753
 754                    <div class="short">Applies the supplied values to the template and inserts the new node(s) before el.</div>
 755
 756
 757
 758                     <div class="long">
 759
 760                                 Applies the supplied values to the template and inserts the new node(s) before el.
 761
 762
 763
 764
 765
 766
 767                                 <dl class="detailList">
 768                                 <dt class="heading">Parameters:</dt>
 769
 770                                         <dt>
 771                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 772
 773                                         </dt>
 774                                         <dd>The context element</dd>
 775
 776                                         <dt>
 777                                                 <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>
 778
 779                                         </dt>
 780                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 781
 782                                         <dt>
 783                                                 <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>
 784
 785                                         </dt>
 786                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 787
 788                                 </dl>
 789
 790
 791
 792
 793
 794                                 <dl class="detailList">
 795                                 <dt class="heading">Returns:</dt>
 796
 797                                         <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>
 798
 799                                 </dl>
 800
 801
 802
 803
 804
 805
 806
 807                     </div>
 808                 </div>
 809
 810             </td>
 811             <td class="msource">
 812
 813                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 814                 &nbsp;
 815             </td>
 816         </tr>
 817
 818
 819           <tr class="method-row config-row-alt0 expandable">
 820             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 821
 822
 823             <td class="sig">
 824                 <a id="Roo.Template-method-insertFirst"   name=".insertFirst"></a>
 825                 <div class="fixedFont">
 826                         <span class="attributes"></span><b class="itemname">insertFirst</b>
 827
 828                                  (<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>)
 829
 830
 831                                          :
 832
 833
 834                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 835
 836
 837
 838
 839
 840                 </div>
 841                 <div class="mdesc">
 842
 843                    <div class="short">Applies the supplied values to the template and inserts the new node(s) as the first child of el.</div>
 844
 845
 846
 847                     <div class="long">
 848
 849                                 Applies the supplied values to the template and inserts the new node(s) as the first child of el.
 850
 851
 852
 853
 854
 855
 856                                 <dl class="detailList">
 857                                 <dt class="heading">Parameters:</dt>
 858
 859                                         <dt>
 860                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 861
 862                                         </dt>
 863                                         <dd>The context element</dd>
 864
 865                                         <dt>
 866                                                 <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>
 867
 868                                         </dt>
 869                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 870
 871                                         <dt>
 872                                                 <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>
 873
 874                                         </dt>
 875                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 876
 877                                 </dl>
 878
 879
 880
 881
 882
 883                                 <dl class="detailList">
 884                                 <dt class="heading">Returns:</dt>
 885
 886                                         <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>
 887
 888                                 </dl>
 889
 890
 891
 892
 893
 894
 895
 896                     </div>
 897                 </div>
 898
 899             </td>
 900             <td class="msource">
 901
 902                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 903                 &nbsp;
 904             </td>
 905         </tr>
 906
 907
 908           <tr class="method-row config-row-alt1 expandable">
 909             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 910
 911
 912             <td class="sig">
 913                 <a id="Roo.Template-method-overwrite"   name=".overwrite"></a>
 914                 <div class="fixedFont">
 915                         <span class="attributes"></span><b class="itemname">overwrite</b>
 916
 917                                  (<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>)
 918
 919
 920                                          :
 921
 922
 923                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Roo.Element
 924
 925
 926
 927
 928
 929                 </div>
 930                 <div class="mdesc">
 931
 932                    <div class="short">Applies the supplied values to the template and overwrites the content of el with the new node(s).</div>
 933
 934
 935
 936                     <div class="long">
 937
 938                                 Applies the supplied values to the template and overwrites the content of el with the new node(s).
 939
 940
 941
 942
 943
 944
 945                                 <dl class="detailList">
 946                                 <dt class="heading">Parameters:</dt>
 947
 948                                         <dt>
 949                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 950
 951                                         </dt>
 952                                         <dd>The context element</dd>
 953
 954                                         <dt>
 955                                                 <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>
 956
 957                                         </dt>
 958                                         <dd>The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})</dd>
 959
 960                                         <dt>
 961                                                 <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>
 962
 963                                         </dt>
 964                                         <dd>(optional) true to return a Roo.Element (defaults to undefined)</dd>
 965
 966                                 </dl>
 967
 968
 969
 970
 971
 972                                 <dl class="detailList">
 973                                 <dt class="heading">Returns:</dt>
 974
 975                                         <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>
 976
 977                                 </dl>
 978
 979
 980
 981
 982
 983
 984
 985                     </div>
 986                 </div>
 987
 988             </td>
 989             <td class="msource">
 990
 991                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
 992                 &nbsp;
 993             </td>
 994         </tr>
 995
 996
 997           <tr class="method-row config-row-alt0 expandable">
 998             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 999
1000
1001             <td class="sig">
1002                 <a id="Roo.Template-method-set"   name=".set"></a>
1003                 <div class="fixedFont">
1004                         <span class="attributes"></span><b class="itemname">set</b>
1005
1006                                  (<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>)
1007
1008
1009                                          :
1010
1011
1012                                                 <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1013
1014
1015
1016
1017
1018                 </div>
1019                 <div class="mdesc">
1020
1021                    <div class="short">Sets the HTML used as the template and optionally compiles it.</div>
1022
1023
1024
1025                     <div class="long">
1026
1027                                 Sets the HTML used as the template and optionally compiles it.
1028
1029
1030
1031
1032
1033
1034                                 <dl class="detailList">
1035                                 <dt class="heading">Parameters:</dt>
1036
1037                                         <dt>
1038                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>html</b>
1039
1040                                         </dt>
1041                                         <dd></dd>
1042
1043                                         <dt>
1044                                                 <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>
1045
1046                                         </dt>
1047                                         <dd>(optional) True to compile the template (defaults to undefined)</dd>
1048
1049                                 </dl>
1050
1051
1052
1053
1054
1055                                 <dl class="detailList">
1056                                 <dt class="heading">Returns:</dt>
1057
1058                                         <dd><span class="fixedFont"><a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a></span>  this</dd>
1059
1060                                 </dl>
1061
1062
1063
1064
1065
1066
1067
1068                     </div>
1069                 </div>
1070
1071             </td>
1072             <td class="msource">
1073
1074                         <a href="./Roo.Template.html#constructor" roo:cls="Roo.Template.html#constructor">Roo.Template</a>
1075                 &nbsp;
1076             </td>
1077         </tr>
1078
1079
1080     </table>
1081
1082
1083   <!-- ============================== events summary / details ======================== -->
1084
1085
1086   <a id="Roo.XTemplate-events"></a>
1087
1088
1089
1090
1091
1092      <table cellspacing="0" class="member-table">
1093       <caption class="Empty">Events - Has None</caption>
1094      </table>
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104 <!-- ============================== footer ================================= -->
1105                 <div class="fineprint" style="clear:both">
1106
1107                         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)
1108                         Based on
1109                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1110                 </div>
1111         </body>
1112 </html>