git.roojs.org Git - roojs1/blob - docs/symbols/Roo.XComponent.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.XComponent</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.XComponent-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.XComponent-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.XComponent-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.XComponent-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.XComponent
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.XComponent
  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_XComponent.js.html">Roo/XComponent.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">XComponent</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A delayed Element creator...<br/>Or a way to group chunks of interface together.<br/>technically this is a wrapper around a tree of Roo elements (which defines a 'module'),<br/> used in conjunction with XComponent.build() it will create an instance of each element,<br/> then call addxtype() to build the User interface.<br/><br/>Mypart.xyx = new Roo.XComponent({<br/><br/>    parent : 'Mypart.xyz', // empty == document.element.!!<br/>    order : '001',<br/>    name : 'xxxx'<br/>    region : 'xxxx'<br/>    disabled : function() {} <br/>     <br/>    tree : function() { // return an tree of xtype declared components<br/>        var MODULE = this;<br/>        return <br/>        {<br/>            xtype : 'NestedLayoutPanel',<br/>            // technicall<br/>        }<br/>     ]<br/>})<br/><br/><br/>It can be used to build a big heiracy, with parent etc.<br/>or you can just use this to render a single compoent to a dom element<br/>MYPART.render(Roo.Element | String(id) | dom_element )<br/><br/><br/>Usage patterns.<br/><br/>Classic Roo<br/><br/>Roo is designed primarily as a single page application, so the UI build for a standard interface will<br/>expect a single 'TOP' level module normally indicated by the 'parent' of the XComponent definition being defined as false.<br/><br/>Each sub module is expected to have a parent pointing to the class name of it's parent module.<br/><br/>When the top level is false, a 'Roo.BorderLayout' is created and the element is flagged as 'topModule'<br/>- if mulitple topModules exist, the last one is defined as the top module.<br/><br/>Embeded Roo<br/><br/>When the top level or multiple modules are to embedded into a existing HTML page,<br/>the parent element can container '<b>id</b>' of the element where the module will be drawn.<br/><br/>Bootstrap Roo<br/><br/>Unlike classic Roo, the bootstrap tends not to be used as a single page.<br/>it relies more on a include mechanism, where sub modules are included into an outer page.<br/>This is normally managed by the builder tools using Roo.apply( options, Included.Sub.Module )<br/><br/>Bootstrap Roo Included elements<br/><br/>Our builder application needs the ability to preview these sub compoennts. They will normally have parent=false set,<br/>hence confusing the component builder as it thinks there are multiple top level elements. <br/><br/>String Over-ride & Translations<br/><br/>Our builder application writes all the strings as _strings and _named_strings. This is to enable the translation of elements,<br/>and also the 'overlaying of string values - needed when different versions of the same application with different text content<br/>are needed. <b>see</b> Roo.XComponent.overlayString
  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.XComponent';">[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.XComponent.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.XComponent-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 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.XComponent-cfg-disabled" name=".disabled"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">disabled</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>|boolean
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">If this module is disabled by some rule, return true from the funtion</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">
 144                     If this module is disabled by some rule, return true from the funtion
 145
 146                 </div>
 147                         </div>
 148
 149
 150
 151                     </td>
 152                     <td class="msource">
 153
 154                         Roo.XComponent
 155
 156                     </td>
 157                 </tr>
 158
 159
 160                 <tr class="config-row expandable config-row-alt1 notInherited">
 161                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 162                     <td class="sig">
 163
 164                         <a id="Roo.XComponent-cfg-items" name=".items"></a>
 165                         <div class="fixedFont">
 166                                 <b  class="itemname">items</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 167
 168
 169                         </div>
 170
 171                         <div class="mdesc">
 172                             <div class="short">A single item array - the first element is the root of the tree.</div>
 173                         </div>
 174
 175                         <div class="mdesc">
 176                             <div class="long">
 177                     A single item array - the first element is the root of the tree..<br/>It's done this way to stay compatible with the Xtype system...
 178
 179                 </div>
 180                         </div>
 181
 182
 183
 184                     </td>
 185                     <td class="msource">
 186
 187                         Roo.XComponent
 188
 189                     </td>
 190                 </tr>
 191
 192
 193                 <tr class="config-row expandable config-row-alt0">
 194                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 195                     <td class="sig">
 196
 197                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 198                         <div class="fixedFont">
 199                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 200
 201
 202                         </div>
 203
 204                         <div class="mdesc">
 205                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 206                         </div>
 207
 208                         <div class="mdesc">
 209                             <div class="long">
 210                     list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre>
 211
 212                 </div>
 213                         </div>
 214
 215
 216
 217                     </td>
 218                     <td class="msource">
 219
 220                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 221
 222                     </td>
 223                 </tr>
 224
 225
 226                 <tr class="config-row expandable config-row-alt1 notInherited">
 227                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 228                     <td class="sig">
 229
 230                         <a id="Roo.XComponent-cfg-name" name=".name"></a>
 231                         <div class="fixedFont">
 232                                 <b  class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 233
 234
 235                         </div>
 236
 237                         <div class="mdesc">
 238                             <div class="short">String to display while loading.</div>
 239                         </div>
 240
 241                         <div class="mdesc">
 242                             <div class="long">
 243                     String to display while loading.
 244
 245                 </div>
 246                         </div>
 247
 248
 249
 250                     </td>
 251                     <td class="msource">
 252
 253                         Roo.XComponent
 254
 255                     </td>
 256                 </tr>
 257
 258
 259                 <tr class="config-row expandable config-row-alt0 notInherited">
 260                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 261                     <td class="sig">
 262
 263                         <a id="Roo.XComponent-cfg-order" name=".order"></a>
 264                         <div class="fixedFont">
 265                                 <b  class="itemname">order</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 266
 267
 268                         </div>
 269
 270                         <div class="mdesc">
 271                             <div class="short">Used to set the order in which elements are created (usefull for multiple tabs)</div>
 272                         </div>
 273
 274                         <div class="mdesc">
 275                             <div class="long">
 276                     Used to set the order in which elements are created (usefull for multiple tabs)
 277
 278                 </div>
 279                         </div>
 280
 281
 282
 283                     </td>
 284                     <td class="msource">
 285
 286                         Roo.XComponent
 287
 288                     </td>
 289                 </tr>
 290
 291
 292                 <tr class="config-row expandable config-row-alt1 notInherited">
 293                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 294                     <td class="sig">
 295
 296                         <a id="Roo.XComponent-cfg-parent" name=".parent"></a>
 297                         <div class="fixedFont">
 298                                 <b  class="itemname">parent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 299
 300
 301                         </div>
 302
 303                         <div class="mdesc">
 304                             <div class="short">Name of parent element which it get xtype added to.</div>
 305                         </div>
 306
 307                         <div class="mdesc">
 308                             <div class="long">
 309                     Name of parent element which it get xtype added to..
 310
 311                 </div>
 312                         </div>
 313
 314
 315
 316                     </td>
 317                     <td class="msource">
 318
 319                         Roo.XComponent
 320
 321                     </td>
 322                 </tr>
 323
 324
 325                 <tr class="config-row expandable config-row-alt0 notInherited">
 326                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 327                     <td class="sig">
 328
 329                         <a id="Roo.XComponent-cfg-region" name=".region"></a>
 330                         <div class="fixedFont">
 331                                 <b  class="itemname">region</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 332
 333
 334                         </div>
 335
 336                         <div class="mdesc">
 337                             <div class="short">Region to render component to (defaults to center)</div>
 338                         </div>
 339
 340                         <div class="mdesc">
 341                             <div class="long">
 342                     Region to render component to (defaults to center)
 343
 344                 </div>
 345                         </div>
 346
 347
 348
 349                     </td>
 350                     <td class="msource">
 351
 352                         Roo.XComponent
 353
 354                     </td>
 355                 </tr>
 356
 357
 358     </table>
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368   <!-- ============================== public properties ==================== -->
 369
 370
 371
 372     <a id="Roo.XComponent-props"></a>
 373
 374
 375
 376
 377
 378
 379
 380       <table cellspacing="0" class="member-table">
 381       <caption>Public Properties </caption>
 382         <tr>
 383             <th class="sig-header" colspan="2">Property</th>
 384             <th class="sig-header">Description</th>
 385             <th class="msource-header">Defined By</th>
 386         </tr>
 387
 388
 389
 390
 391
 392
 393
 394
 395           <tr class="property-row config-row-alt0 notInherited">
 396             <td class="micon">
 397                 <a class="exi" href="#expand">&nbsp;</a>
 398             </td>
 399             <td class="sig">
 400                <a id="Roo.XComponent-prop-buildCompleted" name=".buildCompleted"></a>
 401                <div class="fixedFont">
 402                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">buildCompleted</b> :
 403                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 404                      </div>
 405             </td>
 406             <td class="sig">
 407                 <div class="mdesc">
 408
 409
 410                    <div class="short">
 411                         True when the builder has completed building the interface.
 412
 413
 414
 415                    </div>
 416
 417                     <div class="long">
 418
 419                         True when the builder has completed building the interface.
 420
 421                 </div>
 422                 </div>
 423             </td>
 424
 425             <td class="msource">
 426             Roo.XComponent
 427             </td>
 428
 429           </tr>
 430
 431
 432
 433
 434           <tr class="property-row config-row-alt1 notInherited">
 435             <td class="micon">
 436                 <a class="exi" href="#expand">&nbsp;</a>
 437             </td>
 438             <td class="sig">
 439                <a id="Roo.XComponent-prop-build_from_html" name=".build_from_html"></a>
 440                <div class="fixedFont">
 441                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">build_from_html</b> :
 442                      <span type="etype">(default false)</span>
 443                      </div>
 444             </td>
 445             <td class="sig">
 446                 <div class="mdesc">
 447
 448
 449                    <div class="short">
 450                         Build elements from html - used by bootstrap HTML stuff <br/>   - this is cleared after build is completed
 451
 452
 453
 454                    </div>
 455
 456                     <div class="long">
 457
 458                         Build elements from html - used by bootstrap HTML stuff <br/>   - this is cleared after build is completed
 459
 460                 </div>
 461                 </div>
 462             </td>
 463
 464             <td class="msource">
 465             Roo.XComponent
 466             </td>
 467
 468           </tr>
 469
 470
 471
 472
 473           <tr class="property-row config-row-alt0 notInherited">
 474             <td class="micon">
 475                 <a class="exi" href="#expand">&nbsp;</a>
 476             </td>
 477             <td class="sig">
 478                <a id="Roo.XComponent-prop-elmodules" name=".elmodules"></a>
 479                <div class="fixedFont">
 480                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">elmodules</b> :
 481                      <span type="etype">of Roo.XComponent</span>
 482                      </div>
 483             </td>
 484             <td class="sig">
 485                 <div class="mdesc">
 486
 487
 488                    <div class="short">
 489                         array of modules to be created by which use <b>ID</b>
 490
 491
 492
 493                    </div>
 494
 495                     <div class="long">
 496
 497                         array of modules to be created by which use <b>ID</b>
 498
 499                 </div>
 500                 </div>
 501             </td>
 502
 503             <td class="msource">
 504             Roo.XComponent
 505             </td>
 506
 507           </tr>
 508
 509
 510
 511
 512           <tr class="property-row config-row-alt1 notInherited">
 513             <td class="micon">
 514                 <a class="exi" href="#expand">&nbsp;</a>
 515             </td>
 516             <td class="sig">
 517                <a id="Roo.XComponent-prop-event" name=".event"></a>
 518                <div class="fixedFont">
 519                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">event</b> :
 520                      <span type="etype"></span>
 521                      </div>
 522             </td>
 523             <td class="sig">
 524                 <div class="mdesc">
 525
 526
 527                    <div class="short">
 528                         Event Object.
 529
 530
 531
 532                    </div>
 533
 534                     <div class="long">
 535
 536                         Event Object.
 537
 538                 </div>
 539                 </div>
 540             </td>
 541
 542             <td class="msource">
 543             Roo.XComponent
 544             </td>
 545
 546           </tr>
 547
 548
 549
 550
 551           <tr class="property-row config-row-alt0 notInherited">
 552             <td class="micon">
 553                 <a class="exi" href="#expand">&nbsp;</a>
 554             </td>
 555             <td class="sig">
 556                <a id="Roo.XComponent-prop-hideProgress" name=".hideProgress"></a>
 557                <div class="fixedFont">
 558                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">hideProgress</b> :
 559                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 560                      </div>
 561             </td>
 562             <td class="sig">
 563                 <div class="mdesc">
 564
 565
 566                    <div class="short">
 567                         true to disable the building progress bar.
 568
 569
 570
 571                    </div>
 572
 573                     <div class="long">
 574
 575                         true to disable the building progress bar.. usefull on single page renders.
 576
 577                 </div>
 578                 </div>
 579             </td>
 580
 581             <td class="msource">
 582             Roo.XComponent
 583             </td>
 584
 585           </tr>
 586
 587
 588
 589
 590           <tr class="property-row config-row-alt1 notInherited">
 591             <td class="micon">
 592                 <a class="exi" href="#expand">&nbsp;</a>
 593             </td>
 594             <td class="sig">
 595                <a id="Roo.XComponent-prop-is_alt" name=".is_alt"></a>
 596                <div class="fixedFont">
 597                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">is_alt</b> :
 598                      <span type="etype">(default false)</span>
 599                      </div>
 600             </td>
 601             <td class="sig">
 602                 <div class="mdesc">
 603
 604
 605                    <div class="short">
 606                         Is an alternative Root - normally used by bootstrap or other systems,<br/>   where the top element in the tree can wrap 'body'
 607
 608
 609
 610                    </div>
 611
 612                     <div class="long">
 613
 614                         Is an alternative Root - normally used by bootstrap or other systems,<br/>   where the top element in the tree can wrap 'body'
 615
 616                 </div>
 617                 </div>
 618             </td>
 619
 620             <td class="msource">
 621             Roo.XComponent
 622             </td>
 623
 624           </tr>
 625
 626
 627
 628
 629           <tr class="property-row config-row-alt0 notInherited">
 630             <td class="micon">
 631                 <a class="exi" href="#expand">&nbsp;</a>
 632             </td>
 633             <td class="sig">
 634                <a id="Roo.XComponent-prop-modules" name=".modules"></a>
 635                <div class="fixedFont">
 636                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">modules</b> :
 637                      <span type="etype">of Roo.XComponent</span>
 638                      </div>
 639             </td>
 640             <td class="sig">
 641                 <div class="mdesc">
 642
 643
 644                    <div class="short">
 645                         array of modules to be created by registration system.
 646
 647
 648
 649                    </div>
 650
 651                     <div class="long">
 652
 653                         array of modules to be created by registration system.
 654
 655                 </div>
 656                 </div>
 657             </td>
 658
 659             <td class="msource">
 660             Roo.XComponent
 661             </td>
 662
 663           </tr>
 664
 665
 666
 667
 668           <tr class="property-row config-row-alt1 notInherited">
 669             <td class="micon">
 670                 <a class="exi" href="#expand">&nbsp;</a>
 671             </td>
 672             <td class="sig">
 673                <a id="Roo.XComponent-prop-on" name=".on"></a>
 674                <div class="fixedFont">
 675                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">on</b> :
 676                      <span type="etype"></span>
 677                      </div>
 678             </td>
 679             <td class="sig">
 680                 <div class="mdesc">
 681
 682
 683                    <div class="short">
 684                         wrapper for event.on - aliased later.
 685
 686
 687
 688                    </div>
 689
 690                     <div class="long">
 691
 692                         wrapper for event.on - aliased later..  <br/>Typically use to register a event handler for register:<br/><br/>eg. Roo.XComponent.on('register', function(comp) { comp.disable = true } );
 693
 694                 </div>
 695                 </div>
 696             </td>
 697
 698             <td class="msource">
 699             Roo.XComponent
 700             </td>
 701
 702           </tr>
 703
 704
 705
 706
 707           <tr class="property-row config-row-alt0 notInherited">
 708             <td class="micon">
 709                 <a class="exi" href="#expand">&nbsp;</a>
 710             </td>
 711             <td class="sig">
 712                <a id="Roo.XComponent-prop-topModule" name=".topModule"></a>
 713                <div class="fixedFont">
 714                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">topModule</b> :
 715                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
 716                      </div>
 717             </td>
 718             <td class="sig">
 719                 <div class="mdesc">
 720
 721
 722                    <div class="short">
 723                         the upper most module - uses document.element as it's constructor.
 724
 725
 726
 727                    </div>
 728
 729                     <div class="long">
 730
 731                         the upper most module - uses document.element as it's constructor.
 732
 733                 </div>
 734                 </div>
 735             </td>
 736
 737             <td class="msource">
 738             Roo.XComponent
 739             </td>
 740
 741           </tr>
 742
 743
 744
 745
 746
 747         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 748         <tr class="property-row alt">
 749
 750         -->
 751
 752     </table>
 753
 754
 755   <!-- ============================== methods summary / details ======================== -->
 756
 757
 758   <a id="Roo.XComponent-methods"></a>
 759         <!-- constructor?? -->
 760
 761         <!-- static's first
 762
 763
 764         -->
 765
 766         <!-- then dynamics first -->
 767
 768
 769
 770
 771
 772
 773       <table cellspacing="0" class="member-table">
 774       <caption>Public Methods</caption>
 775         <tr>
 776             <th class="sig-header" colspan="2">Method</th>
 777             <th class="msource-header">Defined By</th>
 778
 779         </tr>
 780
 781
 782
 783
 784
 785
 786
 787           <tr class="method-row config-row-alt0 expandable notInherited">
 788             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 789
 790
 791             <td class="sig">
 792                 <a id="Roo-method-XComponent"   name=".XComponent"></a>
 793                 <div class="fixedFont">
 794                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
 795
 796                                  (<B><i>cfg</i></B>)
 797
 798
 799
 800                 </div>
 801                 <div class="mdesc">
 802
 803
 804                         <div class="short">Create a new Roo.XComponent</div>
 805
 806
 807                     <div class="long">
 808
 809
 810
 811                                 Create a new Roo.XComponent
 812
 813
 814                                 <dl class="detailList">
 815                                 <dt class="heading">Parameters:</dt>
 816
 817                                         <dt>
 818                                                  <b>cfg</b>
 819
 820                                         </dt>
 821                                         <dd>{Object} configuration of component</dd>
 822
 823                                 </dl>
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835                     </div>
 836                 </div>
 837
 838             </td>
 839             <td class="msource">
 840                 &nbsp;
 841             </td>
 842         </tr>
 843
 844
 845           <tr class="method-row config-row-alt1 expandable notInherited">
 846             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 847
 848
 849             <td class="sig">
 850                 <a id="Roo.XComponent-method-build"   name=".build"></a>
 851                 <div class="fixedFont">
 852                         <span class="attributes">Roo.XComponent.</span><b class="itemname">build</b>
 853
 854                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>parent</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>optional</i></B>)
 855
 856
 857
 858                 </div>
 859                 <div class="mdesc">
 860
 861                    <div class="short">Build the registered modules.</div>
 862
 863
 864
 865                     <div class="long">
 866
 867                                 Build the registered modules.
 868
 869
 870
 871
 872
 873
 874                                 <dl class="detailList">
 875                                 <dt class="heading">Parameters:</dt>
 876
 877                                         <dt>
 878                                                 <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>
 879
 880                                         </dt>
 881                                         <dd>element.</dd>
 882
 883                                         <dt>
 884                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>optional</b>
 885
 886                                         </dt>
 887                                         <dd>method to call after module has been added.</dd>
 888
 889                                 </dl>
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901                     </div>
 902                 </div>
 903
 904             </td>
 905             <td class="msource">
 906
 907                         Roo.XComponent
 908                 &nbsp;
 909             </td>
 910         </tr>
 911
 912
 913           <tr class="method-row config-row-alt0 expandable notInherited">
 914             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 915
 916
 917             <td class="sig">
 918                 <a id="Roo.XComponent-method-buildOrder"   name=".buildOrder"></a>
 919                 <div class="fixedFont">
 920                         <span class="attributes">Roo.XComponent.</span><b class="itemname">buildOrder</b>
 921
 922                                  ()
 923
 924
 925                                          :
 926
 927
 928                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 929
 930
 931
 932
 933
 934                 </div>
 935                 <div class="mdesc">
 936
 937                    <div class="short">make a list of modules to build.</div>
 938
 939
 940
 941                     <div class="long">
 942
 943                                 make a list of modules to build.
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954                                 <dl class="detailList">
 955                                 <dt class="heading">Returns:</dt>
 956
 957                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  list of modules.</dd>
 958
 959                                 </dl>
 960
 961
 962
 963
 964
 965
 966
 967                     </div>
 968                 </div>
 969
 970             </td>
 971             <td class="msource">
 972
 973                         Roo.XComponent
 974                 &nbsp;
 975             </td>
 976         </tr>
 977
 978
 979           <tr class="method-row config-row-alt1 expandable notInherited">
 980             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 981
 982
 983             <td class="sig">
 984                 <a id="Roo.XComponent-method-overlayStrings"   name=".overlayStrings"></a>
 985                 <div class="fixedFont">
 986                         <span class="attributes">Roo.XComponent.</span><b class="itemname">overlayStrings</b>
 987
 988                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>element</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>associative</i></B>)
 989
 990
 991
 992                 </div>
 993                 <div class="mdesc">
 994
 995                    <div class="short">Overlay a set of modified strings onto a component<br/>This is dependant on our builder exporting the strings and 'named strings' elements.</div>
 996
 997
 998
 999                     <div class="long">
1000
1001                                 Overlay a set of modified strings onto a component<br/>This is dependant on our builder exporting the strings and 'named strings' elements.
1002
1003
1004
1005
1006
1007
1008                                 <dl class="detailList">
1009                                 <dt class="heading">Parameters:</dt>
1010
1011                                         <dt>
1012                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>element</b>
1013
1014                                         </dt>
1015                                         <dd>to overlay on - eg. Pman.Dialog.Login</dd>
1016
1017                                         <dt>
1018                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>associative</b>
1019
1020                                         </dt>
1021                                         <dd>array of 'named' string and it's new value.</dd>
1022
1023                                 </dl>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035                     </div>
1036                 </div>
1037
1038             </td>
1039             <td class="msource">
1040
1041                         Roo.XComponent
1042                 &nbsp;
1043             </td>
1044         </tr>
1045
1046
1047           <tr class="method-row config-row-alt0 expandable notInherited">
1048             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1049
1050
1051             <td class="sig">
1052                 <a id="Roo.XComponent-method-preBuild"   name=".preBuild"></a>
1053                 <div class="fixedFont">
1054                         <span class="attributes">Roo.XComponent.</span><b class="itemname">preBuild</b>
1055
1056                                  ()
1057
1058
1059
1060                 </div>
1061                 <div class="mdesc">
1062
1063                    <div class="short">move modules into their correct place in the tree.</div>
1064
1065
1066
1067                     <div class="long">
1068
1069                                 move modules into their correct place in the tree..
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086                     </div>
1087                 </div>
1088
1089             </td>
1090             <td class="msource">
1091
1092                         Roo.XComponent
1093                 &nbsp;
1094             </td>
1095         </tr>
1096
1097
1098           <tr class="method-row config-row-alt1 expandable notInherited">
1099             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1100
1101
1102             <td class="sig">
1103                 <a id="Roo.XComponent-method-register"   name=".register"></a>
1104                 <div class="fixedFont">
1105                         <span class="attributes">Roo.XComponent.</span><b class="itemname">register</b>
1106
1107                                  ()
1108
1109
1110
1111                 </div>
1112                 <div class="mdesc">
1113
1114                    <div class="short">Register components to be built later.</div>
1115
1116
1117
1118                     <div class="long">
1119
1120                                 Register components to be built later.<br/><br/>This solves the following issues<br/>- Building is not done on page load, but after an authentication process has occured.<br/>- Interface elements are registered on page load<br/>- Parent Interface elements may not be loaded before child, so this handles that..<br/><br/><br/>example:<br/><br/>MyApp.register({<br/>          order : '000001',<br/>          module : 'Pman.Tab.projectMgr',<br/>          region : 'center',<br/>          parent : 'Pman.layout',<br/>          disabled : false,  // or use a function..<br/>        })<br/>* <b>param</b> {Object} details about module
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137                     </div>
1138                 </div>
1139
1140             </td>
1141             <td class="msource">
1142
1143                         Roo.XComponent
1144                 &nbsp;
1145             </td>
1146         </tr>
1147
1148
1149           <tr class="method-row config-row-alt0 expandable notInherited">
1150             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1151
1152
1153             <td class="sig">
1154                 <a id="Roo.XComponent-method-toObject"   name=".toObject"></a>
1155                 <div class="fixedFont">
1156                         <span class="attributes">Roo.XComponent.</span><b class="itemname">toObject</b>
1157
1158                                  ()
1159
1160
1161
1162                 </div>
1163                 <div class="mdesc">
1164
1165                    <div class="short">convert a string to an object.</div>
1166
1167
1168
1169                     <div class="long">
1170
1171                                 convert a string to an object..<br/>eg. 'AAA.BBB' -> finds AAA.BBB
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188                     </div>
1189                 </div>
1190
1191             </td>
1192             <td class="msource">
1193
1194                         Roo.XComponent
1195                 &nbsp;
1196             </td>
1197         </tr>
1198
1199
1200           <tr class="method-row config-row-alt1 expandable">
1201             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1202
1203
1204             <td class="sig">
1205                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
1206                 <div class="fixedFont">
1207                         <span class="attributes"></span><b class="itemname">addEvents</b>
1208
1209                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1210
1211
1212
1213                 </div>
1214                 <div class="mdesc">
1215
1216                    <div class="short">Used to define events on this Observable</div>
1217
1218
1219
1220                     <div class="long">
1221
1222                                 Used to define events on this Observable
1223
1224
1225
1226
1227
1228
1229                                 <dl class="detailList">
1230                                 <dt class="heading">Parameters:</dt>
1231
1232                                         <dt>
1233                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
1234
1235                                         </dt>
1236                                         <dd>The object with the events defined</dd>
1237
1238                                 </dl>
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250                     </div>
1251                 </div>
1252
1253             </td>
1254             <td class="msource">
1255
1256                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1257                 &nbsp;
1258             </td>
1259         </tr>
1260
1261
1262           <tr class="method-row config-row-alt0 expandable">
1263             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1264
1265
1266             <td class="sig">
1267                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
1268                 <div class="fixedFont">
1269                         <span class="attributes"></span><b class="itemname">addListener</b>
1270
1271                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1272
1273
1274
1275                 </div>
1276                 <div class="mdesc">
1277
1278                    <div class="short">Appends an event handler to this component</div>
1279
1280
1281
1282                     <div class="long">
1283
1284                                 Appends an event handler to this component
1285
1286
1287
1288
1289
1290
1291                                 <dl class="detailList">
1292                                 <dt class="heading">Parameters:</dt>
1293
1294                                         <dt>
1295                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1296
1297                                         </dt>
1298                                         <dd>The type of event to listen for</dd>
1299
1300                                         <dt>
1301                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1302
1303                                         </dt>
1304                                         <dd>The method the event invokes</dd>
1305
1306                                         <dt>
1307                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1308
1309                                         </dt>
1310                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1311
1312                                         <dt>
1313                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1314
1315                                         </dt>
1316                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
1317
1318                                 </dl>
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330                     </div>
1331                 </div>
1332
1333             </td>
1334             <td class="msource">
1335
1336                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1337                 &nbsp;
1338             </td>
1339         </tr>
1340
1341
1342           <tr class="method-row config-row-alt1 expandable">
1343             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1344
1345
1346             <td class="sig">
1347                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
1348                 <div class="fixedFont">
1349                         <span class="attributes"></span><b class="itemname">fireEvent</b>
1350
1351                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1352
1353
1354                                          :
1355
1356
1357                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1358
1359
1360
1361
1362
1363                 </div>
1364                 <div class="mdesc">
1365
1366                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1367
1368
1369
1370                     <div class="long">
1371
1372                                 Fires the specified event with the passed parameters (minus the event name).
1373
1374
1375
1376
1377
1378
1379                                 <dl class="detailList">
1380                                 <dt class="heading">Parameters:</dt>
1381
1382                                         <dt>
1383                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1384
1385                                         </dt>
1386                                         <dd></dd>
1387
1388                                         <dt>
1389                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
1390
1391                                         </dt>
1392                                         <dd>Variable number of parameters are passed to handlers</dd>
1393
1394                                 </dl>
1395
1396
1397
1398
1399
1400                                 <dl class="detailList">
1401                                 <dt class="heading">Returns:</dt>
1402
1403                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
1404
1405                                 </dl>
1406
1407
1408
1409
1410
1411
1412
1413                     </div>
1414                 </div>
1415
1416             </td>
1417             <td class="msource">
1418
1419                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1420                 &nbsp;
1421             </td>
1422         </tr>
1423
1424
1425           <tr class="method-row config-row-alt0 expandable">
1426             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1427
1428
1429             <td class="sig">
1430                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1431                 <div class="fixedFont">
1432                         <span class="attributes"></span><b class="itemname">hasListener</b>
1433
1434                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1435
1436
1437                                          :
1438
1439
1440                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1441
1442
1443
1444
1445
1446                 </div>
1447                 <div class="mdesc">
1448
1449                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1450
1451
1452
1453                     <div class="long">
1454
1455                                 Checks to see if this object has any listeners for a specified event
1456
1457
1458
1459
1460
1461
1462                                 <dl class="detailList">
1463                                 <dt class="heading">Parameters:</dt>
1464
1465                                         <dt>
1466                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1467
1468                                         </dt>
1469                                         <dd>The name of the event to check for</dd>
1470
1471                                 </dl>
1472
1473
1474
1475
1476
1477                                 <dl class="detailList">
1478                                 <dt class="heading">Returns:</dt>
1479
1480                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
1481
1482                                 </dl>
1483
1484
1485
1486
1487
1488
1489
1490                     </div>
1491                 </div>
1492
1493             </td>
1494             <td class="msource">
1495
1496                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1497                 &nbsp;
1498             </td>
1499         </tr>
1500
1501
1502           <tr class="method-row config-row-alt1 expandable">
1503             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1504
1505
1506             <td class="sig">
1507                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1508                 <div class="fixedFont">
1509                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1510
1511                                  ()
1512
1513
1514
1515                 </div>
1516                 <div class="mdesc">
1517
1518                    <div class="short">Removes all listeners for this object</div>
1519
1520
1521
1522                     <div class="long">
1523
1524                                 Removes all listeners for this object
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541                     </div>
1542                 </div>
1543
1544             </td>
1545             <td class="msource">
1546
1547                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1548                 &nbsp;
1549             </td>
1550         </tr>
1551
1552
1553           <tr class="method-row config-row-alt0 expandable">
1554             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1555
1556
1557             <td class="sig">
1558                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1559                 <div class="fixedFont">
1560                         <span class="attributes"></span><b class="itemname">removeListener</b>
1561
1562                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1563
1564
1565
1566                 </div>
1567                 <div class="mdesc">
1568
1569                    <div class="short">Removes a listener</div>
1570
1571
1572
1573                     <div class="long">
1574
1575                                 Removes a listener
1576
1577
1578
1579
1580
1581
1582                                 <dl class="detailList">
1583                                 <dt class="heading">Parameters:</dt>
1584
1585                                         <dt>
1586                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1587
1588                                         </dt>
1589                                         <dd>The type of event to listen for</dd>
1590
1591                                         <dt>
1592                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1593
1594                                         </dt>
1595                                         <dd>The handler to remove</dd>
1596
1597                                         <dt>
1598                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1599
1600                                         </dt>
1601                                         <dd>(optional) The scope (this object) for the handler</dd>
1602
1603                                 </dl>
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615                     </div>
1616                 </div>
1617
1618             </td>
1619             <td class="msource">
1620
1621                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1622                 &nbsp;
1623             </td>
1624         </tr>
1625
1626
1627           <tr class="method-row config-row-alt1 expandable notInherited">
1628             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1629
1630
1631             <td class="sig">
1632                 <a id="Roo.XComponent-method-render"   name=".render"></a>
1633                 <div class="fixedFont">
1634                         <span class="attributes"></span><b class="itemname">render</b>
1635
1636                                  (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>|<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DomElement <B><i>optional</i></B>)
1637
1638
1639
1640                 </div>
1641                 <div class="mdesc">
1642
1643                    <div class="short">render<br/>render element to dom or tree</div>
1644
1645
1646
1647                     <div class="long">
1648
1649                                 render<br/>render element to dom or tree
1650
1651
1652
1653
1654
1655
1656                                 <dl class="detailList">
1657                                 <dt class="heading">Parameters:</dt>
1658
1659                                         <dt>
1660                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>|<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DomElement</span>  <b>optional</b>
1661
1662                                         </dt>
1663                                         <dd>render to if parent is not set.</dd>
1664
1665                                 </dl>
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677                     </div>
1678                 </div>
1679
1680             </td>
1681             <td class="msource">
1682
1683                         Roo.XComponent
1684                 &nbsp;
1685             </td>
1686         </tr>
1687
1688
1689           <tr class="method-row config-row-alt0 expandable">
1690             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1691
1692
1693             <td class="sig">
1694                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1695                 <div class="fixedFont">
1696                         <span class="attributes"></span><b class="itemname">un</b>
1697
1698                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1699
1700
1701
1702                 </div>
1703                 <div class="mdesc">
1704
1705                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1706
1707
1708
1709                     <div class="long">
1710
1711                                 Removes a listener (shorthand for removeListener)
1712
1713
1714
1715
1716
1717
1718                                 <dl class="detailList">
1719                                 <dt class="heading">Parameters:</dt>
1720
1721                                         <dt>
1722                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1723
1724                                         </dt>
1725                                         <dd>The type of event to listen for</dd>
1726
1727                                         <dt>
1728                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1729
1730                                         </dt>
1731                                         <dd>The handler to remove</dd>
1732
1733                                         <dt>
1734                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1735
1736                                         </dt>
1737                                         <dd>(optional) The scope (this object) for the handler</dd>
1738
1739                                 </dl>
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751                     </div>
1752                 </div>
1753
1754             </td>
1755             <td class="msource">
1756
1757                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1758                 &nbsp;
1759             </td>
1760         </tr>
1761
1762
1763     </table>
1764
1765
1766   <!-- ============================== events summary / details ======================== -->
1767
1768
1769   <a id="Roo.XComponent-events"></a>
1770
1771
1772
1773
1774
1775
1776
1777
1778       <table cellspacing="0" class="member-table">
1779                 <caption>Events</caption>
1780               <thead>
1781                 <tr>
1782                     <th class="sig-header" colspan="2">Event</th>
1783                     <th class="msource-header">Defined By</th>
1784
1785                 </tr>
1786               </thead>
1787
1788
1789
1790
1791
1792           <tr class="method-row expandable config-row-alt0 notInherited">
1793             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1794
1795             <td class="sig">
1796                 <a id="Roo.XComponent-event-*built"></a>
1797
1798                <div class="fixedFont">
1799                 <b class="itemname">built</b> (<a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a> <B><i>c</i></B>)
1800
1801                 </div>
1802
1803                 <div class="mdesc">
1804
1805                    <div class="short">Fires when this the componnt is built
1806
1807                 </div>
1808
1809                     <div class="long">
1810
1811                         Fires when this the componnt is built
1812
1813
1814
1815
1816
1817                                 <dl class="detailList">
1818                                 <dt class="heading">Parameters:</dt>
1819
1820                                         <dt>
1821                                                 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1822
1823                                         </dt>
1824                                         <dd>the component</dd>
1825
1826                                 </dl>
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838                     </div>
1839                 </div>
1840
1841             </td>
1842             <td class="msource">
1843                 Roo.XComponent
1844             </td>
1845         </tr>
1846
1847
1848     </table>
1849
1850
1851
1852
1853
1854 <!-- ============================== footer ================================= -->
1855                 <div class="fineprint" style="clear:both">
1856
1857                         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)
1858                         Based on
1859                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1860                 </div>
1861         </body>
1862 </html>