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         <tr><td class="label">Subclasses:</td><td class="hd-info">
  73                 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>, <a href="./Roo.ReaderLayout.html#constructor" roo:cls="Roo.ReaderLayout.html#constructor">Roo.ReaderLayout</a>
  74
  75
  76
  77         </td></tr>
  78
  79
  80
  81                 <tr><td class="label">Extends:</td><td class="hd-info">
  82                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  83
  84                 </td></tr>
  85
  86
  87     </table>
  88
  89
  90 <!-- ============================== class summary ========================== -->
  91     <div class="description">
  92         Base class for layout managers.
  93     </div>
  94
  95
  96 <!-- ============================== Class comment block... ========================== -->
  97
  98 <div class="comments">
  99         <b>Class Comments / Notes</B> =>
 100         <u onclick="parent.CommentDialog.showCommentId = 'Roo.LayoutManager';">[Add Your comment/notes about this class]</u>
 101         <br/>
 102         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
 103                 src="/blog.php/GtkDjsComments/Roo.LayoutManager.html"></iframe>
 104 </div>
 105
 106
 107
 108 <!-- ============================== config options ========================== -->
 109
 110
 111
 112
 113     <div class="hr"></div>
 114     <a id="Roo.LayoutManager-configs"></a>
 115
 116
 117
 118
 119
 120       <table cellspacing="0" class="member-table">
 121       <caption>Config Options (Usually are also Properties)</caption>
 122
 123
 124         <tr>
 125             <th class="sig-header" colspan="2">Options</th>
 126
 127             <th class="msource-header">Defined By</th>
 128         </tr>
 129
 130
 131
 132
 133
 134                 <tr class="config-row expandable config-row-alt0">
 135                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 136                     <td class="sig">
 137
 138                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 139                         <div class="fixedFont">
 140                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 141
 142
 143                         </div>
 144
 145                         <div class="mdesc">
 146                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 147                         </div>
 148
 149                         <div class="mdesc">
 150                             <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre></div>
 151                         </div>
 152
 153
 154
 155                     </td>
 156                     <td class="msource">
 157
 158                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 159
 160                     </td>
 161                 </tr>
 162
 163
 164     </table>
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174   <!-- ============================== public properties ==================== -->
 175
 176
 177
 178     <a id="Roo.LayoutManager-props"></a>
 179
 180
 181
 182
 183
 184      <table cellspacing="0" class="member-table">
 185       <caption class="Empty">Public Properties - Has None</caption>
 186      </table>
 187
 188
 189
 190
 191   <!-- ============================== methods summary / details ======================== -->
 192
 193
 194   <a id="Roo.LayoutManager-methods"></a>
 195         <!-- constructor?? -->
 196
 197         <!-- static's first
 198
 199
 200         -->
 201
 202         <!-- then dynamics first -->
 203
 204
 205
 206
 207
 208
 209       <table cellspacing="0" class="member-table">
 210       <caption>Public Methods</caption>
 211         <tr>
 212             <th class="sig-header" colspan="2">Method</th>
 213             <th class="msource-header">Defined By</th>
 214
 215         </tr>
 216
 217
 218
 219
 220
 221
 222
 223           <tr class="method-row config-row-alt0 notInherited">
 224             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 225
 226
 227             <td class="sig">
 228                 <a id="Roo-method-LayoutManager"   name=".LayoutManager"></a>
 229                 <div class="fixedFont">
 230                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutManager</b>
 231
 232                                  ()
 233
 234
 235
 236                 </div>
 237                 <div class="mdesc">
 238
 239
 240                         <div class="short">Create a new Roo.LayoutManager</div>
 241
 242
 243                     <div class="long">
 244
 245
 246
 247                                 Create a new Roo.LayoutManager
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260                     </div>
 261                 </div>
 262
 263             </td>
 264             <td class="msource">
 265                 &nbsp;
 266             </td>
 267         </tr>
 268
 269
 270           <tr class="method-row config-row-alt1 expandable">
 271             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 272
 273
 274             <td class="sig">
 275                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 276                 <div class="fixedFont">
 277                         <span class="attributes"></span><b class="itemname">addEvents</b>
 278
 279                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 280
 281
 282
 283                 </div>
 284                 <div class="mdesc">
 285
 286                    <div class="short">Used to define events on this Observable</div>
 287
 288
 289
 290                     <div class="long">
 291
 292                                 Used to define events on this Observable
 293
 294
 295
 296
 297
 298
 299                                 <dl class="detailList">
 300                                 <dt class="heading">Parameters:</dt>
 301
 302                                         <dt>
 303                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 304
 305                                         </dt>
 306                                         <dd>The object with the events defined</dd>
 307
 308                                 </dl>
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320                     </div>
 321                 </div>
 322
 323             </td>
 324             <td class="msource">
 325
 326                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 327                 &nbsp;
 328             </td>
 329         </tr>
 330
 331
 332           <tr class="method-row config-row-alt0 expandable">
 333             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 334
 335
 336             <td class="sig">
 337                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 338                 <div class="fixedFont">
 339                         <span class="attributes"></span><b class="itemname">addListener</b>
 340
 341                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 342
 343
 344
 345                 </div>
 346                 <div class="mdesc">
 347
 348                    <div class="short">Appends an event handler to this component</div>
 349
 350
 351
 352                     <div class="long">
 353
 354                                 Appends an event handler to this component
 355
 356
 357
 358
 359
 360
 361                                 <dl class="detailList">
 362                                 <dt class="heading">Parameters:</dt>
 363
 364                                         <dt>
 365                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 366
 367                                         </dt>
 368                                         <dd>The type of event to listen for</dd>
 369
 370                                         <dt>
 371                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 372
 373                                         </dt>
 374                                         <dd>The method the event invokes</dd>
 375
 376                                         <dt>
 377                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 378
 379                                         </dt>
 380                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 381
 382                                         <dt>
 383                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 384
 385                                         </dt>
 386                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 387
 388                                 </dl>
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400                     </div>
 401                 </div>
 402
 403             </td>
 404             <td class="msource">
 405
 406                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 407                 &nbsp;
 408             </td>
 409         </tr>
 410
 411
 412           <tr class="method-row config-row-alt1 expandable notInherited">
 413             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 414
 415
 416             <td class="sig">
 417                 <a id="Roo.LayoutManager-method-beginUpdate"   name=".beginUpdate"></a>
 418                 <div class="fixedFont">
 419                         <span class="attributes"></span><b class="itemname">beginUpdate</b>
 420
 421                                  ()
 422
 423
 424
 425                 </div>
 426                 <div class="mdesc">
 427
 428                    <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
 429
 430
 431
 432                     <div class="long">
 433
 434                                 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451                     </div>
 452                 </div>
 453
 454             </td>
 455             <td class="msource">
 456
 457                         Roo.LayoutManager
 458                 &nbsp;
 459             </td>
 460         </tr>
 461
 462
 463           <tr class="method-row config-row-alt0 expandable notInherited">
 464             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 465
 466
 467             <td class="sig">
 468                 <a id="Roo.LayoutManager-method-endUpdate"   name=".endUpdate"></a>
 469                 <div class="fixedFont">
 470                         <span class="attributes"></span><b class="itemname">endUpdate</b>
 471
 472                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
 473
 474
 475
 476                 </div>
 477                 <div class="mdesc">
 478
 479                    <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
 480
 481
 482
 483                     <div class="long">
 484
 485                                 Restore auto-layouts and optionally disable the manager from performing a layout
 486
 487
 488
 489
 490
 491
 492                                 <dl class="detailList">
 493                                 <dt class="heading">Parameters:</dt>
 494
 495                                         <dt>
 496                                                 <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>
 497
 498                                         </dt>
 499                                         <dd>true to disable a layout update</dd>
 500
 501                                 </dl>
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513                     </div>
 514                 </div>
 515
 516             </td>
 517             <td class="msource">
 518
 519                         Roo.LayoutManager
 520                 &nbsp;
 521             </td>
 522         </tr>
 523
 524
 525           <tr class="method-row config-row-alt1 expandable">
 526             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 527
 528
 529             <td class="sig">
 530                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 531                 <div class="fixedFont">
 532                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 533
 534                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
 535
 536
 537                                          :
 538
 539
 540                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 541
 542
 543
 544
 545
 546                 </div>
 547                 <div class="mdesc">
 548
 549                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 550
 551
 552
 553                     <div class="long">
 554
 555                                 Fires the specified event with the passed parameters (minus the event name).
 556
 557
 558
 559
 560
 561
 562                                 <dl class="detailList">
 563                                 <dt class="heading">Parameters:</dt>
 564
 565                                         <dt>
 566                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 567
 568                                         </dt>
 569                                         <dd></dd>
 570
 571                                         <dt>
 572                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 573
 574                                         </dt>
 575                                         <dd>Variable number of parameters are passed to handlers</dd>
 576
 577                                 </dl>
 578
 579
 580
 581
 582
 583                                 <dl class="detailList">
 584                                 <dt class="heading">Returns:</dt>
 585
 586                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
 587
 588                                 </dl>
 589
 590
 591
 592
 593
 594
 595
 596                     </div>
 597                 </div>
 598
 599             </td>
 600             <td class="msource">
 601
 602                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 603                 &nbsp;
 604             </td>
 605         </tr>
 606
 607
 608           <tr class="method-row config-row-alt0 expandable notInherited">
 609             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 610
 611
 612             <td class="sig">
 613                 <a id="Roo.LayoutManager-method-getEl"   name=".getEl"></a>
 614                 <div class="fixedFont">
 615                         <span class="attributes"></span><b class="itemname">getEl</b>
 616
 617                                  ()
 618
 619
 620                                          :
 621
 622
 623                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 624
 625
 626
 627
 628
 629                 </div>
 630                 <div class="mdesc">
 631
 632                    <div class="short">Returns the Element this layout is bound to.</div>
 633
 634
 635
 636                     <div class="long">
 637
 638                                 Returns the Element this layout is bound to.
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649                                 <dl class="detailList">
 650                                 <dt class="heading">Returns:</dt>
 651
 652                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 653
 654                                 </dl>
 655
 656
 657
 658
 659
 660
 661
 662                     </div>
 663                 </div>
 664
 665             </td>
 666             <td class="msource">
 667
 668                         Roo.LayoutManager
 669                 &nbsp;
 670             </td>
 671         </tr>
 672
 673
 674           <tr class="method-row config-row-alt1 expandable notInherited">
 675             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 676
 677
 678             <td class="sig">
 679                 <a id="Roo.LayoutManager-method-getRegion"   name=".getRegion"></a>
 680                 <div class="fixedFont">
 681                         <span class="attributes"></span><b class="itemname">getRegion</b>
 682
 683                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
 684
 685
 686                                          :
 687
 688
 689                                                 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
 690
 691
 692
 693
 694
 695                 </div>
 696                 <div class="mdesc">
 697
 698                    <div class="short">Returns the specified region.</div>
 699
 700
 701
 702                     <div class="long">
 703
 704                                 Returns the specified region.
 705
 706
 707
 708
 709
 710
 711                                 <dl class="detailList">
 712                                 <dt class="heading">Parameters:</dt>
 713
 714                                         <dt>
 715                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 716
 717                                         </dt>
 718                                         <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
 719
 720                                 </dl>
 721
 722
 723
 724
 725
 726                                 <dl class="detailList">
 727                                 <dt class="heading">Returns:</dt>
 728
 729                                         <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span>  </dd>
 730
 731                                 </dl>
 732
 733
 734
 735
 736
 737
 738
 739                     </div>
 740                 </div>
 741
 742             </td>
 743             <td class="msource">
 744
 745                         Roo.LayoutManager
 746                 &nbsp;
 747             </td>
 748         </tr>
 749
 750
 751           <tr class="method-row config-row-alt0 expandable notInherited">
 752             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 753
 754
 755             <td class="sig">
 756                 <a id="Roo.LayoutManager-method-getViewSize"   name=".getViewSize"></a>
 757                 <div class="fixedFont">
 758                         <span class="attributes"></span><b class="itemname">getViewSize</b>
 759
 760                                  ()
 761
 762
 763                                          :
 764
 765
 766                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 767
 768
 769
 770
 771
 772                 </div>
 773                 <div class="mdesc">
 774
 775                    <div class="short">Returns the size of the current view.</div>
 776
 777
 778
 779                     <div class="long">
 780
 781                                 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792                                 <dl class="detailList">
 793                                 <dt class="heading">Returns:</dt>
 794
 795                                         <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>
 796
 797                                 </dl>
 798
 799
 800
 801
 802
 803
 804
 805                     </div>
 806                 </div>
 807
 808             </td>
 809             <td class="msource">
 810
 811                         Roo.LayoutManager
 812                 &nbsp;
 813             </td>
 814         </tr>
 815
 816
 817           <tr class="method-row config-row-alt1 expandable">
 818             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 819
 820
 821             <td class="sig">
 822                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 823                 <div class="fixedFont">
 824                         <span class="attributes"></span><b class="itemname">hasListener</b>
 825
 826                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 827
 828
 829                                          :
 830
 831
 832                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 833
 834
 835
 836
 837
 838                 </div>
 839                 <div class="mdesc">
 840
 841                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 842
 843
 844
 845                     <div class="long">
 846
 847                                 Checks to see if this object has any listeners for a specified event
 848
 849
 850
 851
 852
 853
 854                                 <dl class="detailList">
 855                                 <dt class="heading">Parameters:</dt>
 856
 857                                         <dt>
 858                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 859
 860                                         </dt>
 861                                         <dd>The name of the event to check for</dd>
 862
 863                                 </dl>
 864
 865
 866
 867
 868
 869                                 <dl class="detailList">
 870                                 <dt class="heading">Returns:</dt>
 871
 872                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
 873
 874                                 </dl>
 875
 876
 877
 878
 879
 880
 881
 882                     </div>
 883                 </div>
 884
 885             </td>
 886             <td class="msource">
 887
 888                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 889                 &nbsp;
 890             </td>
 891         </tr>
 892
 893
 894           <tr class="method-row config-row-alt0 expandable notInherited">
 895             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 896
 897
 898             <td class="sig">
 899                 <a id="Roo.LayoutManager-method-isUpdating"   name=".isUpdating"></a>
 900                 <div class="fixedFont">
 901                         <span class="attributes"></span><b class="itemname">isUpdating</b>
 902
 903                                  ()
 904
 905
 906                                          :
 907
 908
 909                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 910
 911
 912
 913
 914
 915                 </div>
 916                 <div class="mdesc">
 917
 918                    <div class="short">Returns true if this layout is currently being updated</div>
 919
 920
 921
 922                     <div class="long">
 923
 924                                 Returns true if this layout is currently being updated
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935                                 <dl class="detailList">
 936                                 <dt class="heading">Returns:</dt>
 937
 938                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 939
 940                                 </dl>
 941
 942
 943
 944
 945
 946
 947
 948                     </div>
 949                 </div>
 950
 951             </td>
 952             <td class="msource">
 953
 954                         Roo.LayoutManager
 955                 &nbsp;
 956             </td>
 957         </tr>
 958
 959
 960           <tr class="method-row config-row-alt1 expandable">
 961             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 962
 963
 964             <td class="sig">
 965                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 966                 <div class="fixedFont">
 967                         <span class="attributes"></span><b class="itemname">on</b>
 968
 969                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 970
 971
 972
 973                 </div>
 974                 <div class="mdesc">
 975
 976                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 977
 978
 979
 980                     <div class="long">
 981
 982                                 Appends an event handler to this element (shorthand for addListener)
 983
 984
 985
 986
 987
 988
 989                                 <dl class="detailList">
 990                                 <dt class="heading">Parameters:</dt>
 991
 992                                         <dt>
 993                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 994
 995                                         </dt>
 996                                         <dd>The type of event to listen for</dd>
 997
 998                                         <dt>
 999                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1000
1001                                         </dt>
1002                                         <dd>The method the event invokes</dd>
1003
1004                                         <dt>
1005                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1006
1007                                         </dt>
1008                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1009
1010                                         <dt>
1011                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1012
1013                                         </dt>
1014                                         <dd>(optional)</dd>
1015
1016                                 </dl>
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028                     </div>
1029                 </div>
1030
1031             </td>
1032             <td class="msource">
1033
1034                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1035                 &nbsp;
1036             </td>
1037         </tr>
1038
1039
1040           <tr class="method-row config-row-alt0 expandable">
1041             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1042
1043
1044             <td class="sig">
1045                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1046                 <div class="fixedFont">
1047                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1048
1049                                  ()
1050
1051
1052
1053                 </div>
1054                 <div class="mdesc">
1055
1056                    <div class="short">Removes all listeners for this object</div>
1057
1058
1059
1060                     <div class="long">
1061
1062                                 Removes all listeners for this object
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079                     </div>
1080                 </div>
1081
1082             </td>
1083             <td class="msource">
1084
1085                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1086                 &nbsp;
1087             </td>
1088         </tr>
1089
1090
1091           <tr class="method-row config-row-alt1 expandable">
1092             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1093
1094
1095             <td class="sig">
1096                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1097                 <div class="fixedFont">
1098                         <span class="attributes"></span><b class="itemname">removeListener</b>
1099
1100                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1101
1102
1103
1104                 </div>
1105                 <div class="mdesc">
1106
1107                    <div class="short">Removes a listener</div>
1108
1109
1110
1111                     <div class="long">
1112
1113                                 Removes a listener
1114
1115
1116
1117
1118
1119
1120                                 <dl class="detailList">
1121                                 <dt class="heading">Parameters:</dt>
1122
1123                                         <dt>
1124                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1125
1126                                         </dt>
1127                                         <dd>The type of event to listen for</dd>
1128
1129                                         <dt>
1130                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1131
1132                                         </dt>
1133                                         <dd>The handler to remove</dd>
1134
1135                                         <dt>
1136                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1137
1138                                         </dt>
1139                                         <dd>(optional) The scope (this object) for the handler</dd>
1140
1141                                 </dl>
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153                     </div>
1154                 </div>
1155
1156             </td>
1157             <td class="msource">
1158
1159                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1160                 &nbsp;
1161             </td>
1162         </tr>
1163
1164
1165           <tr class="method-row config-row-alt0 expandable">
1166             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1167
1168
1169             <td class="sig">
1170                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1171                 <div class="fixedFont">
1172                         <span class="attributes"></span><b class="itemname">un</b>
1173
1174                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1175
1176
1177
1178                 </div>
1179                 <div class="mdesc">
1180
1181                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1182
1183
1184
1185                     <div class="long">
1186
1187                                 Removes a listener (shorthand for removeListener)
1188
1189
1190
1191
1192
1193
1194                                 <dl class="detailList">
1195                                 <dt class="heading">Parameters:</dt>
1196
1197                                         <dt>
1198                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1199
1200                                         </dt>
1201                                         <dd>The type of event to listen for</dd>
1202
1203                                         <dt>
1204                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1205
1206                                         </dt>
1207                                         <dd>The handler to remove</dd>
1208
1209                                         <dt>
1210                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1211
1212                                         </dt>
1213                                         <dd>(optional) The scope (this object) for the handler</dd>
1214
1215                                 </dl>
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227                     </div>
1228                 </div>
1229
1230             </td>
1231             <td class="msource">
1232
1233                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1234                 &nbsp;
1235             </td>
1236         </tr>
1237
1238
1239     </table>
1240
1241
1242   <!-- ============================== events summary / details ======================== -->
1243
1244
1245   <a id="Roo.LayoutManager-events"></a>
1246
1247
1248
1249
1250
1251
1252
1253
1254       <table cellspacing="0" class="member-table">
1255                 <caption>Events</caption>
1256               <thead>
1257                 <tr>
1258                     <th class="sig-header" colspan="2">Event</th>
1259                     <th class="msource-header">Defined By</th>
1260
1261                 </tr>
1262               </thead>
1263
1264
1265
1266
1267
1268           <tr class="method-row expandable config-row-alt0 notInherited">
1269             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1270
1271             <td class="sig">
1272                 <a id="Roo.LayoutManager-event-*layout"></a>
1273
1274                <div class="fixedFont">
1275                 <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>)
1276
1277                 </div>
1278
1279                 <div class="mdesc">
1280
1281                    <div class="short">Fires when a layout is performed.
1282
1283                 </div>
1284
1285                     <div class="long">
1286
1287                         Fires when a layout is performed.
1288
1289
1290
1291
1292
1293                                 <dl class="detailList">
1294                                 <dt class="heading">Parameters:</dt>
1295
1296                                         <dt>
1297                                                 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
1298
1299                                         </dt>
1300                                         <dd></dd>
1301
1302                                 </dl>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314                     </div>
1315                 </div>
1316
1317             </td>
1318             <td class="msource">
1319                 Roo.LayoutManager
1320             </td>
1321         </tr>
1322
1323           <tr class="method-row expandable config-row-alt1 notInherited">
1324             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1325
1326             <td class="sig">
1327                 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
1328
1329                <div class="fixedFont">
1330                 <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>)
1331
1332                 </div>
1333
1334                 <div class="mdesc">
1335
1336                    <div class="short">Fires when a region is collapsed.
1337
1338                 </div>
1339
1340                     <div class="long">
1341
1342                         Fires when a region is collapsed.
1343
1344
1345
1346
1347
1348                                 <dl class="detailList">
1349                                 <dt class="heading">Parameters:</dt>
1350
1351                                         <dt>
1352                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
1353
1354                                         </dt>
1355                                         <dd>The collapsed region</dd>
1356
1357                                 </dl>
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369                     </div>
1370                 </div>
1371
1372             </td>
1373             <td class="msource">
1374                 Roo.LayoutManager
1375             </td>
1376         </tr>
1377
1378           <tr class="method-row expandable config-row-alt0 notInherited">
1379             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1380
1381             <td class="sig">
1382                 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
1383
1384                <div class="fixedFont">
1385                 <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>)
1386
1387                 </div>
1388
1389                 <div class="mdesc">
1390
1391                    <div class="short">Fires when a region is expanded.
1392
1393                 </div>
1394
1395                     <div class="long">
1396
1397                         Fires when a region is expanded.
1398
1399
1400
1401
1402
1403                                 <dl class="detailList">
1404                                 <dt class="heading">Parameters:</dt>
1405
1406                                         <dt>
1407                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
1408
1409                                         </dt>
1410                                         <dd>The expanded region</dd>
1411
1412                                 </dl>
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424                     </div>
1425                 </div>
1426
1427             </td>
1428             <td class="msource">
1429                 Roo.LayoutManager
1430             </td>
1431         </tr>
1432
1433           <tr class="method-row expandable config-row-alt1 notInherited">
1434             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1435
1436             <td class="sig">
1437                 <a id="Roo.LayoutManager-event-*regionresized"></a>
1438
1439                <div class="fixedFont">
1440                 <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>)
1441
1442                 </div>
1443
1444                 <div class="mdesc">
1445
1446                    <div class="short">Fires when the user resizes a region.
1447
1448                 </div>
1449
1450                     <div class="long">
1451
1452                         Fires when the user resizes a region.
1453
1454
1455
1456
1457
1458                                 <dl class="detailList">
1459                                 <dt class="heading">Parameters:</dt>
1460
1461                                         <dt>
1462                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
1463
1464                                         </dt>
1465                                         <dd>The resized region</dd>
1466
1467                                         <dt>
1468                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
1469
1470                                         </dt>
1471                                         <dd>The new size (width for east/west, height for north/south)</dd>
1472
1473                                 </dl>
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485                     </div>
1486                 </div>
1487
1488             </td>
1489             <td class="msource">
1490                 Roo.LayoutManager
1491             </td>
1492         </tr>
1493
1494
1495     </table>
1496
1497
1498
1499
1500
1501 <!-- ============================== footer ================================= -->
1502                 <div class="fineprint" style="clear:both">
1503
1504                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT)
1505                         Based on
1506                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1507                 </div>
1508         </body>
1509 </html>