git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Component.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.Component</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.Component-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.Component-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.Component-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.Component-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.Component
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.Component
  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_Component.js.html">Roo/Component.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">Component</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         Base class for all major Roo components.  All subclasses of Component can automatically participate in the standard<br/>Roo component lifecycle of creation, rendering and destruction.  They also have automatic support for basic hide/show<br/>and enable/disable behavior.  Component allows any subclass to be lazy-rendered into any {<b>link</b> Roo.Container} and<br/>to be automatically registered with the {<b>link</b> Roo.ComponentMgr} so that it can be referenced at any time via {<b>link</b> Roo.getCmp}.<br/>All visual components (widgets) that require rendering into a layout should subclass Component.
  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.Component';">[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.Component.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.Component-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.Component-cfg-actionMode" name=".actionMode"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">which property holds the element that used for  hide() / show() / disable() / enable()<br/>default is 'el'</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">which property holds the element that used for  hide() / show() / disable() / enable()<br/>default is 'el'</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.Component
 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.Component-cfg-allowDomMove" name=".allowDomMove"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.Component
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.Component
 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.Component-cfg-hideMode" name=".hideMode"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">hideMode</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">How this component should hidden.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.Component
 242
 243                     </td>
 244                 </tr>
 245
 246
 247     </table>
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257   <!-- ============================== public properties ==================== -->
 258
 259
 260
 261     <a id="Roo.Component-props"></a>
 262
 263
 264
 265
 266
 267      <table cellspacing="0" class="member-table">
 268       <caption class="Empty">Public Properties - Has None</caption>
 269      </table>
 270
 271
 272
 273
 274   <!-- ============================== methods summary / details ======================== -->
 275
 276
 277   <a id="Roo.Component-methods"></a>
 278         <!-- constructor?? -->
 279
 280         <!-- static's first
 281
 282
 283         -->
 284
 285         <!-- then dynamics first -->
 286
 287
 288
 289
 290
 291
 292       <table cellspacing="0" class="member-table">
 293       <caption>Public Methods</caption>
 294         <tr>
 295             <th class="sig-header" colspan="2">Method</th>
 296             <th class="msource-header">Defined By</th>
 297
 298         </tr>
 299
 300
 301
 302
 303
 304
 305
 306           <tr class="method-row config-row-alt0 expandable notInherited">
 307             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 308
 309
 310             <td class="sig">
 311                 <a id="Roo-method-Component"   name=".Component"></a>
 312                 <div class="fixedFont">
 313                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Component</b>
 314
 315                                  (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
 316
 317
 318
 319                 </div>
 320                 <div class="mdesc">
 321
 322
 323                         <div class="short">Create a new Roo.Component</div>
 324
 325
 326                     <div class="long">
 327
 328
 329
 330                                 Create a new Roo.Component
 331
 332
 333                                 <dl class="detailList">
 334                                 <dt class="heading">Parameters:</dt>
 335
 336                                         <dt>
 337                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span>  <b>config</b>
 338
 339                                         </dt>
 340                                         <dd>The configuration options.  If an element is passed, it is set as the internal<br/>element and its id used as the component id.  If a string is passed, it is assumed to be the id of an existing element<br/>and is used as the component id.  Otherwise, it is assumed to be a standard config object and is applied to the component.</dd>
 341
 342                                 </dl>
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354                     </div>
 355                 </div>
 356
 357             </td>
 358             <td class="msource">
 359                 &nbsp;
 360             </td>
 361         </tr>
 362
 363
 364           <tr class="method-row config-row-alt1 expandable notInherited">
 365             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 366
 367
 368             <td class="sig">
 369                 <a id="Roo.Component-method-destroy"   name=".destroy"></a>
 370                 <div class="fixedFont">
 371                         <span class="attributes"></span><b class="itemname">destroy</b>
 372
 373                                  ()
 374
 375
 376
 377                 </div>
 378                 <div class="mdesc">
 379
 380                    <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
 381
 382
 383
 384                     <div class="long">
 385
 386                                 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403                     </div>
 404                 </div>
 405
 406             </td>
 407             <td class="msource">
 408
 409                         Roo.Component
 410                 &nbsp;
 411             </td>
 412         </tr>
 413
 414
 415           <tr class="method-row config-row-alt0 expandable notInherited">
 416             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 417
 418
 419             <td class="sig">
 420                 <a id="Roo.Component-method-disable"   name=".disable"></a>
 421                 <div class="fixedFont">
 422                         <span class="attributes"></span><b class="itemname">disable</b>
 423
 424                                  ()
 425
 426
 427                                          :
 428
 429
 430                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 431
 432
 433
 434
 435
 436                 </div>
 437                 <div class="mdesc">
 438
 439                    <div class="short">Disable this component.</div>
 440
 441
 442
 443                     <div class="long">
 444
 445                                 Disable this component.
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456                                 <dl class="detailList">
 457                                 <dt class="heading">Returns:</dt>
 458
 459                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 460
 461                                 </dl>
 462
 463
 464
 465
 466
 467
 468
 469                     </div>
 470                 </div>
 471
 472             </td>
 473             <td class="msource">
 474
 475                         Roo.Component
 476                 &nbsp;
 477             </td>
 478         </tr>
 479
 480
 481           <tr class="method-row config-row-alt1 expandable notInherited">
 482             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 483
 484
 485             <td class="sig">
 486                 <a id="Roo.Component-method-enable"   name=".enable"></a>
 487                 <div class="fixedFont">
 488                         <span class="attributes"></span><b class="itemname">enable</b>
 489
 490                                  ()
 491
 492
 493                                          :
 494
 495
 496                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 497
 498
 499
 500
 501
 502                 </div>
 503                 <div class="mdesc">
 504
 505                    <div class="short">Enable this component.</div>
 506
 507
 508
 509                     <div class="long">
 510
 511                                 Enable this component.
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522                                 <dl class="detailList">
 523                                 <dt class="heading">Returns:</dt>
 524
 525                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 526
 527                                 </dl>
 528
 529
 530
 531
 532
 533
 534
 535                     </div>
 536                 </div>
 537
 538             </td>
 539             <td class="msource">
 540
 541                         Roo.Component
 542                 &nbsp;
 543             </td>
 544         </tr>
 545
 546
 547           <tr class="method-row config-row-alt0 expandable notInherited">
 548             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 549
 550
 551             <td class="sig">
 552                 <a id="Roo.Component-method-focus"   name=".focus"></a>
 553                 <div class="fixedFont">
 554                         <span class="attributes"></span><b class="itemname">focus</b>
 555
 556                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
 557
 558
 559                                          :
 560
 561
 562                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 563
 564
 565
 566
 567
 568                 </div>
 569                 <div class="mdesc">
 570
 571                    <div class="short">Try to focus this component.</div>
 572
 573
 574
 575                     <div class="long">
 576
 577                                 Try to focus this component.
 578
 579
 580
 581
 582
 583
 584                                 <dl class="detailList">
 585                                 <dt class="heading">Parameters:</dt>
 586
 587                                         <dt>
 588                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>selectText</b>
 589
 590                                         </dt>
 591                                         <dd>True to also select the text in this component (if applicable)</dd>
 592
 593                                 </dl>
 594
 595
 596
 597
 598
 599                                 <dl class="detailList">
 600                                 <dt class="heading">Returns:</dt>
 601
 602                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 603
 604                                 </dl>
 605
 606
 607
 608
 609
 610
 611
 612                     </div>
 613                 </div>
 614
 615             </td>
 616             <td class="msource">
 617
 618                         Roo.Component
 619                 &nbsp;
 620             </td>
 621         </tr>
 622
 623
 624           <tr class="method-row config-row-alt1 expandable notInherited">
 625             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 626
 627
 628             <td class="sig">
 629                 <a id="Roo.Component-method-getEl"   name=".getEl"></a>
 630                 <div class="fixedFont">
 631                         <span class="attributes"></span><b class="itemname">getEl</b>
 632
 633                                  ()
 634
 635
 636                                          :
 637
 638
 639                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 640
 641
 642
 643
 644
 645                 </div>
 646                 <div class="mdesc">
 647
 648                    <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
 649
 650
 651
 652                     <div class="long">
 653
 654                                 Returns the underlying {<b>link</b> Roo.Element}.
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665                                 <dl class="detailList">
 666                                 <dt class="heading">Returns:</dt>
 667
 668                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  The element</dd>
 669
 670                                 </dl>
 671
 672
 673
 674
 675
 676
 677
 678                     </div>
 679                 </div>
 680
 681             </td>
 682             <td class="msource">
 683
 684                         Roo.Component
 685                 &nbsp;
 686             </td>
 687         </tr>
 688
 689
 690           <tr class="method-row config-row-alt0 expandable notInherited">
 691             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 692
 693
 694             <td class="sig">
 695                 <a id="Roo.Component-method-getId"   name=".getId"></a>
 696                 <div class="fixedFont">
 697                         <span class="attributes"></span><b class="itemname">getId</b>
 698
 699                                  ()
 700
 701
 702                                          :
 703
 704
 705                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 706
 707
 708
 709
 710
 711                 </div>
 712                 <div class="mdesc">
 713
 714                    <div class="short">Returns the id of this component.</div>
 715
 716
 717
 718                     <div class="long">
 719
 720                                 Returns the id of this component.
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731                                 <dl class="detailList">
 732                                 <dt class="heading">Returns:</dt>
 733
 734                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
 735
 736                                 </dl>
 737
 738
 739
 740
 741
 742
 743
 744                     </div>
 745                 </div>
 746
 747             </td>
 748             <td class="msource">
 749
 750                         Roo.Component
 751                 &nbsp;
 752             </td>
 753         </tr>
 754
 755
 756           <tr class="method-row config-row-alt1 expandable notInherited">
 757             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 758
 759
 760             <td class="sig">
 761                 <a id="Roo.Component-method-hide"   name=".hide"></a>
 762                 <div class="fixedFont">
 763                         <span class="attributes"></span><b class="itemname">hide</b>
 764
 765                                  ()
 766
 767
 768                                          :
 769
 770
 771                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 772
 773
 774
 775
 776
 777                 </div>
 778                 <div class="mdesc">
 779
 780                    <div class="short">Hide this component.</div>
 781
 782
 783
 784                     <div class="long">
 785
 786                                 Hide this component.
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797                                 <dl class="detailList">
 798                                 <dt class="heading">Returns:</dt>
 799
 800                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 801
 802                                 </dl>
 803
 804
 805
 806
 807
 808
 809
 810                     </div>
 811                 </div>
 812
 813             </td>
 814             <td class="msource">
 815
 816                         Roo.Component
 817                 &nbsp;
 818             </td>
 819         </tr>
 820
 821
 822           <tr class="method-row config-row-alt0 expandable notInherited">
 823             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 824
 825
 826             <td class="sig">
 827                 <a id="Roo.Component-method-isVisible"   name=".isVisible"></a>
 828                 <div class="fixedFont">
 829                         <span class="attributes"></span><b class="itemname">isVisible</b>
 830
 831                                  ()
 832
 833
 834
 835                 </div>
 836                 <div class="mdesc">
 837
 838                    <div class="short">Returns true if this component is visible.</div>
 839
 840
 841
 842                     <div class="long">
 843
 844                                 Returns true if this component is visible.
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861                     </div>
 862                 </div>
 863
 864             </td>
 865             <td class="msource">
 866
 867                         Roo.Component
 868                 &nbsp;
 869             </td>
 870         </tr>
 871
 872
 873           <tr class="method-row config-row-alt1 expandable notInherited">
 874             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 875
 876
 877             <td class="sig">
 878                 <a id="Roo.Component-method-render"   name=".render"></a>
 879                 <div class="fixedFont">
 880                         <span class="attributes"></span><b class="itemname">render</b>
 881
 882                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
 883
 884
 885
 886                 </div>
 887                 <div class="mdesc">
 888
 889                    <div class="short">If this is a lazy rendering component, render it to its container element.</div>
 890
 891
 892
 893                     <div class="long">
 894
 895                                 If this is a lazy rendering component, render it to its container element.
 896
 897
 898
 899
 900
 901
 902                                 <dl class="detailList">
 903                                 <dt class="heading">Parameters:</dt>
 904
 905                                         <dt>
 906                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
 907
 908                                         </dt>
 909                                         <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
 910
 911                                 </dl>
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923                     </div>
 924                 </div>
 925
 926             </td>
 927             <td class="msource">
 928
 929                         Roo.Component
 930                 &nbsp;
 931             </td>
 932         </tr>
 933
 934
 935           <tr class="method-row config-row-alt0 expandable notInherited">
 936             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 937
 938
 939             <td class="sig">
 940                 <a id="Roo.Component-method-setDisabled"   name=".setDisabled"></a>
 941                 <div class="fixedFont">
 942                         <span class="attributes"></span><b class="itemname">setDisabled</b>
 943
 944                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
 945
 946
 947
 948                 </div>
 949                 <div class="mdesc">
 950
 951                    <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
 952
 953
 954
 955                     <div class="long">
 956
 957                                 Convenience function for setting disabled/enabled by boolean.
 958
 959
 960
 961
 962
 963
 964                                 <dl class="detailList">
 965                                 <dt class="heading">Parameters:</dt>
 966
 967                                         <dt>
 968                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>disabled</b>
 969
 970                                         </dt>
 971                                         <dd></dd>
 972
 973                                 </dl>
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985                     </div>
 986                 </div>
 987
 988             </td>
 989             <td class="msource">
 990
 991                         Roo.Component
 992                 &nbsp;
 993             </td>
 994         </tr>
 995
 996
 997           <tr class="method-row config-row-alt1 expandable notInherited">
 998             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 999
1000
1001             <td class="sig">
1002                 <a id="Roo.Component-method-setVisible"   name=".setVisible"></a>
1003                 <div class="fixedFont">
1004                         <span class="attributes"></span><b class="itemname">setVisible</b>
1005
1006                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1007
1008
1009                                          :
1010
1011
1012                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1013
1014
1015
1016
1017
1018                 </div>
1019                 <div class="mdesc">
1020
1021                    <div class="short">Convenience function to hide or show this component by boolean.</div>
1022
1023
1024
1025                     <div class="long">
1026
1027                                 Convenience function to hide or show this component by boolean.
1028
1029
1030
1031
1032
1033
1034                                 <dl class="detailList">
1035                                 <dt class="heading">Parameters:</dt>
1036
1037                                         <dt>
1038                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>visible</b>
1039
1040                                         </dt>
1041                                         <dd>True to show, false to hide</dd>
1042
1043                                 </dl>
1044
1045
1046
1047
1048
1049                                 <dl class="detailList">
1050                                 <dt class="heading">Returns:</dt>
1051
1052                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
1053
1054                                 </dl>
1055
1056
1057
1058
1059
1060
1061
1062                     </div>
1063                 </div>
1064
1065             </td>
1066             <td class="msource">
1067
1068                         Roo.Component
1069                 &nbsp;
1070             </td>
1071         </tr>
1072
1073
1074           <tr class="method-row config-row-alt0 expandable notInherited">
1075             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1076
1077
1078             <td class="sig">
1079                 <a id="Roo.Component-method-show"   name=".show"></a>
1080                 <div class="fixedFont">
1081                         <span class="attributes"></span><b class="itemname">show</b>
1082
1083                                  ()
1084
1085
1086                                          :
1087
1088
1089                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1090
1091
1092
1093
1094
1095                 </div>
1096                 <div class="mdesc">
1097
1098                    <div class="short">Show this component.</div>
1099
1100
1101
1102                     <div class="long">
1103
1104                                 Show this component.
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115                                 <dl class="detailList">
1116                                 <dt class="heading">Returns:</dt>
1117
1118                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
1119
1120                                 </dl>
1121
1122
1123
1124
1125
1126
1127
1128                     </div>
1129                 </div>
1130
1131             </td>
1132             <td class="msource">
1133
1134                         Roo.Component
1135                 &nbsp;
1136             </td>
1137         </tr>
1138
1139
1140     </table>
1141
1142
1143   <!-- ============================== events summary / details ======================== -->
1144
1145
1146   <a id="Roo.Component-events"></a>
1147
1148
1149
1150
1151
1152
1153
1154
1155       <table cellspacing="0" class="member-table">
1156                 <caption>Events</caption>
1157               <thead>
1158                 <tr>
1159                     <th class="sig-header" colspan="2">Event</th>
1160                     <th class="msource-header">Defined By</th>
1161
1162                 </tr>
1163               </thead>
1164
1165
1166
1167
1168
1169           <tr class="method-row expandable config-row-alt0 notInherited">
1170             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1171
1172             <td class="sig">
1173                 <a id="Roo.Component-event-*beforedestroy"></a>
1174
1175                <div class="fixedFont">
1176                 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1177
1178                 </div>
1179
1180                 <div class="mdesc">
1181
1182                    <div class="short">Fires before the component is destroyed.
1183
1184                 </div>
1185
1186                     <div class="long">
1187
1188                         Fires before the component is destroyed. Return false to stop the destroy.
1189
1190
1191
1192
1193
1194                                 <dl class="detailList">
1195                                 <dt class="heading">Parameters:</dt>
1196
1197                                         <dt>
1198                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1199
1200                                         </dt>
1201                                         <dd></dd>
1202
1203                                 </dl>
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215                     </div>
1216                 </div>
1217
1218             </td>
1219             <td class="msource">
1220                 Roo.Component
1221             </td>
1222         </tr>
1223
1224           <tr class="method-row expandable config-row-alt1 notInherited">
1225             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1226
1227             <td class="sig">
1228                 <a id="Roo.Component-event-*beforehide"></a>
1229
1230                <div class="fixedFont">
1231                 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1232
1233                 </div>
1234
1235                 <div class="mdesc">
1236
1237                    <div class="short">Fires before the component is hidden.
1238
1239                 </div>
1240
1241                     <div class="long">
1242
1243                         Fires before the component is hidden. Return false to stop the hide.
1244
1245
1246
1247
1248
1249                                 <dl class="detailList">
1250                                 <dt class="heading">Parameters:</dt>
1251
1252                                         <dt>
1253                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1254
1255                                         </dt>
1256                                         <dd></dd>
1257
1258                                 </dl>
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270                     </div>
1271                 </div>
1272
1273             </td>
1274             <td class="msource">
1275                 Roo.Component
1276             </td>
1277         </tr>
1278
1279           <tr class="method-row expandable config-row-alt0 notInherited">
1280             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1281
1282             <td class="sig">
1283                 <a id="Roo.Component-event-*beforerender"></a>
1284
1285                <div class="fixedFont">
1286                 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1287
1288                 </div>
1289
1290                 <div class="mdesc">
1291
1292                    <div class="short">Fires before the component is rendered.
1293
1294                 </div>
1295
1296                     <div class="long">
1297
1298                         Fires before the component is rendered. Return false to stop the render.
1299
1300
1301
1302
1303
1304                                 <dl class="detailList">
1305                                 <dt class="heading">Parameters:</dt>
1306
1307                                         <dt>
1308                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1309
1310                                         </dt>
1311                                         <dd></dd>
1312
1313                                 </dl>
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325                     </div>
1326                 </div>
1327
1328             </td>
1329             <td class="msource">
1330                 Roo.Component
1331             </td>
1332         </tr>
1333
1334           <tr class="method-row expandable config-row-alt1 notInherited">
1335             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1336
1337             <td class="sig">
1338                 <a id="Roo.Component-event-*beforeshow"></a>
1339
1340                <div class="fixedFont">
1341                 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1342
1343                 </div>
1344
1345                 <div class="mdesc">
1346
1347                    <div class="short">Fires before the component is shown.
1348
1349                 </div>
1350
1351                     <div class="long">
1352
1353                         Fires before the component is shown.  Return false to stop the show.
1354
1355
1356
1357
1358
1359                                 <dl class="detailList">
1360                                 <dt class="heading">Parameters:</dt>
1361
1362                                         <dt>
1363                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1364
1365                                         </dt>
1366                                         <dd></dd>
1367
1368                                 </dl>
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380                     </div>
1381                 </div>
1382
1383             </td>
1384             <td class="msource">
1385                 Roo.Component
1386             </td>
1387         </tr>
1388
1389           <tr class="method-row expandable config-row-alt0 notInherited">
1390             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1391
1392             <td class="sig">
1393                 <a id="Roo.Component-event-*destroy"></a>
1394
1395                <div class="fixedFont">
1396                 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1397
1398                 </div>
1399
1400                 <div class="mdesc">
1401
1402                    <div class="short">Fires after the component is destroyed.
1403
1404                 </div>
1405
1406                     <div class="long">
1407
1408                         Fires after the component is destroyed.
1409
1410
1411
1412
1413
1414                                 <dl class="detailList">
1415                                 <dt class="heading">Parameters:</dt>
1416
1417                                         <dt>
1418                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1419
1420                                         </dt>
1421                                         <dd></dd>
1422
1423                                 </dl>
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435                     </div>
1436                 </div>
1437
1438             </td>
1439             <td class="msource">
1440                 Roo.Component
1441             </td>
1442         </tr>
1443
1444           <tr class="method-row expandable config-row-alt1 notInherited">
1445             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1446
1447             <td class="sig">
1448                 <a id="Roo.Component-event-*disable"></a>
1449
1450                <div class="fixedFont">
1451                 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1452
1453                 </div>
1454
1455                 <div class="mdesc">
1456
1457                    <div class="short">Fires after the component is disabled.
1458
1459                 </div>
1460
1461                     <div class="long">
1462
1463                         Fires after the component is disabled.
1464
1465
1466
1467
1468
1469                                 <dl class="detailList">
1470                                 <dt class="heading">Parameters:</dt>
1471
1472                                         <dt>
1473                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1474
1475                                         </dt>
1476                                         <dd></dd>
1477
1478                                 </dl>
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490                     </div>
1491                 </div>
1492
1493             </td>
1494             <td class="msource">
1495                 Roo.Component
1496             </td>
1497         </tr>
1498
1499           <tr class="method-row expandable config-row-alt0 notInherited">
1500             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1501
1502             <td class="sig">
1503                 <a id="Roo.Component-event-*enable"></a>
1504
1505                <div class="fixedFont">
1506                 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1507
1508                 </div>
1509
1510                 <div class="mdesc">
1511
1512                    <div class="short">Fires after the component is enabled.
1513
1514                 </div>
1515
1516                     <div class="long">
1517
1518                         Fires after the component is enabled.
1519
1520
1521
1522
1523
1524                                 <dl class="detailList">
1525                                 <dt class="heading">Parameters:</dt>
1526
1527                                         <dt>
1528                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1529
1530                                         </dt>
1531                                         <dd></dd>
1532
1533                                 </dl>
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545                     </div>
1546                 </div>
1547
1548             </td>
1549             <td class="msource">
1550                 Roo.Component
1551             </td>
1552         </tr>
1553
1554           <tr class="method-row expandable config-row-alt1 notInherited">
1555             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1556
1557             <td class="sig">
1558                 <a id="Roo.Component-event-*hide"></a>
1559
1560                <div class="fixedFont">
1561                 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1562
1563                 </div>
1564
1565                 <div class="mdesc">
1566
1567                    <div class="short">Fires after the component is hidden.
1568
1569                 </div>
1570
1571                     <div class="long">
1572
1573                         Fires after the component is hidden.
1574
1575
1576
1577
1578
1579                                 <dl class="detailList">
1580                                 <dt class="heading">Parameters:</dt>
1581
1582                                         <dt>
1583                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1584
1585                                         </dt>
1586                                         <dd></dd>
1587
1588                                 </dl>
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600                     </div>
1601                 </div>
1602
1603             </td>
1604             <td class="msource">
1605                 Roo.Component
1606             </td>
1607         </tr>
1608
1609           <tr class="method-row expandable config-row-alt0 notInherited">
1610             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1611
1612             <td class="sig">
1613                 <a id="Roo.Component-event-*render"></a>
1614
1615                <div class="fixedFont">
1616                 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1617
1618                 </div>
1619
1620                 <div class="mdesc">
1621
1622                    <div class="short">Fires after the component is rendered.
1623
1624                 </div>
1625
1626                     <div class="long">
1627
1628                         Fires after the component is rendered.
1629
1630
1631
1632
1633
1634                                 <dl class="detailList">
1635                                 <dt class="heading">Parameters:</dt>
1636
1637                                         <dt>
1638                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1639
1640                                         </dt>
1641                                         <dd></dd>
1642
1643                                 </dl>
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655                     </div>
1656                 </div>
1657
1658             </td>
1659             <td class="msource">
1660                 Roo.Component
1661             </td>
1662         </tr>
1663
1664           <tr class="method-row expandable config-row-alt1 notInherited">
1665             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1666
1667             <td class="sig">
1668                 <a id="Roo.Component-event-*show"></a>
1669
1670                <div class="fixedFont">
1671                 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1672
1673                 </div>
1674
1675                 <div class="mdesc">
1676
1677                    <div class="short">Fires after the component is shown.
1678
1679                 </div>
1680
1681                     <div class="long">
1682
1683                         Fires after the component is shown.
1684
1685
1686
1687
1688
1689                                 <dl class="detailList">
1690                                 <dt class="heading">Parameters:</dt>
1691
1692                                         <dt>
1693                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1694
1695                                         </dt>
1696                                         <dd></dd>
1697
1698                                 </dl>
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710                     </div>
1711                 </div>
1712
1713             </td>
1714             <td class="msource">
1715                 Roo.Component
1716             </td>
1717         </tr>
1718
1719
1720     </table>
1721
1722
1723
1724
1725
1726 <!-- ============================== footer ================================= -->
1727                 <div class="fineprint" style="clear:both">
1728
1729                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:21 GMT+0800 (HKT)
1730                         Based on
1731                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1732                 </div>
1733         </body>
1734 </html>