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.
  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">true  (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-modules" name=".modules"></a>
 596                <div class="fixedFont">
 597                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">modules</b> :
 598                      <span type="etype">of Roo.XComponent</span>
 599                      </div>
 600             </td>
 601             <td class="sig">
 602                 <div class="mdesc">
 603
 604
 605                    <div class="short">
 606                         array of modules to be created by registration system.
 607
 608
 609
 610                    </div>
 611
 612                     <div class="long">
 613
 614                         array of modules to be created by registration system.
 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-on" name=".on"></a>
 635                <div class="fixedFont">
 636                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">on</b> :
 637                      <span type="etype"></span>
 638                      </div>
 639             </td>
 640             <td class="sig">
 641                 <div class="mdesc">
 642
 643
 644                    <div class="short">
 645                         wrapper for event.on - aliased later.
 646
 647
 648
 649                    </div>
 650
 651                     <div class="long">
 652
 653                         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 } );
 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-topModule" name=".topModule"></a>
 674                <div class="fixedFont">
 675                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">topModule</b> :
 676                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
 677                      </div>
 678             </td>
 679             <td class="sig">
 680                 <div class="mdesc">
 681
 682
 683                    <div class="short">
 684                         the upper most module - uses document.element as it's constructor.
 685
 686
 687
 688                    </div>
 689
 690                     <div class="long">
 691
 692                         the upper most module - uses document.element as it's constructor.
 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
 708         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 709         <tr class="property-row alt">
 710
 711         -->
 712
 713     </table>
 714
 715
 716   <!-- ============================== methods summary / details ======================== -->
 717
 718
 719   <a id="Roo.XComponent-methods"></a>
 720         <!-- constructor?? -->
 721
 722         <!-- static's first
 723
 724
 725         -->
 726
 727         <!-- then dynamics first -->
 728
 729
 730
 731
 732
 733
 734       <table cellspacing="0" class="member-table">
 735       <caption>Public Methods</caption>
 736         <tr>
 737             <th class="sig-header" colspan="2">Method</th>
 738             <th class="msource-header">Defined By</th>
 739
 740         </tr>
 741
 742
 743
 744
 745
 746
 747
 748           <tr class="method-row config-row-alt0 expandable notInherited">
 749             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 750
 751
 752             <td class="sig">
 753                 <a id="Roo-method-XComponent"   name=".XComponent"></a>
 754                 <div class="fixedFont">
 755                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
 756
 757                                  (<B><i>cfg</i></B>)
 758
 759
 760
 761                 </div>
 762                 <div class="mdesc">
 763
 764
 765                         <div class="short">Create a new Roo.XComponent</div>
 766
 767
 768                     <div class="long">
 769
 770
 771
 772                                 Create a new Roo.XComponent
 773
 774
 775                                 <dl class="detailList">
 776                                 <dt class="heading">Parameters:</dt>
 777
 778                                         <dt>
 779                                                  <b>cfg</b>
 780
 781                                         </dt>
 782                                         <dd>{Object} configuration of component</dd>
 783
 784                                 </dl>
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796                     </div>
 797                 </div>
 798
 799             </td>
 800             <td class="msource">
 801                 &nbsp;
 802             </td>
 803         </tr>
 804
 805
 806           <tr class="method-row config-row-alt1 expandable notInherited">
 807             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 808
 809
 810             <td class="sig">
 811                 <a id="Roo.XComponent-method-build"   name=".build"></a>
 812                 <div class="fixedFont">
 813                         <span class="attributes">Roo.XComponent.</span><b class="itemname">build</b>
 814
 815                                  (<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>)
 816
 817
 818
 819                 </div>
 820                 <div class="mdesc">
 821
 822                    <div class="short">Build the registered modules.</div>
 823
 824
 825
 826                     <div class="long">
 827
 828                                 Build the registered modules.
 829
 830
 831
 832
 833
 834
 835                                 <dl class="detailList">
 836                                 <dt class="heading">Parameters:</dt>
 837
 838                                         <dt>
 839                                                 <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>
 840
 841                                         </dt>
 842                                         <dd>element.</dd>
 843
 844                                         <dt>
 845                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>optional</b>
 846
 847                                         </dt>
 848                                         <dd>method to call after module has been added.</dd>
 849
 850                                 </dl>
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862                     </div>
 863                 </div>
 864
 865             </td>
 866             <td class="msource">
 867
 868                         Roo.XComponent
 869                 &nbsp;
 870             </td>
 871         </tr>
 872
 873
 874           <tr class="method-row config-row-alt0 expandable notInherited">
 875             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 876
 877
 878             <td class="sig">
 879                 <a id="Roo.XComponent-method-buildOrder"   name=".buildOrder"></a>
 880                 <div class="fixedFont">
 881                         <span class="attributes">Roo.XComponent.</span><b class="itemname">buildOrder</b>
 882
 883                                  ()
 884
 885
 886                                          :
 887
 888
 889                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 890
 891
 892
 893
 894
 895                 </div>
 896                 <div class="mdesc">
 897
 898                    <div class="short">make a list of modules to build.</div>
 899
 900
 901
 902                     <div class="long">
 903
 904                                 make a list of modules to build.
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915                                 <dl class="detailList">
 916                                 <dt class="heading">Returns:</dt>
 917
 918                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  list of modules.</dd>
 919
 920                                 </dl>
 921
 922
 923
 924
 925
 926
 927
 928                     </div>
 929                 </div>
 930
 931             </td>
 932             <td class="msource">
 933
 934                         Roo.XComponent
 935                 &nbsp;
 936             </td>
 937         </tr>
 938
 939
 940           <tr class="method-row config-row-alt1 expandable notInherited">
 941             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 942
 943
 944             <td class="sig">
 945                 <a id="Roo.XComponent-method-preBuild"   name=".preBuild"></a>
 946                 <div class="fixedFont">
 947                         <span class="attributes">Roo.XComponent.</span><b class="itemname">preBuild</b>
 948
 949                                  ()
 950
 951
 952
 953                 </div>
 954                 <div class="mdesc">
 955
 956                    <div class="short">move modules into their correct place in the tree.</div>
 957
 958
 959
 960                     <div class="long">
 961
 962                                 move modules into their correct place in the tree..
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979                     </div>
 980                 </div>
 981
 982             </td>
 983             <td class="msource">
 984
 985                         Roo.XComponent
 986                 &nbsp;
 987             </td>
 988         </tr>
 989
 990
 991           <tr class="method-row config-row-alt0 expandable notInherited">
 992             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 993
 994
 995             <td class="sig">
 996                 <a id="Roo.XComponent-method-register"   name=".register"></a>
 997                 <div class="fixedFont">
 998                         <span class="attributes">Roo.XComponent.</span><b class="itemname">register</b>
 999
1000                                  ()
1001
1002
1003
1004                 </div>
1005                 <div class="mdesc">
1006
1007                    <div class="short">Register components to be built later.</div>
1008
1009
1010
1011                     <div class="long">
1012
1013                                 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
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030                     </div>
1031                 </div>
1032
1033             </td>
1034             <td class="msource">
1035
1036                         Roo.XComponent
1037                 &nbsp;
1038             </td>
1039         </tr>
1040
1041
1042           <tr class="method-row config-row-alt1 expandable notInherited">
1043             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1044
1045
1046             <td class="sig">
1047                 <a id="Roo.XComponent-method-toObject"   name=".toObject"></a>
1048                 <div class="fixedFont">
1049                         <span class="attributes">Roo.XComponent.</span><b class="itemname">toObject</b>
1050
1051                                  ()
1052
1053
1054
1055                 </div>
1056                 <div class="mdesc">
1057
1058                    <div class="short">convert a string to an object.</div>
1059
1060
1061
1062                     <div class="long">
1063
1064                                 convert a string to an object..<br/>eg. 'AAA.BBB' -> finds AAA.BBB
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081                     </div>
1082                 </div>
1083
1084             </td>
1085             <td class="msource">
1086
1087                         Roo.XComponent
1088                 &nbsp;
1089             </td>
1090         </tr>
1091
1092
1093           <tr class="method-row config-row-alt0 expandable">
1094             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1095
1096
1097             <td class="sig">
1098                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
1099                 <div class="fixedFont">
1100                         <span class="attributes"></span><b class="itemname">addEvents</b>
1101
1102                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1103
1104
1105
1106                 </div>
1107                 <div class="mdesc">
1108
1109                    <div class="short">Used to define events on this Observable</div>
1110
1111
1112
1113                     <div class="long">
1114
1115                                 Used to define events on this Observable
1116
1117
1118
1119
1120
1121
1122                                 <dl class="detailList">
1123                                 <dt class="heading">Parameters:</dt>
1124
1125                                         <dt>
1126                                                 <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>
1127
1128                                         </dt>
1129                                         <dd>The object with the events defined</dd>
1130
1131                                 </dl>
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143                     </div>
1144                 </div>
1145
1146             </td>
1147             <td class="msource">
1148
1149                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1150                 &nbsp;
1151             </td>
1152         </tr>
1153
1154
1155           <tr class="method-row config-row-alt1 expandable">
1156             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1157
1158
1159             <td class="sig">
1160                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
1161                 <div class="fixedFont">
1162                         <span class="attributes"></span><b class="itemname">addListener</b>
1163
1164                                  (<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>)
1165
1166
1167
1168                 </div>
1169                 <div class="mdesc">
1170
1171                    <div class="short">Appends an event handler to this component</div>
1172
1173
1174
1175                     <div class="long">
1176
1177                                 Appends an event handler to this component
1178
1179
1180
1181
1182
1183
1184                                 <dl class="detailList">
1185                                 <dt class="heading">Parameters:</dt>
1186
1187                                         <dt>
1188                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1189
1190                                         </dt>
1191                                         <dd>The type of event to listen for</dd>
1192
1193                                         <dt>
1194                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1195
1196                                         </dt>
1197                                         <dd>The method the event invokes</dd>
1198
1199                                         <dt>
1200                                                 <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>
1201
1202                                         </dt>
1203                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1204
1205                                         <dt>
1206                                                 <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>
1207
1208                                         </dt>
1209                                         <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>
1210
1211                                 </dl>
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223                     </div>
1224                 </div>
1225
1226             </td>
1227             <td class="msource">
1228
1229                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1230                 &nbsp;
1231             </td>
1232         </tr>
1233
1234
1235           <tr class="method-row config-row-alt0 expandable">
1236             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1237
1238
1239             <td class="sig">
1240                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
1241                 <div class="fixedFont">
1242                         <span class="attributes"></span><b class="itemname">fireEvent</b>
1243
1244                                  (<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>)
1245
1246
1247                                          :
1248
1249
1250                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1251
1252
1253
1254
1255
1256                 </div>
1257                 <div class="mdesc">
1258
1259                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1260
1261
1262
1263                     <div class="long">
1264
1265                                 Fires the specified event with the passed parameters (minus the event name).
1266
1267
1268
1269
1270
1271
1272                                 <dl class="detailList">
1273                                 <dt class="heading">Parameters:</dt>
1274
1275                                         <dt>
1276                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1277
1278                                         </dt>
1279                                         <dd></dd>
1280
1281                                         <dt>
1282                                                 <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>
1283
1284                                         </dt>
1285                                         <dd>Variable number of parameters are passed to handlers</dd>
1286
1287                                 </dl>
1288
1289
1290
1291
1292
1293                                 <dl class="detailList">
1294                                 <dt class="heading">Returns:</dt>
1295
1296                                         <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>
1297
1298                                 </dl>
1299
1300
1301
1302
1303
1304
1305
1306                     </div>
1307                 </div>
1308
1309             </td>
1310             <td class="msource">
1311
1312                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1313                 &nbsp;
1314             </td>
1315         </tr>
1316
1317
1318           <tr class="method-row config-row-alt1 expandable">
1319             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1320
1321
1322             <td class="sig">
1323                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1324                 <div class="fixedFont">
1325                         <span class="attributes"></span><b class="itemname">hasListener</b>
1326
1327                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1328
1329
1330                                          :
1331
1332
1333                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1334
1335
1336
1337
1338
1339                 </div>
1340                 <div class="mdesc">
1341
1342                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1343
1344
1345
1346                     <div class="long">
1347
1348                                 Checks to see if this object has any listeners for a specified event
1349
1350
1351
1352
1353
1354
1355                                 <dl class="detailList">
1356                                 <dt class="heading">Parameters:</dt>
1357
1358                                         <dt>
1359                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1360
1361                                         </dt>
1362                                         <dd>The name of the event to check for</dd>
1363
1364                                 </dl>
1365
1366
1367
1368
1369
1370                                 <dl class="detailList">
1371                                 <dt class="heading">Returns:</dt>
1372
1373                                         <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>
1374
1375                                 </dl>
1376
1377
1378
1379
1380
1381
1382
1383                     </div>
1384                 </div>
1385
1386             </td>
1387             <td class="msource">
1388
1389                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1390                 &nbsp;
1391             </td>
1392         </tr>
1393
1394
1395           <tr class="method-row config-row-alt0 expandable">
1396             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1397
1398
1399             <td class="sig">
1400                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1401                 <div class="fixedFont">
1402                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1403
1404                                  ()
1405
1406
1407
1408                 </div>
1409                 <div class="mdesc">
1410
1411                    <div class="short">Removes all listeners for this object</div>
1412
1413
1414
1415                     <div class="long">
1416
1417                                 Removes all listeners for this object
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434                     </div>
1435                 </div>
1436
1437             </td>
1438             <td class="msource">
1439
1440                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1441                 &nbsp;
1442             </td>
1443         </tr>
1444
1445
1446           <tr class="method-row config-row-alt1 expandable">
1447             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1448
1449
1450             <td class="sig">
1451                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1452                 <div class="fixedFont">
1453                         <span class="attributes"></span><b class="itemname">removeListener</b>
1454
1455                                  (<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>)
1456
1457
1458
1459                 </div>
1460                 <div class="mdesc">
1461
1462                    <div class="short">Removes a listener</div>
1463
1464
1465
1466                     <div class="long">
1467
1468                                 Removes a listener
1469
1470
1471
1472
1473
1474
1475                                 <dl class="detailList">
1476                                 <dt class="heading">Parameters:</dt>
1477
1478                                         <dt>
1479                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1480
1481                                         </dt>
1482                                         <dd>The type of event to listen for</dd>
1483
1484                                         <dt>
1485                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1486
1487                                         </dt>
1488                                         <dd>The handler to remove</dd>
1489
1490                                         <dt>
1491                                                 <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>
1492
1493                                         </dt>
1494                                         <dd>(optional) The scope (this object) for the handler</dd>
1495
1496                                 </dl>
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508                     </div>
1509                 </div>
1510
1511             </td>
1512             <td class="msource">
1513
1514                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1515                 &nbsp;
1516             </td>
1517         </tr>
1518
1519
1520           <tr class="method-row config-row-alt0 expandable notInherited">
1521             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1522
1523
1524             <td class="sig">
1525                 <a id="Roo.XComponent-method-render"   name=".render"></a>
1526                 <div class="fixedFont">
1527                         <span class="attributes"></span><b class="itemname">render</b>
1528
1529                                  (<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>)
1530
1531
1532
1533                 </div>
1534                 <div class="mdesc">
1535
1536                    <div class="short">render<br/>render element to dom or tree</div>
1537
1538
1539
1540                     <div class="long">
1541
1542                                 render<br/>render element to dom or tree
1543
1544
1545
1546
1547
1548
1549                                 <dl class="detailList">
1550                                 <dt class="heading">Parameters:</dt>
1551
1552                                         <dt>
1553                                                 <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>
1554
1555                                         </dt>
1556                                         <dd>render to if parent is not set.</dd>
1557
1558                                 </dl>
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570                     </div>
1571                 </div>
1572
1573             </td>
1574             <td class="msource">
1575
1576                         Roo.XComponent
1577                 &nbsp;
1578             </td>
1579         </tr>
1580
1581
1582           <tr class="method-row config-row-alt1 expandable">
1583             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1584
1585
1586             <td class="sig">
1587                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1588                 <div class="fixedFont">
1589                         <span class="attributes"></span><b class="itemname">un</b>
1590
1591                                  (<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>)
1592
1593
1594
1595                 </div>
1596                 <div class="mdesc">
1597
1598                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1599
1600
1601
1602                     <div class="long">
1603
1604                                 Removes a listener (shorthand for removeListener)
1605
1606
1607
1608
1609
1610
1611                                 <dl class="detailList">
1612                                 <dt class="heading">Parameters:</dt>
1613
1614                                         <dt>
1615                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1616
1617                                         </dt>
1618                                         <dd>The type of event to listen for</dd>
1619
1620                                         <dt>
1621                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1622
1623                                         </dt>
1624                                         <dd>The handler to remove</dd>
1625
1626                                         <dt>
1627                                                 <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>
1628
1629                                         </dt>
1630                                         <dd>(optional) The scope (this object) for the handler</dd>
1631
1632                                 </dl>
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644                     </div>
1645                 </div>
1646
1647             </td>
1648             <td class="msource">
1649
1650                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1651                 &nbsp;
1652             </td>
1653         </tr>
1654
1655
1656     </table>
1657
1658
1659   <!-- ============================== events summary / details ======================== -->
1660
1661
1662   <a id="Roo.XComponent-events"></a>
1663
1664
1665
1666
1667
1668
1669
1670
1671       <table cellspacing="0" class="member-table">
1672                 <caption>Events</caption>
1673               <thead>
1674                 <tr>
1675                     <th class="sig-header" colspan="2">Event</th>
1676                     <th class="msource-header">Defined By</th>
1677
1678                 </tr>
1679               </thead>
1680
1681
1682
1683
1684
1685           <tr class="method-row expandable config-row-alt0 notInherited">
1686             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1687
1688             <td class="sig">
1689                 <a id="Roo.XComponent-event-*built"></a>
1690
1691                <div class="fixedFont">
1692                 <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>)
1693
1694                 </div>
1695
1696                 <div class="mdesc">
1697
1698                    <div class="short">Fires when this the componnt is built
1699
1700                 </div>
1701
1702                     <div class="long">
1703
1704                         Fires when this the componnt is built
1705
1706
1707
1708
1709
1710                                 <dl class="detailList">
1711                                 <dt class="heading">Parameters:</dt>
1712
1713                                         <dt>
1714                                                 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1715
1716                                         </dt>
1717                                         <dd>the component</dd>
1718
1719                                 </dl>
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731                     </div>
1732                 </div>
1733
1734             </td>
1735             <td class="msource">
1736                 Roo.XComponent
1737             </td>
1738         </tr>
1739
1740
1741     </table>
1742
1743
1744
1745
1746
1747 <!-- ============================== footer ================================= -->
1748                 <div class="fineprint" style="clear:both">
1749
1750                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Thu Apr 28 2016 18:00:56 GMT+0800 (HKT)
1751                         Based on
1752                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1753                 </div>
1754         </body>
1755 </html>