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/><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/>})
  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">If this module is disabled by some rule, return true from the funtion</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.XComponent
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.XComponent-cfg-items" name=".items"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">items</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">A single item array - the first element is the root of the tree.</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">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...</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.XComponent
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <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>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">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></div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.XComponent-cfg-name" name=".name"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">String to display while loading.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">String to display while loading.</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.XComponent
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.XComponent-cfg-order" name=".order"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">order</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">Used to set the order in which elements are created (usefull for multiple tabs)</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">Used to set the order in which elements are created (usefull for multiple tabs)</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.XComponent
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.XComponent-cfg-parent" name=".parent"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">parent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">Name of parent element which it get xtype added to.</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">Name of parent element which it get xtype added to..</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.XComponent
 302
 303                     </td>
 304                 </tr>
 305
 306
 307     </table>
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317   <!-- ============================== public properties ==================== -->
 318
 319
 320
 321     <a id="Roo.XComponent-props"></a>
 322
 323
 324
 325
 326
 327
 328
 329       <table cellspacing="0" class="member-table">
 330       <caption>Public Properties </caption>
 331         <tr>
 332             <th class="sig-header" colspan="2">Property</th>
 333             <th class="sig-header">Description</th>
 334             <th class="msource-header">Defined By</th>
 335         </tr>
 336
 337
 338
 339
 340
 341
 342
 343
 344           <tr class="property-row config-row-alt0 notInherited">
 345             <td class="micon">
 346                 <a class="exi" href="#expand">&nbsp;</a>
 347             </td>
 348             <td class="sig">
 349                <a id="Roo.XComponent-prop-buildCompleted" name=".buildCompleted"></a>
 350                <div class="fixedFont">
 351                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">buildCompleted</b> :
 352                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
 353                      </div>
 354             </td>
 355             <td class="sig">
 356                 <div class="mdesc">
 357
 358
 359                    <div class="short">
 360                         True when the builder has completed building the interface.
 361
 362
 363
 364                    </div>
 365
 366                     <div class="long">
 367
 368                         True when the builder has completed building the interface.
 369
 370                 </div>
 371                 </div>
 372             </td>
 373
 374             <td class="msource">
 375             Roo.XComponent
 376             </td>
 377
 378           </tr>
 379
 380
 381
 382
 383           <tr class="property-row config-row-alt1 notInherited">
 384             <td class="micon">
 385                 <a class="exi" href="#expand">&nbsp;</a>
 386             </td>
 387             <td class="sig">
 388                <a id="Roo.XComponent-prop-modules" name=".modules"></a>
 389                <div class="fixedFont">
 390                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">modules</b> :
 391                      <span type="etype"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span>
 392                      </div>
 393             </td>
 394             <td class="sig">
 395                 <div class="mdesc">
 396
 397
 398                    <div class="short">
 399                         array of modules to be created by registration system.
 400
 401
 402
 403                    </div>
 404
 405                     <div class="long">
 406
 407                         array of modules to be created by registration system.
 408
 409                 </div>
 410                 </div>
 411             </td>
 412
 413             <td class="msource">
 414             Roo.XComponent
 415             </td>
 416
 417           </tr>
 418
 419
 420
 421
 422           <tr class="property-row config-row-alt0 notInherited">
 423             <td class="micon">
 424                 <a class="exi" href="#expand">&nbsp;</a>
 425             </td>
 426             <td class="sig">
 427                <a id="Roo.XComponent-prop-topModule" name=".topModule"></a>
 428                <div class="fixedFont">
 429                     <span class="attributes">Roo.XComponent.</span><b  class="itemname">topModule</b> :
 430                      <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
 431                      </div>
 432             </td>
 433             <td class="sig">
 434                 <div class="mdesc">
 435
 436
 437                    <div class="short">
 438                         the upper most module - uses document.element as it's constructor.
 439
 440
 441
 442                    </div>
 443
 444                     <div class="long">
 445
 446                         the upper most module - uses document.element as it's constructor.
 447
 448                 </div>
 449                 </div>
 450             </td>
 451
 452             <td class="msource">
 453             Roo.XComponent
 454             </td>
 455
 456           </tr>
 457
 458
 459
 460
 461
 462         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 463         <tr class="property-row alt">
 464
 465         -->
 466
 467     </table>
 468
 469
 470   <!-- ============================== methods summary / details ======================== -->
 471
 472
 473   <a id="Roo.XComponent-methods"></a>
 474         <!-- constructor?? -->
 475
 476         <!-- static's first
 477
 478
 479         -->
 480
 481         <!-- then dynamics first -->
 482
 483
 484
 485
 486
 487
 488       <table cellspacing="0" class="member-table">
 489       <caption>Public Methods</caption>
 490         <tr>
 491             <th class="sig-header" colspan="2">Method</th>
 492             <th class="msource-header">Defined By</th>
 493
 494         </tr>
 495
 496
 497
 498
 499
 500
 501
 502           <tr class="method-row config-row-alt0 notInherited">
 503             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 504
 505
 506             <td class="sig">
 507                 <a id="Roo-method-XComponent"   name=".XComponent"></a>
 508                 <div class="fixedFont">
 509                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">XComponent</b>
 510
 511                                  ()
 512
 513
 514
 515                 </div>
 516                 <div class="mdesc">
 517
 518
 519                         <div class="short">Create a new Roo.XComponent</div>
 520
 521
 522                     <div class="long">
 523
 524
 525
 526                                 Create a new Roo.XComponent
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539                     </div>
 540                 </div>
 541
 542             </td>
 543             <td class="msource">
 544                 &nbsp;
 545             </td>
 546         </tr>
 547
 548
 549           <tr class="method-row config-row-alt1 expandable notInherited">
 550             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 551
 552
 553             <td class="sig">
 554                 <a id="Roo.XComponent-method-build"   name=".build"></a>
 555                 <div class="fixedFont">
 556                         <span class="attributes">Roo.XComponent.</span><b class="itemname">build</b>
 557
 558                                  (<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>)
 559
 560
 561
 562                 </div>
 563                 <div class="mdesc">
 564
 565                    <div class="short">Build the registered modules.</div>
 566
 567
 568
 569                     <div class="long">
 570
 571                                 Build the registered modules.
 572
 573
 574
 575
 576
 577
 578                                 <dl class="detailList">
 579                                 <dt class="heading">Parameters:</dt>
 580
 581                                         <dt>
 582                                                 <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>
 583
 584                                         </dt>
 585                                         <dd>element.</dd>
 586
 587                                         <dt>
 588                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>optional</b>
 589
 590                                         </dt>
 591                                         <dd>method to call after module has been added.</dd>
 592
 593                                 </dl>
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605                     </div>
 606                 </div>
 607
 608             </td>
 609             <td class="msource">
 610
 611                         Roo.XComponent
 612                 &nbsp;
 613             </td>
 614         </tr>
 615
 616
 617           <tr class="method-row config-row-alt0 expandable notInherited">
 618             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 619
 620
 621             <td class="sig">
 622                 <a id="Roo.XComponent-method-buildOrder"   name=".buildOrder"></a>
 623                 <div class="fixedFont">
 624                         <span class="attributes">Roo.XComponent.</span><b class="itemname">buildOrder</b>
 625
 626                                  ()
 627
 628
 629                                          :
 630
 631
 632                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 633
 634
 635
 636
 637
 638                 </div>
 639                 <div class="mdesc">
 640
 641                    <div class="short">make a list of modules to build.</div>
 642
 643
 644
 645                     <div class="long">
 646
 647                                 make a list of modules to build.
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658                                 <dl class="detailList">
 659                                 <dt class="heading">Returns:</dt>
 660
 661                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  list of modules.</dd>
 662
 663                                 </dl>
 664
 665
 666
 667
 668
 669
 670
 671                     </div>
 672                 </div>
 673
 674             </td>
 675             <td class="msource">
 676
 677                         Roo.XComponent
 678                 &nbsp;
 679             </td>
 680         </tr>
 681
 682
 683           <tr class="method-row config-row-alt1 expandable notInherited">
 684             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 685
 686
 687             <td class="sig">
 688                 <a id="Roo.XComponent-method-preBuild"   name=".preBuild"></a>
 689                 <div class="fixedFont">
 690                         <span class="attributes">Roo.XComponent.</span><b class="itemname">preBuild</b>
 691
 692                                  ()
 693
 694
 695
 696                 </div>
 697                 <div class="mdesc">
 698
 699                    <div class="short">move modules into their correct place in the tree.</div>
 700
 701
 702
 703                     <div class="long">
 704
 705                                 move modules into their correct place in the tree..
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722                     </div>
 723                 </div>
 724
 725             </td>
 726             <td class="msource">
 727
 728                         Roo.XComponent
 729                 &nbsp;
 730             </td>
 731         </tr>
 732
 733
 734           <tr class="method-row config-row-alt0 expandable notInherited">
 735             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 736
 737
 738             <td class="sig">
 739                 <a id="Roo.XComponent-method-register"   name=".register"></a>
 740                 <div class="fixedFont">
 741                         <span class="attributes">Roo.XComponent.</span><b class="itemname">register</b>
 742
 743                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>details</i></B>)
 744
 745
 746
 747                 </div>
 748                 <div class="mdesc">
 749
 750                    <div class="short">Register components to be built later.</div>
 751
 752
 753
 754                     <div class="long">
 755
 756                                 Register components to be built later.
 757
 758
 759
 760
 761
 762
 763                                 <dl class="detailList">
 764                                 <dt class="heading">Parameters:</dt>
 765
 766                                         <dt>
 767                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>details</b>
 768
 769                                         </dt>
 770                                         <dd>about module<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/>        })</dd>
 771
 772                                 </dl>
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784                     </div>
 785                 </div>
 786
 787             </td>
 788             <td class="msource">
 789
 790                         Roo.XComponent
 791                 &nbsp;
 792             </td>
 793         </tr>
 794
 795
 796           <tr class="method-row config-row-alt1 expandable notInherited">
 797             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 798
 799
 800             <td class="sig">
 801                 <a id="Roo.XComponent-method-toObject"   name=".toObject"></a>
 802                 <div class="fixedFont">
 803                         <span class="attributes">Roo.XComponent.</span><b class="itemname">toObject</b>
 804
 805                                  ()
 806
 807
 808
 809                 </div>
 810                 <div class="mdesc">
 811
 812                    <div class="short">convert a string to an object.</div>
 813
 814
 815
 816                     <div class="long">
 817
 818                                 convert a string to an object..
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835                     </div>
 836                 </div>
 837
 838             </td>
 839             <td class="msource">
 840
 841                         Roo.XComponent
 842                 &nbsp;
 843             </td>
 844         </tr>
 845
 846
 847           <tr class="method-row config-row-alt0 expandable">
 848             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 849
 850
 851             <td class="sig">
 852                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 853                 <div class="fixedFont">
 854                         <span class="attributes"></span><b class="itemname">addEvents</b>
 855
 856                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 857
 858
 859
 860                 </div>
 861                 <div class="mdesc">
 862
 863                    <div class="short">Used to define events on this Observable</div>
 864
 865
 866
 867                     <div class="long">
 868
 869                                 Used to define events on this Observable
 870
 871
 872
 873
 874
 875
 876                                 <dl class="detailList">
 877                                 <dt class="heading">Parameters:</dt>
 878
 879                                         <dt>
 880                                                 <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>
 881
 882                                         </dt>
 883                                         <dd>The object with the events defined</dd>
 884
 885                                 </dl>
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897                     </div>
 898                 </div>
 899
 900             </td>
 901             <td class="msource">
 902
 903                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 904                 &nbsp;
 905             </td>
 906         </tr>
 907
 908
 909           <tr class="method-row config-row-alt1 expandable">
 910             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 911
 912
 913             <td class="sig">
 914                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 915                 <div class="fixedFont">
 916                         <span class="attributes"></span><b class="itemname">addListener</b>
 917
 918                                  (<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>)
 919
 920
 921
 922                 </div>
 923                 <div class="mdesc">
 924
 925                    <div class="short">Appends an event handler to this component</div>
 926
 927
 928
 929                     <div class="long">
 930
 931                                 Appends an event handler to this component
 932
 933
 934
 935
 936
 937
 938                                 <dl class="detailList">
 939                                 <dt class="heading">Parameters:</dt>
 940
 941                                         <dt>
 942                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 943
 944                                         </dt>
 945                                         <dd>The type of event to listen for</dd>
 946
 947                                         <dt>
 948                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 949
 950                                         </dt>
 951                                         <dd>The method the event invokes</dd>
 952
 953                                         <dt>
 954                                                 <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>
 955
 956                                         </dt>
 957                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 958
 959                                         <dt>
 960                                                 <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>
 961
 962                                         </dt>
 963                                         <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>
 964
 965                                 </dl>
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977                     </div>
 978                 </div>
 979
 980             </td>
 981             <td class="msource">
 982
 983                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 984                 &nbsp;
 985             </td>
 986         </tr>
 987
 988
 989           <tr class="method-row config-row-alt0 expandable">
 990             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 991
 992
 993             <td class="sig">
 994                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 995                 <div class="fixedFont">
 996                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 997
 998                                  (<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>)
 999
1000
1001                                          :
1002
1003
1004                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1005
1006
1007
1008
1009
1010                 </div>
1011                 <div class="mdesc">
1012
1013                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1014
1015
1016
1017                     <div class="long">
1018
1019                                 Fires the specified event with the passed parameters (minus the event name).
1020
1021
1022
1023
1024
1025
1026                                 <dl class="detailList">
1027                                 <dt class="heading">Parameters:</dt>
1028
1029                                         <dt>
1030                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1031
1032                                         </dt>
1033                                         <dd></dd>
1034
1035                                         <dt>
1036                                                 <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>
1037
1038                                         </dt>
1039                                         <dd>Variable number of parameters are passed to handlers</dd>
1040
1041                                 </dl>
1042
1043
1044
1045
1046
1047                                 <dl class="detailList">
1048                                 <dt class="heading">Returns:</dt>
1049
1050                                         <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>
1051
1052                                 </dl>
1053
1054
1055
1056
1057
1058
1059
1060                     </div>
1061                 </div>
1062
1063             </td>
1064             <td class="msource">
1065
1066                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1067                 &nbsp;
1068             </td>
1069         </tr>
1070
1071
1072           <tr class="method-row config-row-alt1 expandable">
1073             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1074
1075
1076             <td class="sig">
1077                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1078                 <div class="fixedFont">
1079                         <span class="attributes"></span><b class="itemname">hasListener</b>
1080
1081                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1082
1083
1084                                          :
1085
1086
1087                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1088
1089
1090
1091
1092
1093                 </div>
1094                 <div class="mdesc">
1095
1096                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1097
1098
1099
1100                     <div class="long">
1101
1102                                 Checks to see if this object has any listeners for a specified event
1103
1104
1105
1106
1107
1108
1109                                 <dl class="detailList">
1110                                 <dt class="heading">Parameters:</dt>
1111
1112                                         <dt>
1113                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1114
1115                                         </dt>
1116                                         <dd>The name of the event to check for</dd>
1117
1118                                 </dl>
1119
1120
1121
1122
1123
1124                                 <dl class="detailList">
1125                                 <dt class="heading">Returns:</dt>
1126
1127                                         <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>
1128
1129                                 </dl>
1130
1131
1132
1133
1134
1135
1136
1137                     </div>
1138                 </div>
1139
1140             </td>
1141             <td class="msource">
1142
1143                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1144                 &nbsp;
1145             </td>
1146         </tr>
1147
1148
1149           <tr class="method-row config-row-alt0 expandable">
1150             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1151
1152
1153             <td class="sig">
1154                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1155                 <div class="fixedFont">
1156                         <span class="attributes"></span><b class="itemname">on</b>
1157
1158                                  (<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>)
1159
1160
1161
1162                 </div>
1163                 <div class="mdesc">
1164
1165                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1166
1167
1168
1169                     <div class="long">
1170
1171                                 Appends an event handler to this element (shorthand for addListener)
1172
1173
1174
1175
1176
1177
1178                                 <dl class="detailList">
1179                                 <dt class="heading">Parameters:</dt>
1180
1181                                         <dt>
1182                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1183
1184                                         </dt>
1185                                         <dd>The type of event to listen for</dd>
1186
1187                                         <dt>
1188                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1189
1190                                         </dt>
1191                                         <dd>The method the event invokes</dd>
1192
1193                                         <dt>
1194                                                 <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>
1195
1196                                         </dt>
1197                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</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>options</b>
1201
1202                                         </dt>
1203                                         <dd>(optional)</dd>
1204
1205                                 </dl>
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217                     </div>
1218                 </div>
1219
1220             </td>
1221             <td class="msource">
1222
1223                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1224                 &nbsp;
1225             </td>
1226         </tr>
1227
1228
1229           <tr class="method-row config-row-alt1 expandable">
1230             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1231
1232
1233             <td class="sig">
1234                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1235                 <div class="fixedFont">
1236                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1237
1238                                  ()
1239
1240
1241
1242                 </div>
1243                 <div class="mdesc">
1244
1245                    <div class="short">Removes all listeners for this object</div>
1246
1247
1248
1249                     <div class="long">
1250
1251                                 Removes all listeners for this object
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268                     </div>
1269                 </div>
1270
1271             </td>
1272             <td class="msource">
1273
1274                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1275                 &nbsp;
1276             </td>
1277         </tr>
1278
1279
1280           <tr class="method-row config-row-alt0 expandable">
1281             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1282
1283
1284             <td class="sig">
1285                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1286                 <div class="fixedFont">
1287                         <span class="attributes"></span><b class="itemname">removeListener</b>
1288
1289                                  (<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>)
1290
1291
1292
1293                 </div>
1294                 <div class="mdesc">
1295
1296                    <div class="short">Removes a listener</div>
1297
1298
1299
1300                     <div class="long">
1301
1302                                 Removes a listener
1303
1304
1305
1306
1307
1308
1309                                 <dl class="detailList">
1310                                 <dt class="heading">Parameters:</dt>
1311
1312                                         <dt>
1313                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1314
1315                                         </dt>
1316                                         <dd>The type of event to listen for</dd>
1317
1318                                         <dt>
1319                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1320
1321                                         </dt>
1322                                         <dd>The handler to remove</dd>
1323
1324                                         <dt>
1325                                                 <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>
1326
1327                                         </dt>
1328                                         <dd>(optional) The scope (this object) for the handler</dd>
1329
1330                                 </dl>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342                     </div>
1343                 </div>
1344
1345             </td>
1346             <td class="msource">
1347
1348                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1349                 &nbsp;
1350             </td>
1351         </tr>
1352
1353
1354           <tr class="method-row config-row-alt1 expandable">
1355             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1356
1357
1358             <td class="sig">
1359                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1360                 <div class="fixedFont">
1361                         <span class="attributes"></span><b class="itemname">un</b>
1362
1363                                  (<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>)
1364
1365
1366
1367                 </div>
1368                 <div class="mdesc">
1369
1370                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1371
1372
1373
1374                     <div class="long">
1375
1376                                 Removes a listener (shorthand for removeListener)
1377
1378
1379
1380
1381
1382
1383                                 <dl class="detailList">
1384                                 <dt class="heading">Parameters:</dt>
1385
1386                                         <dt>
1387                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1388
1389                                         </dt>
1390                                         <dd>The type of event to listen for</dd>
1391
1392                                         <dt>
1393                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1394
1395                                         </dt>
1396                                         <dd>The handler to remove</dd>
1397
1398                                         <dt>
1399                                                 <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>
1400
1401                                         </dt>
1402                                         <dd>(optional) The scope (this object) for the handler</dd>
1403
1404                                 </dl>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416                     </div>
1417                 </div>
1418
1419             </td>
1420             <td class="msource">
1421
1422                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1423                 &nbsp;
1424             </td>
1425         </tr>
1426
1427
1428     </table>
1429
1430
1431   <!-- ============================== events summary / details ======================== -->
1432
1433
1434   <a id="Roo.XComponent-events"></a>
1435
1436
1437
1438
1439
1440
1441
1442
1443       <table cellspacing="0" class="member-table">
1444                 <caption>Events</caption>
1445               <thead>
1446                 <tr>
1447                     <th class="sig-header" colspan="2">Event</th>
1448                     <th class="msource-header">Defined By</th>
1449
1450                 </tr>
1451               </thead>
1452
1453
1454
1455
1456
1457           <tr class="method-row expandable config-row-alt0 notInherited">
1458             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1459
1460             <td class="sig">
1461                 <a id="Roo.XComponent-event-*buildcomplete"></a>
1462
1463                <div class="fixedFont">
1464                 <b class="itemname">buildcomplete</b> (<a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a> <B><i>c</i></B>)
1465
1466                 </div>
1467
1468                 <div class="mdesc">
1469
1470                    <div class="short">Fires on the top level element when all elements have been built
1471
1472                 </div>
1473
1474                     <div class="long">
1475
1476                         Fires on the top level element when all elements have been built
1477
1478
1479
1480
1481
1482                                 <dl class="detailList">
1483                                 <dt class="heading">Parameters:</dt>
1484
1485                                         <dt>
1486                                                 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1487
1488                                         </dt>
1489                                         <dd>the top level component.</dd>
1490
1491                                 </dl>
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503                     </div>
1504                 </div>
1505
1506             </td>
1507             <td class="msource">
1508                 Roo.XComponent
1509             </td>
1510         </tr>
1511
1512           <tr class="method-row expandable config-row-alt1 notInherited">
1513             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1514
1515             <td class="sig">
1516                 <a id="Roo.XComponent-event-*built"></a>
1517
1518                <div class="fixedFont">
1519                 <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>)
1520
1521                 </div>
1522
1523                 <div class="mdesc">
1524
1525                    <div class="short">Fires when this the componnt is built
1526
1527                 </div>
1528
1529                     <div class="long">
1530
1531                         Fires when this the componnt is built
1532
1533
1534
1535
1536
1537                                 <dl class="detailList">
1538                                 <dt class="heading">Parameters:</dt>
1539
1540                                         <dt>
1541                                                 <span class="fixedFont"><a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a></span> <b>c</b>
1542
1543                                         </dt>
1544                                         <dd>the component</dd>
1545
1546                                 </dl>
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558                     </div>
1559                 </div>
1560
1561             </td>
1562             <td class="msource">
1563                 Roo.XComponent
1564             </td>
1565         </tr>
1566
1567
1568     </table>
1569
1570
1571
1572
1573
1574 <!-- ============================== footer ================================= -->
1575                 <div class="fineprint" style="clear:both">
1576
1577                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Mon Jul 19 2010 11:50:46 GMT+0800 (HKT)
1578                         Based on
1579                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1580                 </div>
1581         </body>
1582 </html>