git.roojs.org Git - roojs1/blob - docs/symbols/Roo.BasicLayoutRegion.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.BasicLayoutRegion</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.BasicLayoutRegion-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.BasicLayoutRegion-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.BasicLayoutRegion-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.BasicLayoutRegion-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.BasicLayoutRegion
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.BasicLayoutRegion
  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_BasicLayoutRegion.js.html">Roo/BasicLayoutRegion.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">BasicLayoutRegion</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         This class represents a lightweight region in a layout manager. This region does not move dom nodes<br/>and does not have a titlebar, tabs or any other features. All it does is size and position <br/>panels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.
  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.BasicLayoutRegion';">[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.BasicLayoutRegion.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.BasicLayoutRegion-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.BasicLayoutRegion-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.BasicLayoutRegion-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo-method-BasicLayoutRegion"   name=".BasicLayoutRegion"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">BasicLayoutRegion</b>
 183
 184                                  ()
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.BasicLayoutRegion</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.BasicLayoutRegion
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212                     </div>
 213                 </div>
 214
 215             </td>
 216             <td class="msource">
 217                 &nbsp;
 218             </td>
 219         </tr>
 220
 221
 222           <tr class="method-row config-row-alt1 expandable notInherited">
 223             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 224
 225
 226             <td class="sig">
 227                 <a id="Roo.BasicLayoutRegion-method-add"   name=".add"></a>
 228                 <div class="fixedFont">
 229                         <span class="attributes"></span><b class="itemname">add</b>
 230
 231                                  (ContentPanel... <B><i>panel</i></B>)
 232
 233
 234                                          :
 235
 236
 237                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 238
 239
 240
 241
 242
 243                 </div>
 244                 <div class="mdesc">
 245
 246                    <div class="short">Add the passed ContentPanel(s)</div>
 247
 248
 249
 250                     <div class="long">
 251
 252                                 Add the passed ContentPanel(s)
 253
 254
 255
 256
 257
 258
 259                                 <dl class="detailList">
 260                                 <dt class="heading">Parameters:</dt>
 261
 262                                         <dt>
 263                                                 <span class="fixedFont">ContentPanel...</span>  <b>panel</b>
 264
 265                                         </dt>
 266                                         <dd>The ContentPanel(s) to add (you can pass more than one)</dd>
 267
 268                                 </dl>
 269
 270
 271
 272
 273
 274                                 <dl class="detailList">
 275                                 <dt class="heading">Returns:</dt>
 276
 277                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The panel added (if only one was added)</dd>
 278
 279                                 </dl>
 280
 281
 282
 283
 284
 285
 286
 287                     </div>
 288                 </div>
 289
 290             </td>
 291             <td class="msource">
 292
 293                         Roo.BasicLayoutRegion
 294                 &nbsp;
 295             </td>
 296         </tr>
 297
 298
 299           <tr class="method-row config-row-alt0 expandable notInherited">
 300             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 301
 302
 303             <td class="sig">
 304                 <a id="Roo.BasicLayoutRegion-method-getActivePanel"   name=".getActivePanel"></a>
 305                 <div class="fixedFont">
 306                         <span class="attributes"></span><b class="itemname">getActivePanel</b>
 307
 308                                  ()
 309
 310
 311                                          :
 312
 313
 314                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 315
 316
 317
 318
 319
 320                 </div>
 321                 <div class="mdesc">
 322
 323                    <div class="short">Get the active panel for this region.</div>
 324
 325
 326
 327                     <div class="long">
 328
 329                                 Get the active panel for this region.
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340                                 <dl class="detailList">
 341                                 <dt class="heading">Returns:</dt>
 342
 343                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The active panel or null</dd>
 344
 345                                 </dl>
 346
 347
 348
 349
 350
 351
 352
 353                     </div>
 354                 </div>
 355
 356             </td>
 357             <td class="msource">
 358
 359                         Roo.BasicLayoutRegion
 360                 &nbsp;
 361             </td>
 362         </tr>
 363
 364
 365           <tr class="method-row config-row-alt1 expandable notInherited">
 366             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 367
 368
 369             <td class="sig">
 370                 <a id="Roo.BasicLayoutRegion-method-getEl"   name=".getEl"></a>
 371                 <div class="fixedFont">
 372                         <span class="attributes"></span><b class="itemname">getEl</b>
 373
 374                                  ()
 375
 376
 377                                          :
 378
 379
 380                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 381
 382
 383
 384
 385
 386                 </div>
 387                 <div class="mdesc">
 388
 389                    <div class="short">Returns the container element for this region.</div>
 390
 391
 392
 393                     <div class="long">
 394
 395                                 Returns the container element for this region.
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406                                 <dl class="detailList">
 407                                 <dt class="heading">Returns:</dt>
 408
 409                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 410
 411                                 </dl>
 412
 413
 414
 415
 416
 417
 418
 419                     </div>
 420                 </div>
 421
 422             </td>
 423             <td class="msource">
 424
 425                         Roo.BasicLayoutRegion
 426                 &nbsp;
 427             </td>
 428         </tr>
 429
 430
 431           <tr class="method-row config-row-alt0 expandable notInherited">
 432             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 433
 434
 435             <td class="sig">
 436                 <a id="Roo.BasicLayoutRegion-method-getPanel"   name=".getPanel"></a>
 437                 <div class="fixedFont">
 438                         <span class="attributes"></span><b class="itemname">getPanel</b>
 439
 440                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
 441
 442
 443                                          :
 444
 445
 446                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 447
 448
 449
 450
 451
 452                 </div>
 453                 <div class="mdesc">
 454
 455                    <div class="short">Returns the panel specified or null if it's not in this region.</div>
 456
 457
 458
 459                     <div class="long">
 460
 461                                 Returns the panel specified or null if it's not in this region.
 462
 463
 464
 465
 466
 467
 468                                 <dl class="detailList">
 469                                 <dt class="heading">Parameters:</dt>
 470
 471                                         <dt>
 472                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span>  <b>panel</b>
 473
 474                                         </dt>
 475                                         <dd>The panels index, id or the panel itself</dd>
 476
 477                                 </dl>
 478
 479
 480
 481
 482
 483                                 <dl class="detailList">
 484                                 <dt class="heading">Returns:</dt>
 485
 486                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  </dd>
 487
 488                                 </dl>
 489
 490
 491
 492
 493
 494
 495
 496                     </div>
 497                 </div>
 498
 499             </td>
 500             <td class="msource">
 501
 502                         Roo.BasicLayoutRegion
 503                 &nbsp;
 504             </td>
 505         </tr>
 506
 507
 508           <tr class="method-row config-row-alt1 expandable notInherited">
 509             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 510
 511
 512             <td class="sig">
 513                 <a id="Roo.BasicLayoutRegion-method-getPosition"   name=".getPosition"></a>
 514                 <div class="fixedFont">
 515                         <span class="attributes"></span><b class="itemname">getPosition</b>
 516
 517                                  ()
 518
 519
 520                                          :
 521
 522
 523                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 524
 525
 526
 527
 528
 529                 </div>
 530                 <div class="mdesc">
 531
 532                    <div class="short">Returns this regions position (north/south/east/west/center).</div>
 533
 534
 535
 536                     <div class="long">
 537
 538                                 Returns this regions position (north/south/east/west/center).
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549                                 <dl class="detailList">
 550                                 <dt class="heading">Returns:</dt>
 551
 552                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
 553
 554                                 </dl>
 555
 556
 557
 558
 559
 560
 561
 562                     </div>
 563                 </div>
 564
 565             </td>
 566             <td class="msource">
 567
 568                         Roo.BasicLayoutRegion
 569                 &nbsp;
 570             </td>
 571         </tr>
 572
 573
 574           <tr class="method-row config-row-alt0 expandable notInherited">
 575             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 576
 577
 578             <td class="sig">
 579                 <a id="Roo.BasicLayoutRegion-method-hasPanel"   name=".hasPanel"></a>
 580                 <div class="fixedFont">
 581                         <span class="attributes"></span><b class="itemname">hasPanel</b>
 582
 583                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
 584
 585
 586                                          :
 587
 588
 589                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 590
 591
 592
 593
 594
 595                 </div>
 596                 <div class="mdesc">
 597
 598                    <div class="short">Returns true if the panel is in this region.</div>
 599
 600
 601
 602                     <div class="long">
 603
 604                                 Returns true if the panel is in this region.
 605
 606
 607
 608
 609
 610
 611                                 <dl class="detailList">
 612                                 <dt class="heading">Parameters:</dt>
 613
 614                                         <dt>
 615                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span>  <b>panel</b>
 616
 617                                         </dt>
 618                                         <dd>The panels index, id or the panel itself</dd>
 619
 620                                 </dl>
 621
 622
 623
 624
 625
 626                                 <dl class="detailList">
 627                                 <dt class="heading">Returns:</dt>
 628
 629                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 630
 631                                 </dl>
 632
 633
 634
 635
 636
 637
 638
 639                     </div>
 640                 </div>
 641
 642             </td>
 643             <td class="msource">
 644
 645                         Roo.BasicLayoutRegion
 646                 &nbsp;
 647             </td>
 648         </tr>
 649
 650
 651           <tr class="method-row config-row-alt1 expandable notInherited">
 652             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 653
 654
 655             <td class="sig">
 656                 <a id="Roo.BasicLayoutRegion-method-isVisible"   name=".isVisible"></a>
 657                 <div class="fixedFont">
 658                         <span class="attributes"></span><b class="itemname">isVisible</b>
 659
 660                                  ()
 661
 662
 663                                          :
 664
 665
 666                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 667
 668
 669
 670
 671
 672                 </div>
 673                 <div class="mdesc">
 674
 675                    <div class="short">Returns true if this region is currently visible.</div>
 676
 677
 678
 679                     <div class="long">
 680
 681                                 Returns true if this region is currently visible.
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692                                 <dl class="detailList">
 693                                 <dt class="heading">Returns:</dt>
 694
 695                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 696
 697                                 </dl>
 698
 699
 700
 701
 702
 703
 704
 705                     </div>
 706                 </div>
 707
 708             </td>
 709             <td class="msource">
 710
 711                         Roo.BasicLayoutRegion
 712                 &nbsp;
 713             </td>
 714         </tr>
 715
 716
 717           <tr class="method-row config-row-alt0 expandable notInherited">
 718             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 719
 720
 721             <td class="sig">
 722                 <a id="Roo.BasicLayoutRegion-method-remove"   name=".remove"></a>
 723                 <div class="fixedFont">
 724                         <span class="attributes"></span><b class="itemname">remove</b>
 725
 726                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preservePanel</i></B>)
 727
 728
 729                                          :
 730
 731
 732                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 733
 734
 735
 736
 737
 738                 </div>
 739                 <div class="mdesc">
 740
 741                    <div class="short">Removes the specified panel.</div>
 742
 743
 744
 745                     <div class="long">
 746
 747                                 Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
 748
 749
 750
 751
 752
 753
 754                                 <dl class="detailList">
 755                                 <dt class="heading">Parameters:</dt>
 756
 757                                         <dt>
 758                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span>  <b>panel</b>
 759
 760                                         </dt>
 761                                         <dd>The panels index, id or the panel itself</dd>
 762
 763                                         <dt>
 764                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>preservePanel</b>
 765
 766                                         </dt>
 767                                         <dd>Overrides the config preservePanel option</dd>
 768
 769                                 </dl>
 770
 771
 772
 773
 774
 775                                 <dl class="detailList">
 776                                 <dt class="heading">Returns:</dt>
 777
 778                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The panel that was removed</dd>
 779
 780                                 </dl>
 781
 782
 783
 784
 785
 786
 787
 788                     </div>
 789                 </div>
 790
 791             </td>
 792             <td class="msource">
 793
 794                         Roo.BasicLayoutRegion
 795                 &nbsp;
 796             </td>
 797         </tr>
 798
 799
 800           <tr class="method-row config-row-alt1 expandable notInherited">
 801             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 802
 803
 804             <td class="sig">
 805                 <a id="Roo.BasicLayoutRegion-method-resizeTo"   name=".resizeTo"></a>
 806                 <div class="fixedFont">
 807                         <span class="attributes"></span><b class="itemname">resizeTo</b>
 808
 809                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
 810
 811
 812
 813                 </div>
 814                 <div class="mdesc">
 815
 816                    <div class="short">Resizes the region to the specified size.</div>
 817
 818
 819
 820                     <div class="long">
 821
 822                                 Resizes the region to the specified size. For vertical regions (west, east) this adjusts <br/>the width, for horizontal (north, south) the height.
 823
 824
 825
 826
 827
 828
 829                                 <dl class="detailList">
 830                                 <dt class="heading">Parameters:</dt>
 831
 832                                         <dt>
 833                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>newSize</b>
 834
 835                                         </dt>
 836                                         <dd>The new width or height</dd>
 837
 838                                 </dl>
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850                     </div>
 851                 </div>
 852
 853             </td>
 854             <td class="msource">
 855
 856                         Roo.BasicLayoutRegion
 857                 &nbsp;
 858             </td>
 859         </tr>
 860
 861
 862           <tr class="method-row config-row-alt0 expandable notInherited">
 863             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 864
 865
 866             <td class="sig">
 867                 <a id="Roo.BasicLayoutRegion-method-showPanel"   name=".showPanel"></a>
 868                 <div class="fixedFont">
 869                         <span class="attributes"></span><b class="itemname">showPanel</b>
 870
 871                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panelId</i></B>)
 872
 873
 874                                          :
 875
 876
 877                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 878
 879
 880
 881
 882
 883                 </div>
 884                 <div class="mdesc">
 885
 886                    <div class="short">Show the specified panel.</div>
 887
 888
 889
 890                     <div class="long">
 891
 892                                 Show the specified panel.
 893
 894
 895
 896
 897
 898
 899                                 <dl class="detailList">
 900                                 <dt class="heading">Parameters:</dt>
 901
 902                                         <dt>
 903                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span>  <b>panelId</b>
 904
 905                                         </dt>
 906                                         <dd>The panels index, id or the panel itself</dd>
 907
 908                                 </dl>
 909
 910
 911
 912
 913
 914                                 <dl class="detailList">
 915                                 <dt class="heading">Returns:</dt>
 916
 917                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The shown panel or null</dd>
 918
 919                                 </dl>
 920
 921
 922
 923
 924
 925
 926
 927                     </div>
 928                 </div>
 929
 930             </td>
 931             <td class="msource">
 932
 933                         Roo.BasicLayoutRegion
 934                 &nbsp;
 935             </td>
 936         </tr>
 937
 938
 939     </table>
 940
 941
 942   <!-- ============================== events summary / details ======================== -->
 943
 944
 945   <a id="Roo.BasicLayoutRegion-events"></a>
 946
 947
 948
 949
 950
 951
 952
 953
 954       <table cellspacing="0" class="member-table">
 955                 <caption>Events</caption>
 956               <thead>
 957                 <tr>
 958                     <th class="sig-header" colspan="2">Event</th>
 959                     <th class="msource-header">Defined By</th>
 960
 961                 </tr>
 962               </thead>
 963
 964
 965
 966
 967
 968           <tr class="method-row expandable config-row-alt0 notInherited">
 969             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 970
 971             <td class="sig">
 972                 <a id="Roo.BasicLayoutRegion-event-*beforeremove"></a>
 973
 974                <div class="fixedFont">
 975                 <b class="itemname">beforeremove</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
 976
 977                 </div>
 978
 979                 <div class="mdesc">
 980
 981                    <div class="short">Fires before a panel is removed (or closed).
 982
 983                 </div>
 984
 985                     <div class="long">
 986
 987                         Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
 988
 989
 990
 991
 992
 993                                 <dl class="detailList">
 994                                 <dt class="heading">Parameters:</dt>
 995
 996                                         <dt>
 997                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
 998
 999                                         </dt>
1000                                         <dd></dd>
1001
1002                                         <dt>
1003                                                 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1004
1005                                         </dt>
1006                                         <dd>The panel</dd>
1007
1008                                         <dt>
1009                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
1010
1011                                         </dt>
1012                                         <dd>The cancel event object</dd>
1013
1014                                 </dl>
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026                     </div>
1027                 </div>
1028
1029             </td>
1030             <td class="msource">
1031                 Roo.BasicLayoutRegion
1032             </td>
1033         </tr>
1034
1035           <tr class="method-row expandable config-row-alt1 notInherited">
1036             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1037
1038             <td class="sig">
1039                 <a id="Roo.BasicLayoutRegion-event-*collapsed"></a>
1040
1041                <div class="fixedFont">
1042                 <b class="itemname">collapsed</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1043
1044                 </div>
1045
1046                 <div class="mdesc">
1047
1048                    <div class="short">Fires when this region is collapsed.
1049
1050                 </div>
1051
1052                     <div class="long">
1053
1054                         Fires when this region is collapsed.
1055
1056
1057
1058
1059
1060                                 <dl class="detailList">
1061                                 <dt class="heading">Parameters:</dt>
1062
1063                                         <dt>
1064                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1065
1066                                         </dt>
1067                                         <dd></dd>
1068
1069                                 </dl>
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081                     </div>
1082                 </div>
1083
1084             </td>
1085             <td class="msource">
1086                 Roo.BasicLayoutRegion
1087             </td>
1088         </tr>
1089
1090           <tr class="method-row expandable config-row-alt0 notInherited">
1091             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1092
1093             <td class="sig">
1094                 <a id="Roo.BasicLayoutRegion-event-*expanded"></a>
1095
1096                <div class="fixedFont">
1097                 <b class="itemname">expanded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1098
1099                 </div>
1100
1101                 <div class="mdesc">
1102
1103                    <div class="short">Fires when this region is expanded.
1104
1105                 </div>
1106
1107                     <div class="long">
1108
1109                         Fires when this region is expanded.
1110
1111
1112
1113
1114
1115                                 <dl class="detailList">
1116                                 <dt class="heading">Parameters:</dt>
1117
1118                                         <dt>
1119                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1120
1121                                         </dt>
1122                                         <dd></dd>
1123
1124                                 </dl>
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136                     </div>
1137                 </div>
1138
1139             </td>
1140             <td class="msource">
1141                 Roo.BasicLayoutRegion
1142             </td>
1143         </tr>
1144
1145           <tr class="method-row expandable config-row-alt1 notInherited">
1146             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1147
1148             <td class="sig">
1149                 <a id="Roo.BasicLayoutRegion-event-*invalidated"></a>
1150
1151                <div class="fixedFont">
1152                 <b class="itemname">invalidated</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1153
1154                 </div>
1155
1156                 <div class="mdesc">
1157
1158                    <div class="short">Fires when the layout for this region is changed.
1159
1160                 </div>
1161
1162                     <div class="long">
1163
1164                         Fires when the layout for this region is changed.
1165
1166
1167
1168
1169
1170                                 <dl class="detailList">
1171                                 <dt class="heading">Parameters:</dt>
1172
1173                                         <dt>
1174                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1175
1176                                         </dt>
1177                                         <dd></dd>
1178
1179                                 </dl>
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191                     </div>
1192                 </div>
1193
1194             </td>
1195             <td class="msource">
1196                 Roo.BasicLayoutRegion
1197             </td>
1198         </tr>
1199
1200           <tr class="method-row expandable config-row-alt0 notInherited">
1201             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1202
1203             <td class="sig">
1204                 <a id="Roo.BasicLayoutRegion-event-*panelactivated"></a>
1205
1206                <div class="fixedFont">
1207                 <b class="itemname">panelactivated</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
1208
1209                 </div>
1210
1211                 <div class="mdesc">
1212
1213                    <div class="short">Fires when a panel is activated.
1214
1215                 </div>
1216
1217                     <div class="long">
1218
1219                         Fires when a panel is activated.
1220
1221
1222
1223
1224
1225                                 <dl class="detailList">
1226                                 <dt class="heading">Parameters:</dt>
1227
1228                                         <dt>
1229                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1230
1231                                         </dt>
1232                                         <dd></dd>
1233
1234                                         <dt>
1235                                                 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1236
1237                                         </dt>
1238                                         <dd>The activated panel</dd>
1239
1240                                 </dl>
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252                     </div>
1253                 </div>
1254
1255             </td>
1256             <td class="msource">
1257                 Roo.BasicLayoutRegion
1258             </td>
1259         </tr>
1260
1261           <tr class="method-row expandable config-row-alt1 notInherited">
1262             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1263
1264             <td class="sig">
1265                 <a id="Roo.BasicLayoutRegion-event-*paneladded"></a>
1266
1267                <div class="fixedFont">
1268                 <b class="itemname">paneladded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
1269
1270                 </div>
1271
1272                 <div class="mdesc">
1273
1274                    <div class="short">Fires when a panel is added.
1275
1276                 </div>
1277
1278                     <div class="long">
1279
1280                         Fires when a panel is added.
1281
1282
1283
1284
1285
1286                                 <dl class="detailList">
1287                                 <dt class="heading">Parameters:</dt>
1288
1289                                         <dt>
1290                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1291
1292                                         </dt>
1293                                         <dd></dd>
1294
1295                                         <dt>
1296                                                 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1297
1298                                         </dt>
1299                                         <dd>The panel</dd>
1300
1301                                 </dl>
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313                     </div>
1314                 </div>
1315
1316             </td>
1317             <td class="msource">
1318                 Roo.BasicLayoutRegion
1319             </td>
1320         </tr>
1321
1322           <tr class="method-row expandable config-row-alt0 notInherited">
1323             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1324
1325             <td class="sig">
1326                 <a id="Roo.BasicLayoutRegion-event-*panelremoved"></a>
1327
1328                <div class="fixedFont">
1329                 <b class="itemname">panelremoved</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
1330
1331                 </div>
1332
1333                 <div class="mdesc">
1334
1335                    <div class="short">Fires when a panel is removed.
1336
1337                 </div>
1338
1339                     <div class="long">
1340
1341                         Fires when a panel is removed.
1342
1343
1344
1345
1346
1347                                 <dl class="detailList">
1348                                 <dt class="heading">Parameters:</dt>
1349
1350                                         <dt>
1351                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1352
1353                                         </dt>
1354                                         <dd></dd>
1355
1356                                         <dt>
1357                                                 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1358
1359                                         </dt>
1360                                         <dd>The panel</dd>
1361
1362                                 </dl>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374                     </div>
1375                 </div>
1376
1377             </td>
1378             <td class="msource">
1379                 Roo.BasicLayoutRegion
1380             </td>
1381         </tr>
1382
1383           <tr class="method-row expandable config-row-alt1 notInherited">
1384             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1385
1386             <td class="sig">
1387                 <a id="Roo.BasicLayoutRegion-event-*resized"></a>
1388
1389                <div class="fixedFont">
1390                 <b class="itemname">resized</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
1391
1392                 </div>
1393
1394                 <div class="mdesc">
1395
1396                    <div class="short">Fires when the user resizes this region.
1397
1398                 </div>
1399
1400                     <div class="long">
1401
1402                         Fires when the user resizes this region.
1403
1404
1405
1406
1407
1408                                 <dl class="detailList">
1409                                 <dt class="heading">Parameters:</dt>
1410
1411                                         <dt>
1412                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1413
1414                                         </dt>
1415                                         <dd></dd>
1416
1417                                         <dt>
1418                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
1419
1420                                         </dt>
1421                                         <dd>The new size (width for east/west, height for north/south)</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.BasicLayoutRegion
1441             </td>
1442         </tr>
1443
1444           <tr class="method-row expandable config-row-alt0 notInherited">
1445             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1446
1447             <td class="sig">
1448                 <a id="Roo.BasicLayoutRegion-event-*slidehide"></a>
1449
1450                <div class="fixedFont">
1451                 <b class="itemname">slidehide</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1452
1453                 </div>
1454
1455                 <div class="mdesc">
1456
1457                    <div class="short">Fires when this region slides out of view.
1458
1459                 </div>
1460
1461                     <div class="long">
1462
1463                         Fires when this region slides out of view.
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.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</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.BasicLayoutRegion
1496             </td>
1497         </tr>
1498
1499           <tr class="method-row expandable config-row-alt1 notInherited">
1500             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1501
1502             <td class="sig">
1503                 <a id="Roo.BasicLayoutRegion-event-*slideshow"></a>
1504
1505                <div class="fixedFont">
1506                 <b class="itemname">slideshow</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1507
1508                 </div>
1509
1510                 <div class="mdesc">
1511
1512                    <div class="short">Fires when this region is slid into view.
1513
1514                 </div>
1515
1516                     <div class="long">
1517
1518                         Fires when this region is slid into view.
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.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</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.BasicLayoutRegion
1551             </td>
1552         </tr>
1553
1554           <tr class="method-row expandable config-row-alt0 notInherited">
1555             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1556
1557             <td class="sig">
1558                 <a id="Roo.BasicLayoutRegion-event-*visibilitychange"></a>
1559
1560                <div class="fixedFont">
1561                 <b class="itemname">visibilitychange</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visibility</i></B>)
1562
1563                 </div>
1564
1565                 <div class="mdesc">
1566
1567                    <div class="short">Fires when this region is shown or hidden
1568
1569                 </div>
1570
1571                     <div class="long">
1572
1573                         Fires when this region is shown or 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.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1584
1585                                         </dt>
1586                                         <dd></dd>
1587
1588                                         <dt>
1589                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visibility</b>
1590
1591                                         </dt>
1592                                         <dd>true or false</dd>
1593
1594                                 </dl>
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606                     </div>
1607                 </div>
1608
1609             </td>
1610             <td class="msource">
1611                 Roo.BasicLayoutRegion
1612             </td>
1613         </tr>
1614
1615
1616     </table>
1617
1618
1619
1620
1621
1622 <!-- ============================== footer ================================= -->
1623                 <div class="fineprint" style="clear:both">
1624
1625                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:37:00 GMT+0800 (HKT)
1626                         Based on
1627                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1628                 </div>
1629         </body>
1630 </html>