git.roojs.org Git - roojs1/blob - docs/symbols/Roo.LayoutManager.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.LayoutManager</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.LayoutManager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.LayoutManager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.LayoutManager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.LayoutManager-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.LayoutManager
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.LayoutManager
  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_LayoutManager.js.html">Roo/LayoutManager.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">LayoutManager</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 layout managers.
  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.LayoutManager';">[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.LayoutManager.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.LayoutManager-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.LayoutManager-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.LayoutManager-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-LayoutManager"   name=".LayoutManager"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutManager</b>
 183
 184                                  ()
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.LayoutManager</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.LayoutManager
 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.LayoutManager-method-beginUpdate"   name=".beginUpdate"></a>
 228                 <div class="fixedFont">
 229                         <span class="attributes"></span><b class="itemname">beginUpdate</b>
 230
 231                                  ()
 232
 233
 234
 235                 </div>
 236                 <div class="mdesc">
 237
 238                    <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
 239
 240
 241
 242                     <div class="long">
 243
 244                                 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261                     </div>
 262                 </div>
 263
 264             </td>
 265             <td class="msource">
 266
 267                         Roo.LayoutManager
 268                 &nbsp;
 269             </td>
 270         </tr>
 271
 272
 273           <tr class="method-row config-row-alt0 expandable notInherited">
 274             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 275
 276
 277             <td class="sig">
 278                 <a id="Roo.LayoutManager-method-endUpdate"   name=".endUpdate"></a>
 279                 <div class="fixedFont">
 280                         <span class="attributes"></span><b class="itemname">endUpdate</b>
 281
 282                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
 283
 284
 285
 286                 </div>
 287                 <div class="mdesc">
 288
 289                    <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
 290
 291
 292
 293                     <div class="long">
 294
 295                                 Restore auto-layouts and optionally disable the manager from performing a layout
 296
 297
 298
 299
 300
 301
 302                                 <dl class="detailList">
 303                                 <dt class="heading">Parameters:</dt>
 304
 305                                         <dt>
 306                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>noLayout</b>
 307
 308                                         </dt>
 309                                         <dd>true to disable a layout update</dd>
 310
 311                                 </dl>
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323                     </div>
 324                 </div>
 325
 326             </td>
 327             <td class="msource">
 328
 329                         Roo.LayoutManager
 330                 &nbsp;
 331             </td>
 332         </tr>
 333
 334
 335           <tr class="method-row config-row-alt1 expandable notInherited">
 336             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 337
 338
 339             <td class="sig">
 340                 <a id="Roo.LayoutManager-method-getEl"   name=".getEl"></a>
 341                 <div class="fixedFont">
 342                         <span class="attributes"></span><b class="itemname">getEl</b>
 343
 344                                  ()
 345
 346
 347                                          :
 348
 349
 350                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 351
 352
 353
 354
 355
 356                 </div>
 357                 <div class="mdesc">
 358
 359                    <div class="short">Returns the Element this layout is bound to.</div>
 360
 361
 362
 363                     <div class="long">
 364
 365                                 Returns the Element this layout is bound to.
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376                                 <dl class="detailList">
 377                                 <dt class="heading">Returns:</dt>
 378
 379                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 380
 381                                 </dl>
 382
 383
 384
 385
 386
 387
 388
 389                     </div>
 390                 </div>
 391
 392             </td>
 393             <td class="msource">
 394
 395                         Roo.LayoutManager
 396                 &nbsp;
 397             </td>
 398         </tr>
 399
 400
 401           <tr class="method-row config-row-alt0 expandable notInherited">
 402             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 403
 404
 405             <td class="sig">
 406                 <a id="Roo.LayoutManager-method-getRegion"   name=".getRegion"></a>
 407                 <div class="fixedFont">
 408                         <span class="attributes"></span><b class="itemname">getRegion</b>
 409
 410                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
 411
 412
 413                                          :
 414
 415
 416                                                 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
 417
 418
 419
 420
 421
 422                 </div>
 423                 <div class="mdesc">
 424
 425                    <div class="short">Returns the specified region.</div>
 426
 427
 428
 429                     <div class="long">
 430
 431                                 Returns the specified region.
 432
 433
 434
 435
 436
 437
 438                                 <dl class="detailList">
 439                                 <dt class="heading">Parameters:</dt>
 440
 441                                         <dt>
 442                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 443
 444                                         </dt>
 445                                         <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
 446
 447                                 </dl>
 448
 449
 450
 451
 452
 453                                 <dl class="detailList">
 454                                 <dt class="heading">Returns:</dt>
 455
 456                                         <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span>  </dd>
 457
 458                                 </dl>
 459
 460
 461
 462
 463
 464
 465
 466                     </div>
 467                 </div>
 468
 469             </td>
 470             <td class="msource">
 471
 472                         Roo.LayoutManager
 473                 &nbsp;
 474             </td>
 475         </tr>
 476
 477
 478           <tr class="method-row config-row-alt1 expandable notInherited">
 479             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 480
 481
 482             <td class="sig">
 483                 <a id="Roo.LayoutManager-method-getViewSize"   name=".getViewSize"></a>
 484                 <div class="fixedFont">
 485                         <span class="attributes"></span><b class="itemname">getViewSize</b>
 486
 487                                  ()
 488
 489
 490                                          :
 491
 492
 493                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 494
 495
 496
 497
 498
 499                 </div>
 500                 <div class="mdesc">
 501
 502                    <div class="short">Returns the size of the current view.</div>
 503
 504
 505
 506                     <div class="long">
 507
 508                                 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519                                 <dl class="detailList">
 520                                 <dt class="heading">Returns:</dt>
 521
 522                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  The size as an object {width: (the width), height: (the height)}</dd>
 523
 524                                 </dl>
 525
 526
 527
 528
 529
 530
 531
 532                     </div>
 533                 </div>
 534
 535             </td>
 536             <td class="msource">
 537
 538                         Roo.LayoutManager
 539                 &nbsp;
 540             </td>
 541         </tr>
 542
 543
 544           <tr class="method-row config-row-alt0 expandable notInherited">
 545             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 546
 547
 548             <td class="sig">
 549                 <a id="Roo.LayoutManager-method-isUpdating"   name=".isUpdating"></a>
 550                 <div class="fixedFont">
 551                         <span class="attributes"></span><b class="itemname">isUpdating</b>
 552
 553                                  ()
 554
 555
 556                                          :
 557
 558
 559                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 560
 561
 562
 563
 564
 565                 </div>
 566                 <div class="mdesc">
 567
 568                    <div class="short">Returns true if this layout is currently being updated</div>
 569
 570
 571
 572                     <div class="long">
 573
 574                                 Returns true if this layout is currently being updated
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585                                 <dl class="detailList">
 586                                 <dt class="heading">Returns:</dt>
 587
 588                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 589
 590                                 </dl>
 591
 592
 593
 594
 595
 596
 597
 598                     </div>
 599                 </div>
 600
 601             </td>
 602             <td class="msource">
 603
 604                         Roo.LayoutManager
 605                 &nbsp;
 606             </td>
 607         </tr>
 608
 609
 610     </table>
 611
 612
 613   <!-- ============================== events summary / details ======================== -->
 614
 615
 616   <a id="Roo.LayoutManager-events"></a>
 617
 618
 619
 620
 621
 622
 623
 624
 625       <table cellspacing="0" class="member-table">
 626                 <caption>Events</caption>
 627               <thead>
 628                 <tr>
 629                     <th class="sig-header" colspan="2">Event</th>
 630                     <th class="msource-header">Defined By</th>
 631
 632                 </tr>
 633               </thead>
 634
 635
 636
 637
 638
 639           <tr class="method-row expandable config-row-alt0 notInherited">
 640             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 641
 642             <td class="sig">
 643                 <a id="Roo.LayoutManager-event-*layout"></a>
 644
 645                <div class="fixedFont">
 646                 <b class="itemname">layout</b> (<a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a> <B><i>this</i></B>)
 647
 648                 </div>
 649
 650                 <div class="mdesc">
 651
 652                    <div class="short">Fires when a layout is performed.
 653
 654                 </div>
 655
 656                     <div class="long">
 657
 658                         Fires when a layout is performed.
 659
 660
 661
 662
 663
 664                                 <dl class="detailList">
 665                                 <dt class="heading">Parameters:</dt>
 666
 667                                         <dt>
 668                                                 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
 669
 670                                         </dt>
 671                                         <dd></dd>
 672
 673                                 </dl>
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685                     </div>
 686                 </div>
 687
 688             </td>
 689             <td class="msource">
 690                 Roo.LayoutManager
 691             </td>
 692         </tr>
 693
 694           <tr class="method-row expandable config-row-alt1 notInherited">
 695             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 696
 697             <td class="sig">
 698                 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
 699
 700                <div class="fixedFont">
 701                 <b class="itemname">regioncollapsed</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>)
 702
 703                 </div>
 704
 705                 <div class="mdesc">
 706
 707                    <div class="short">Fires when a region is collapsed.
 708
 709                 </div>
 710
 711                     <div class="long">
 712
 713                         Fires when a region is collapsed.
 714
 715
 716
 717
 718
 719                                 <dl class="detailList">
 720                                 <dt class="heading">Parameters:</dt>
 721
 722                                         <dt>
 723                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
 724
 725                                         </dt>
 726                                         <dd>The collapsed region</dd>
 727
 728                                 </dl>
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740                     </div>
 741                 </div>
 742
 743             </td>
 744             <td class="msource">
 745                 Roo.LayoutManager
 746             </td>
 747         </tr>
 748
 749           <tr class="method-row expandable config-row-alt0 notInherited">
 750             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 751
 752             <td class="sig">
 753                 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
 754
 755                <div class="fixedFont">
 756                 <b class="itemname">regionexpanded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>)
 757
 758                 </div>
 759
 760                 <div class="mdesc">
 761
 762                    <div class="short">Fires when a region is expanded.
 763
 764                 </div>
 765
 766                     <div class="long">
 767
 768                         Fires when a region is expanded.
 769
 770
 771
 772
 773
 774                                 <dl class="detailList">
 775                                 <dt class="heading">Parameters:</dt>
 776
 777                                         <dt>
 778                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
 779
 780                                         </dt>
 781                                         <dd>The expanded region</dd>
 782
 783                                 </dl>
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795                     </div>
 796                 </div>
 797
 798             </td>
 799             <td class="msource">
 800                 Roo.LayoutManager
 801             </td>
 802         </tr>
 803
 804           <tr class="method-row expandable config-row-alt1 notInherited">
 805             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 806
 807             <td class="sig">
 808                 <a id="Roo.LayoutManager-event-*regionresized"></a>
 809
 810                <div class="fixedFont">
 811                 <b class="itemname">regionresized</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
 812
 813                 </div>
 814
 815                 <div class="mdesc">
 816
 817                    <div class="short">Fires when the user resizes a region.
 818
 819                 </div>
 820
 821                     <div class="long">
 822
 823                         Fires when the user resizes a region.
 824
 825
 826
 827
 828
 829                                 <dl class="detailList">
 830                                 <dt class="heading">Parameters:</dt>
 831
 832                                         <dt>
 833                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
 834
 835                                         </dt>
 836                                         <dd>The resized region</dd>
 837
 838                                         <dt>
 839                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
 840
 841                                         </dt>
 842                                         <dd>The new size (width for east/west, height for north/south)</dd>
 843
 844                                 </dl>
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856                     </div>
 857                 </div>
 858
 859             </td>
 860             <td class="msource">
 861                 Roo.LayoutManager
 862             </td>
 863         </tr>
 864
 865
 866     </table>
 867
 868
 869
 870
 871
 872 <!-- ============================== footer ================================= -->
 873                 <div class="fineprint" style="clear:both">
 874
 875                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:46 GMT+0800 (HKT)
 876                         Based on
 877                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 878                 </div>
 879         </body>
 880 </html>