git.roojs.org Git - roojs1/blob - docs/symbols/Roo.MasterTemplate.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.MasterTemplate</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.MasterTemplate-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.MasterTemplate-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.MasterTemplate-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.MasterTemplate-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.MasterTemplate
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.MasterTemplate
  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_MasterTemplate.js.html">Roo/MasterTemplate.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">MasterTemplate</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 child templates. The syntax is:<br/><pre><code><br/>var t = new Roo.MasterTemplate(<br/>      '&lt;select name="{name}"&gt;',<br/>            '&lt;tpl name="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;',<br/>     '&lt;/select&gt;'<br/>);<br/>t.add('options', {value: 'foo', text: 'bar'});<br/>// or you can add multiple child elements in one shot<br/>t.addAll('options', [<br/>    {value: 'foo', text: 'bar'},<br/>    {value: 'foo2', text: 'bar2'},<br/>    {value: 'foo3', text: 'bar3'}<br/>]);<br/>// then append, applying the master template values<br/>t.append('my-form', {name: 'my-select'});<br/></code></pre><br/>A name attribute for the child template is not required if you have only one child<br/>template or you want to refer to them by index.
  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.MasterTemplate';">[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.MasterTemplate.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.MasterTemplate-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.MasterTemplate-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.MasterTemplate-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo-method-MasterTemplate"   name=".MasterTemplate"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">MasterTemplate</b>
 183
 184                                  ()
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.MasterTemplate</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.MasterTemplate
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212                     </div>
 213                 </div>
 214
 215             </td>
 216             <td class="msource">
 217                 &nbsp;
 218             </td>
 219         </tr>
 220
 221
 222           <tr class="method-row config-row-alt1 expandable notInherited">
 223             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 224
 225
 226             <td class="sig">
 227                 <a id="Roo.MasterTemplate-method-from"   name=".from"></a>
 228                 <div class="fixedFont">
 229                         <span class="attributes">Roo.MasterTemplate.</span><b class="itemname">from</b>
 230
 231                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <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>config</i></B>)
 232
 233
 234
 235                 </div>
 236                 <div class="mdesc">
 237
 238                    <div class="short">Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.</div>
 239
 240
 241
 242                     <div class="long">
 243
 244                                 Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g.<br/>var tpl = Roo.MasterTemplate.from('element-id');
 245
 246
 247
 248
 249
 250
 251                                 <dl class="detailList">
 252                                 <dt class="heading">Parameters:</dt>
 253
 254                                         <dt>
 255                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>el</b>
 256
 257                                         </dt>
 258                                         <dd></dd>
 259
 260                                         <dt>
 261                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 262
 263                                         </dt>
 264                                         <dd></dd>
 265
 266                                 </dl>
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278                     </div>
 279                 </div>
 280
 281             </td>
 282             <td class="msource">
 283
 284                         Roo.MasterTemplate
 285                 &nbsp;
 286             </td>
 287         </tr>
 288
 289
 290           <tr class="method-row config-row-alt0 expandable notInherited">
 291             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 292
 293
 294             <td class="sig">
 295                 <a id="Roo.MasterTemplate-method-add"   name=".add"></a>
 296                 <div class="fixedFont">
 297                         <span class="attributes"></span><b class="itemname">add</b>
 298
 299                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>name</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
 300
 301
 302                                          :
 303
 304
 305                                                 MasterTemplate
 306
 307
 308
 309
 310
 311                 </div>
 312                 <div class="mdesc">
 313
 314                    <div class="short">Applies the passed values to a child template.</div>
 315
 316
 317
 318                     <div class="long">
 319
 320                                 Applies the passed values to a child template.
 321
 322
 323
 324
 325
 326
 327                                 <dl class="detailList">
 328                                 <dt class="heading">Parameters:</dt>
 329
 330                                         <dt>
 331                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>name</b>
 332
 333                                         </dt>
 334                                         <dd>(optional) The name or index of the child template</dd>
 335
 336                                         <dt>
 337                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span>  <b>values</b>
 338
 339                                         </dt>
 340                                         <dd>The values to be applied to the template</dd>
 341
 342                                 </dl>
 343
 344
 345
 346
 347
 348                                 <dl class="detailList">
 349                                 <dt class="heading">Returns:</dt>
 350
 351                                         <dd><span class="fixedFont">MasterTemplate</span>  this</dd>
 352
 353                                 </dl>
 354
 355
 356
 357
 358
 359
 360
 361                     </div>
 362                 </div>
 363
 364             </td>
 365             <td class="msource">
 366
 367                         Roo.MasterTemplate
 368                 &nbsp;
 369             </td>
 370         </tr>
 371
 372
 373           <tr class="method-row config-row-alt1 expandable notInherited">
 374             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 375
 376
 377             <td class="sig">
 378                 <a id="Roo.MasterTemplate-method-addAll"   name=".addAll"></a>
 379                 <div class="fixedFont">
 380                         <span class="attributes"></span><b class="itemname">addAll</b>
 381
 382                                  ()
 383
 384
 385
 386                 </div>
 387                 <div class="mdesc">
 388
 389                    <div class="short">Alias for fill().</div>
 390
 391
 392
 393                     <div class="long">
 394
 395                                 Alias for fill().
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412                     </div>
 413                 </div>
 414
 415             </td>
 416             <td class="msource">
 417
 418                         Roo.MasterTemplate
 419                 &nbsp;
 420             </td>
 421         </tr>
 422
 423
 424           <tr class="method-row config-row-alt0 expandable notInherited">
 425             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 426
 427
 428             <td class="sig">
 429                 <a id="Roo.MasterTemplate-method-fill"   name=".fill"></a>
 430                 <div class="fixedFont">
 431                         <span class="attributes"></span><b class="itemname">fill</b>
 432
 433                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>name</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</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>reset</i></B>)
 434
 435
 436                                          :
 437
 438
 439                                                 MasterTemplate
 440
 441
 442
 443
 444
 445                 </div>
 446                 <div class="mdesc">
 447
 448                    <div class="short">Applies all the passed values to a child template.</div>
 449
 450
 451
 452                     <div class="long">
 453
 454                                 Applies all the passed values to a child template.
 455
 456
 457
 458
 459
 460
 461                                 <dl class="detailList">
 462                                 <dt class="heading">Parameters:</dt>
 463
 464                                         <dt>
 465                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>name</b>
 466
 467                                         </dt>
 468                                         <dd>(optional) The name or index of the child template</dd>
 469
 470                                         <dt>
 471                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  <b>values</b>
 472
 473                                         </dt>
 474                                         <dd>The values to be applied to the template, this should be an array of objects.</dd>
 475
 476                                         <dt>
 477                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>reset</b>
 478
 479                                         </dt>
 480                                         <dd>(optional) True to reset the template first</dd>
 481
 482                                 </dl>
 483
 484
 485
 486
 487
 488                                 <dl class="detailList">
 489                                 <dt class="heading">Returns:</dt>
 490
 491                                         <dd><span class="fixedFont">MasterTemplate</span>  this</dd>
 492
 493                                 </dl>
 494
 495
 496
 497
 498
 499
 500
 501                     </div>
 502                 </div>
 503
 504             </td>
 505             <td class="msource">
 506
 507                         Roo.MasterTemplate
 508                 &nbsp;
 509             </td>
 510         </tr>
 511
 512
 513           <tr class="method-row config-row-alt1 expandable notInherited">
 514             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 515
 516
 517             <td class="sig">
 518                 <a id="Roo.MasterTemplate-method-reset"   name=".reset"></a>
 519                 <div class="fixedFont">
 520                         <span class="attributes"></span><b class="itemname">reset</b>
 521
 522                                  ()
 523
 524
 525                                          :
 526
 527
 528                                                 MasterTemplate
 529
 530
 531
 532
 533
 534                 </div>
 535                 <div class="mdesc">
 536
 537                    <div class="short">Resets the template for reuse</div>
 538
 539
 540
 541                     <div class="long">
 542
 543                                 Resets the template for reuse
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554                                 <dl class="detailList">
 555                                 <dt class="heading">Returns:</dt>
 556
 557                                         <dd><span class="fixedFont">MasterTemplate</span>  this</dd>
 558
 559                                 </dl>
 560
 561
 562
 563
 564
 565
 566
 567                     </div>
 568                 </div>
 569
 570             </td>
 571             <td class="msource">
 572
 573                         Roo.MasterTemplate
 574                 &nbsp;
 575             </td>
 576         </tr>
 577
 578
 579     </table>
 580
 581
 582   <!-- ============================== events summary / details ======================== -->
 583
 584
 585   <a id="Roo.MasterTemplate-events"></a>
 586
 587
 588
 589
 590
 591      <table cellspacing="0" class="member-table">
 592       <caption class="Empty">Events - Has None</caption>
 593      </table>
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603 <!-- ============================== footer ================================= -->
 604                 <div class="fineprint" style="clear:both">
 605
 606                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:46 GMT+0800 (HKT)
 607                         Based on
 608                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 609                 </div>
 610         </body>
 611 </html>