git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.ReaderLayout.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.ReaderLayout</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.ReaderLayout-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.ReaderLayout-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.ReaderLayout-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.ReaderLayout-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
  48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
  49 <img src="../../images/default/s.gif" height="1"  width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.ReaderLayout
  50
  51                    </pre>
  52                 </div>
  53
  54 <!-- ============================== class title / details ============================ -->
  55
  56
  57     <h1 class="classTitle">
  58
  59                                 Class Roo.ReaderLayout
  60                         </h1>
  61
  62     <table cellspacing="0" class="class-summary-table">
  63
  64                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  65
  66         <tr><td class="label">Defined In:</td><td class="hd-info">
  67
  68                                         <a href="./src/Roo_ReaderLayout.js.html">Roo/ReaderLayout.js</a>.
  69
  70         </td></tr>
  71         <tr><td class="label">Class:</td><td class="hd-info">ReaderLayout</td></tr>
  72
  73
  74
  75
  76                 <tr><td class="label">Extends:</td><td class="hd-info">
  77                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
  78
  79                 </td></tr>
  80
  81
  82     </table>
  83
  84
  85 <!-- ============================== class summary ========================== -->
  86     <div class="description">
  87         This is a pre-built layout that represents a classic, 5-pane application.  It consists of a header, a primary<br/>center region containing two nested regions (a top one for a list view and one for item preview below),<br/>and regions on either side that can be used for navigation, application commands, informational displays, etc.<br/>The setup and configuration work exactly the same as it does for a {<b>link</b> Roo.BorderLayout} - this class simply<br/>expedites the setup of the overall layout and regions for this common application style.<br/>Example:<br/> <pre><code><br/>var reader = new Roo.ReaderLayout();<br/>var CP = Roo.ContentPanel;  // shortcut for adding<br/><br/>reader.beginUpdate();<br/>reader.add("north", new CP("north", "North"));<br/>reader.add("west", new CP("west", {title: "West"}));<br/>reader.add("east", new CP("east", {title: "East"}));<br/><br/>reader.regions.listView.add(new CP("listView", "List"));<br/>reader.regions.preview.add(new CP("preview", "Preview"));<br/>reader.endUpdate();<br/></code></pre>
  88     </div>
  89
  90
  91 <!-- ============================== Class comment block... ========================== -->
  92
  93 <div class="comments">
  94         <b>Class Comments / Notes</B> =>
  95         <u onclick="parent.CommentDialog.showCommentId = 'Roo.ReaderLayout';">[Add Your comment/notes about this class]</u>
  96         <br/>
  97         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  98                 src="/blog.php/GtkDjsComments/Roo.ReaderLayout.html"></iframe>
  99 </div>
 100
 101
 102
 103 <!-- ============================== config options ========================== -->
 104
 105
 106
 107
 108     <div class="hr"></div>
 109     <a id="Roo.ReaderLayout-configs"></a>
 110
 111
 112
 113
 114
 115       <table cellspacing="0" class="member-table">
 116       <caption>Config Options (Usually are also Properties)</caption>
 117
 118
 119         <tr>
 120             <th class="sig-header" colspan="2">Options</th>
 121
 122             <th class="msource-header">Defined By</th>
 123         </tr>
 124
 125
 126
 127
 128
 129                 <tr class="config-row expandable config-row-alt0">
 130                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 131                     <td class="sig">
 132
 133                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 134                         <div class="fixedFont">
 135                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 136
 137
 138                         </div>
 139
 140                         <div class="mdesc">
 141                             <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>
 142                         </div>
 143
 144                         <div class="mdesc">
 145                             <div class="long">
 146                     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>
 147
 148                 </div>
 149                         </div>
 150
 151
 152
 153                     </td>
 154                     <td class="msource">
 155
 156                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 157
 158                     </td>
 159                 </tr>
 160
 161
 162     </table>
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172   <!-- ============================== public properties ==================== -->
 173
 174
 175
 176     <a id="Roo.ReaderLayout-props"></a>
 177
 178
 179
 180
 181
 182      <table cellspacing="0" class="member-table">
 183       <caption class="Empty">Public Properties - Has None</caption>
 184      </table>
 185
 186
 187
 188
 189   <!-- ============================== methods summary / details ======================== -->
 190
 191
 192   <a id="Roo.ReaderLayout-methods"></a>
 193         <!-- constructor?? -->
 194
 195         <!-- static's first
 196
 197
 198         -->
 199
 200         <!-- then dynamics first -->
 201
 202
 203
 204
 205
 206
 207       <table cellspacing="0" class="member-table">
 208       <caption>Public Methods</caption>
 209         <tr>
 210             <th class="sig-header" colspan="2">Method</th>
 211             <th class="msource-header">Defined By</th>
 212
 213         </tr>
 214
 215
 216
 217
 218
 219
 220
 221           <tr class="method-row config-row-alt0 expandable notInherited">
 222             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 223
 224
 225             <td class="sig">
 226                 <a id="Roo-method-ReaderLayout"   name=".ReaderLayout"></a>
 227                 <div class="fixedFont">
 228                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">ReaderLayout</b>
 229
 230                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
 231
 232
 233
 234                 </div>
 235                 <div class="mdesc">
 236
 237
 238                         <div class="short">Create a new Roo.ReaderLayout</div>
 239
 240
 241                     <div class="long">
 242
 243
 244
 245                                 Create a new Roo.ReaderLayout
 246
 247
 248                                 <dl class="detailList">
 249                                 <dt class="heading">Parameters:</dt>
 250
 251                                         <dt>
 252                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 253
 254                                         </dt>
 255                                         <dd>Configuration options</dd>
 256
 257                                         <dt>
 258                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
 259
 260                                         </dt>
 261                                         <dd>(optional) The container this layout is bound to (defaults to<br/>document.body if omitted)</dd>
 262
 263                                 </dl>
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275                     </div>
 276                 </div>
 277
 278             </td>
 279             <td class="msource">
 280                 &nbsp;
 281             </td>
 282         </tr>
 283
 284
 285           <tr class="method-row config-row-alt1 expandable">
 286             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 287
 288
 289             <td class="sig">
 290                 <a id="Roo.BorderLayout-method-add"   name=".add"></a>
 291                 <div class="fixedFont">
 292                         <span class="attributes"></span><b class="itemname">add</b>
 293
 294                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
 295
 296
 297                                          :
 298
 299
 300                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 301
 302
 303
 304
 305
 306                 </div>
 307                 <div class="mdesc">
 308
 309                    <div class="short">Adds a ContentPanel (or subclass) to this layout.</div>
 310
 311
 312
 313                     <div class="long">
 314
 315                                 Adds a ContentPanel (or subclass) to this layout.
 316
 317
 318
 319
 320
 321
 322                                 <dl class="detailList">
 323                                 <dt class="heading">Parameters:</dt>
 324
 325                                         <dt>
 326                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 327
 328                                         </dt>
 329                                         <dd>The target region key (north, south, east, west or center).</dd>
 330
 331                                         <dt>
 332                                                 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  <b>panel</b>
 333
 334                                         </dt>
 335                                         <dd>The panel to add</dd>
 336
 337                                 </dl>
 338
 339
 340
 341
 342
 343                                 <dl class="detailList">
 344                                 <dt class="heading">Returns:</dt>
 345
 346                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The added panel</dd>
 347
 348                                 </dl>
 349
 350
 351
 352
 353
 354
 355
 356                     </div>
 357                 </div>
 358
 359             </td>
 360             <td class="msource">
 361
 362                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
 363                 &nbsp;
 364             </td>
 365         </tr>
 366
 367
 368           <tr class="method-row config-row-alt0 expandable">
 369             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 370
 371
 372             <td class="sig">
 373                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 374                 <div class="fixedFont">
 375                         <span class="attributes"></span><b class="itemname">addEvents</b>
 376
 377                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 378
 379
 380
 381                 </div>
 382                 <div class="mdesc">
 383
 384                    <div class="short">Used to define events on this Observable</div>
 385
 386
 387
 388                     <div class="long">
 389
 390                                 Used to define events on this Observable
 391
 392
 393
 394
 395
 396
 397                                 <dl class="detailList">
 398                                 <dt class="heading">Parameters:</dt>
 399
 400                                         <dt>
 401                                                 <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>
 402
 403                                         </dt>
 404                                         <dd>The object with the events defined</dd>
 405
 406                                 </dl>
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418                     </div>
 419                 </div>
 420
 421             </td>
 422             <td class="msource">
 423
 424                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 425                 &nbsp;
 426             </td>
 427         </tr>
 428
 429
 430           <tr class="method-row config-row-alt1 expandable">
 431             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 432
 433
 434             <td class="sig">
 435                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 436                 <div class="fixedFont">
 437                         <span class="attributes"></span><b class="itemname">addListener</b>
 438
 439                                  (<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>)
 440
 441
 442
 443                 </div>
 444                 <div class="mdesc">
 445
 446                    <div class="short">Appends an event handler to this component</div>
 447
 448
 449
 450                     <div class="long">
 451
 452                                 Appends an event handler to this component
 453
 454
 455
 456
 457
 458
 459                                 <dl class="detailList">
 460                                 <dt class="heading">Parameters:</dt>
 461
 462                                         <dt>
 463                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 464
 465                                         </dt>
 466                                         <dd>The type of event to listen for</dd>
 467
 468                                         <dt>
 469                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 470
 471                                         </dt>
 472                                         <dd>The method the event invokes</dd>
 473
 474                                         <dt>
 475                                                 <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>
 476
 477                                         </dt>
 478                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 479
 480                                         <dt>
 481                                                 <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>
 482
 483                                         </dt>
 484                                         <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>
 485
 486                                 </dl>
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498                     </div>
 499                 </div>
 500
 501             </td>
 502             <td class="msource">
 503
 504                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 505                 &nbsp;
 506             </td>
 507         </tr>
 508
 509
 510           <tr class="method-row config-row-alt0 expandable">
 511             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 512
 513
 514             <td class="sig">
 515                 <a id="Roo.BorderLayout-method-addRegion"   name=".addRegion"></a>
 516                 <div class="fixedFont">
 517                         <span class="attributes"></span><b class="itemname">addRegion</b>
 518
 519                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 520
 521
 522                                          :
 523
 524
 525                                                 BorderLayoutRegion
 526
 527
 528
 529
 530
 531                 </div>
 532                 <div class="mdesc">
 533
 534                    <div class="short">Creates and adds a new region if it doesn't already exist.</div>
 535
 536
 537
 538                     <div class="long">
 539
 540                                 Creates and adds a new region if it doesn't already exist.
 541
 542
 543
 544
 545
 546
 547                                 <dl class="detailList">
 548                                 <dt class="heading">Parameters:</dt>
 549
 550                                         <dt>
 551                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 552
 553                                         </dt>
 554                                         <dd>The target region key (north, south, east, west or center).</dd>
 555
 556                                         <dt>
 557                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 558
 559                                         </dt>
 560                                         <dd>The regions config object</dd>
 561
 562                                 </dl>
 563
 564
 565
 566
 567
 568                                 <dl class="detailList">
 569                                 <dt class="heading">Returns:</dt>
 570
 571                                         <dd><span class="fixedFont">BorderLayoutRegion</span>  The new region</dd>
 572
 573                                 </dl>
 574
 575
 576
 577
 578
 579
 580
 581                     </div>
 582                 </div>
 583
 584             </td>
 585             <td class="msource">
 586
 587                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
 588                 &nbsp;
 589             </td>
 590         </tr>
 591
 592
 593           <tr class="method-row config-row-alt1 expandable">
 594             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 595
 596
 597             <td class="sig">
 598                 <a id="Roo.BorderLayout-method-addxtype"   name=".addxtype"></a>
 599                 <div class="fixedFont">
 600                         <span class="attributes"></span><b class="itemname">addxtype</b>
 601
 602                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
 603
 604
 605
 606                 </div>
 607                 <div class="mdesc">
 608
 609                    <div class="short">Adds a xtype elements to the layout.</div>
 610
 611
 612
 613                     <div class="long">
 614
 615                                 Adds a xtype elements to the layout.<br/><pre><code><br/><br/>layout.addxtype({<br/>       xtype : 'ContentPanel',<br/>       region: 'west',<br/>       items: [ .... ]<br/>   }<br/>);<br/><br/>layout.addxtype({<br/>        xtype : 'NestedLayoutPanel',<br/>        region: 'west',<br/>        layout: {<br/>           center: { },<br/>           west: { }   <br/>        },<br/>        items : [ ... list of content panels or nested layout panels.. ]<br/>   }<br/>);<br/></code></pre>
 616
 617
 618
 619
 620
 621
 622                                 <dl class="detailList">
 623                                 <dt class="heading">Parameters:</dt>
 624
 625                                         <dt>
 626                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>cfg</b>
 627
 628                                         </dt>
 629                                         <dd>Xtype definition of item to add.</dd>
 630
 631                                 </dl>
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643                     </div>
 644                 </div>
 645
 646             </td>
 647             <td class="msource">
 648
 649                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
 650                 &nbsp;
 651             </td>
 652         </tr>
 653
 654
 655           <tr class="method-row config-row-alt0 expandable">
 656             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 657
 658
 659             <td class="sig">
 660                 <a id="Roo.BorderLayout-method-batchAdd"   name=".batchAdd"></a>
 661                 <div class="fixedFont">
 662                         <span class="attributes"></span><b class="itemname">batchAdd</b>
 663
 664                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>regions</i></B>)
 665
 666
 667
 668                 </div>
 669                 <div class="mdesc">
 670
 671                    <div class="short">Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.</div>
 672
 673
 674
 675                     <div class="long">
 676
 677                                 Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.  This config<br/>object should contain properties for each region to add ContentPanels to, and each property's value should be<br/>a valid ContentPanel config object.  Example:<br/><pre><code><br/>// Create the main layout<br/>var layout = new Roo.BorderLayout('main-ct', {<br/>    west: {<br/>        split:true,<br/>        minSize: 175,<br/>        titlebar: true<br/>    },<br/>    center: {<br/>        title:'Components'<br/>    }<br/>}, 'main-ct');<br/><br/>// Create and add multiple ContentPanels at once via configs<br/>layout.batchAdd({<br/>   west: {<br/>       id: 'source-files',<br/>       autoCreate:true,<br/>       title:'Ext Source Files',<br/>       autoScroll:true,<br/>       fitToFrame:true<br/>   },<br/>   center : {<br/>       el: cview,<br/>       autoScroll:true,<br/>       fitToFrame:true,<br/>       toolbar: tb,<br/>       resizeEl:'cbody'<br/>   }<br/>});<br/></code></pre>
 678
 679
 680
 681
 682
 683
 684                                 <dl class="detailList">
 685                                 <dt class="heading">Parameters:</dt>
 686
 687                                         <dt>
 688                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>regions</b>
 689
 690                                         </dt>
 691                                         <dd>An object containing ContentPanel configs by region name</dd>
 692
 693                                 </dl>
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705                     </div>
 706                 </div>
 707
 708             </td>
 709             <td class="msource">
 710
 711                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
 712                 &nbsp;
 713             </td>
 714         </tr>
 715
 716
 717           <tr class="method-row config-row-alt1 expandable">
 718             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 719
 720
 721             <td class="sig">
 722                 <a id="Roo.LayoutManager-method-beginUpdate"   name=".beginUpdate"></a>
 723                 <div class="fixedFont">
 724                         <span class="attributes"></span><b class="itemname">beginUpdate</b>
 725
 726                                  ()
 727
 728
 729
 730                 </div>
 731                 <div class="mdesc">
 732
 733                    <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
 734
 735
 736
 737                     <div class="long">
 738
 739                                 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756                     </div>
 757                 </div>
 758
 759             </td>
 760             <td class="msource">
 761
 762                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
 763                 &nbsp;
 764             </td>
 765         </tr>
 766
 767
 768           <tr class="method-row config-row-alt0 expandable">
 769             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 770
 771
 772             <td class="sig">
 773                 <a id="Roo.LayoutManager-method-endUpdate"   name=".endUpdate"></a>
 774                 <div class="fixedFont">
 775                         <span class="attributes"></span><b class="itemname">endUpdate</b>
 776
 777                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
 778
 779
 780
 781                 </div>
 782                 <div class="mdesc">
 783
 784                    <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
 785
 786
 787
 788                     <div class="long">
 789
 790                                 Restore auto-layouts and optionally disable the manager from performing a layout
 791
 792
 793
 794
 795
 796
 797                                 <dl class="detailList">
 798                                 <dt class="heading">Parameters:</dt>
 799
 800                                         <dt>
 801                                                 <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>
 802
 803                                         </dt>
 804                                         <dd>true to disable a layout update</dd>
 805
 806                                 </dl>
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818                     </div>
 819                 </div>
 820
 821             </td>
 822             <td class="msource">
 823
 824                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
 825                 &nbsp;
 826             </td>
 827         </tr>
 828
 829
 830           <tr class="method-row config-row-alt1 expandable">
 831             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 832
 833
 834             <td class="sig">
 835                 <a id="Roo.BorderLayout-method-findPanel"   name=".findPanel"></a>
 836                 <div class="fixedFont">
 837                         <span class="attributes"></span><b class="itemname">findPanel</b>
 838
 839                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>panelId</i></B>)
 840
 841
 842                                          :
 843
 844
 845                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 846
 847
 848
 849
 850
 851                 </div>
 852                 <div class="mdesc">
 853
 854                    <div class="short">Searches all regions for a panel with the specified id</div>
 855
 856
 857
 858                     <div class="long">
 859
 860                                 Searches all regions for a panel with the specified id
 861
 862
 863
 864
 865
 866
 867                                 <dl class="detailList">
 868                                 <dt class="heading">Parameters:</dt>
 869
 870                                         <dt>
 871                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>panelId</b>
 872
 873                                         </dt>
 874                                         <dd></dd>
 875
 876                                 </dl>
 877
 878
 879
 880
 881
 882                                 <dl class="detailList">
 883                                 <dt class="heading">Returns:</dt>
 884
 885                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The panel or null if it wasn't found</dd>
 886
 887                                 </dl>
 888
 889
 890
 891
 892
 893
 894
 895                     </div>
 896                 </div>
 897
 898             </td>
 899             <td class="msource">
 900
 901                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
 902                 &nbsp;
 903             </td>
 904         </tr>
 905
 906
 907           <tr class="method-row config-row-alt0 expandable">
 908             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 909
 910
 911             <td class="sig">
 912                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 913                 <div class="fixedFont">
 914                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 915
 916                                  (<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>)
 917
 918
 919                                          :
 920
 921
 922                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 923
 924
 925
 926
 927
 928                 </div>
 929                 <div class="mdesc">
 930
 931                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 932
 933
 934
 935                     <div class="long">
 936
 937                                 Fires the specified event with the passed parameters (minus the event name).
 938
 939
 940
 941
 942
 943
 944                                 <dl class="detailList">
 945                                 <dt class="heading">Parameters:</dt>
 946
 947                                         <dt>
 948                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 949
 950                                         </dt>
 951                                         <dd></dd>
 952
 953                                         <dt>
 954                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 955
 956                                         </dt>
 957                                         <dd>Variable number of parameters are passed to handlers</dd>
 958
 959                                 </dl>
 960
 961
 962
 963
 964
 965                                 <dl class="detailList">
 966                                 <dt class="heading">Returns:</dt>
 967
 968                                         <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>
 969
 970                                 </dl>
 971
 972
 973
 974
 975
 976
 977
 978                     </div>
 979                 </div>
 980
 981             </td>
 982             <td class="msource">
 983
 984                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 985                 &nbsp;
 986             </td>
 987         </tr>
 988
 989
 990           <tr class="method-row config-row-alt1 expandable">
 991             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 992
 993
 994             <td class="sig">
 995                 <a id="Roo.LayoutManager-method-getEl"   name=".getEl"></a>
 996                 <div class="fixedFont">
 997                         <span class="attributes"></span><b class="itemname">getEl</b>
 998
 999                                  ()
1000
1001
1002                                          :
1003
1004
1005                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1006
1007
1008
1009
1010
1011                 </div>
1012                 <div class="mdesc">
1013
1014                    <div class="short">Returns the Element this layout is bound to.</div>
1015
1016
1017
1018                     <div class="long">
1019
1020                                 Returns the Element this layout is bound to.
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031                                 <dl class="detailList">
1032                                 <dt class="heading">Returns:</dt>
1033
1034                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
1035
1036                                 </dl>
1037
1038
1039
1040
1041
1042
1043
1044                     </div>
1045                 </div>
1046
1047             </td>
1048             <td class="msource">
1049
1050                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1051                 &nbsp;
1052             </td>
1053         </tr>
1054
1055
1056           <tr class="method-row config-row-alt0 expandable">
1057             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1058
1059
1060             <td class="sig">
1061                 <a id="Roo.LayoutManager-method-getRegion"   name=".getRegion"></a>
1062                 <div class="fixedFont">
1063                         <span class="attributes"></span><b class="itemname">getRegion</b>
1064
1065                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
1066
1067
1068                                          :
1069
1070
1071                                                 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
1072
1073
1074
1075
1076
1077                 </div>
1078                 <div class="mdesc">
1079
1080                    <div class="short">Returns the specified region.</div>
1081
1082
1083
1084                     <div class="long">
1085
1086                                 Returns the specified region.
1087
1088
1089
1090
1091
1092
1093                                 <dl class="detailList">
1094                                 <dt class="heading">Parameters:</dt>
1095
1096                                         <dt>
1097                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
1098
1099                                         </dt>
1100                                         <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
1101
1102                                 </dl>
1103
1104
1105
1106
1107
1108                                 <dl class="detailList">
1109                                 <dt class="heading">Returns:</dt>
1110
1111                                         <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span>  </dd>
1112
1113                                 </dl>
1114
1115
1116
1117
1118
1119
1120
1121                     </div>
1122                 </div>
1123
1124             </td>
1125             <td class="msource">
1126
1127                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1128                 &nbsp;
1129             </td>
1130         </tr>
1131
1132
1133           <tr class="method-row config-row-alt1 expandable">
1134             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1135
1136
1137             <td class="sig">
1138                 <a id="Roo.LayoutManager-method-getViewSize"   name=".getViewSize"></a>
1139                 <div class="fixedFont">
1140                         <span class="attributes"></span><b class="itemname">getViewSize</b>
1141
1142                                  ()
1143
1144
1145                                          :
1146
1147
1148                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1149
1150
1151
1152
1153
1154                 </div>
1155                 <div class="mdesc">
1156
1157                    <div class="short">Returns the size of the current view.</div>
1158
1159
1160
1161                     <div class="long">
1162
1163                                 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174                                 <dl class="detailList">
1175                                 <dt class="heading">Returns:</dt>
1176
1177                                         <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>
1178
1179                                 </dl>
1180
1181
1182
1183
1184
1185
1186
1187                     </div>
1188                 </div>
1189
1190             </td>
1191             <td class="msource">
1192
1193                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1194                 &nbsp;
1195             </td>
1196         </tr>
1197
1198
1199           <tr class="method-row config-row-alt0 expandable">
1200             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1201
1202
1203             <td class="sig">
1204                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1205                 <div class="fixedFont">
1206                         <span class="attributes"></span><b class="itemname">hasListener</b>
1207
1208                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1209
1210
1211                                          :
1212
1213
1214                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1215
1216
1217
1218
1219
1220                 </div>
1221                 <div class="mdesc">
1222
1223                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1224
1225
1226
1227                     <div class="long">
1228
1229                                 Checks to see if this object has any listeners for a specified event
1230
1231
1232
1233
1234
1235
1236                                 <dl class="detailList">
1237                                 <dt class="heading">Parameters:</dt>
1238
1239                                         <dt>
1240                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1241
1242                                         </dt>
1243                                         <dd>The name of the event to check for</dd>
1244
1245                                 </dl>
1246
1247
1248
1249
1250
1251                                 <dl class="detailList">
1252                                 <dt class="heading">Returns:</dt>
1253
1254                                         <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>
1255
1256                                 </dl>
1257
1258
1259
1260
1261
1262
1263
1264                     </div>
1265                 </div>
1266
1267             </td>
1268             <td class="msource">
1269
1270                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1271                 &nbsp;
1272             </td>
1273         </tr>
1274
1275
1276           <tr class="method-row config-row-alt1 expandable">
1277             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1278
1279
1280             <td class="sig">
1281                 <a id="Roo.LayoutManager-method-isUpdating"   name=".isUpdating"></a>
1282                 <div class="fixedFont">
1283                         <span class="attributes"></span><b class="itemname">isUpdating</b>
1284
1285                                  ()
1286
1287
1288                                          :
1289
1290
1291                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1292
1293
1294
1295
1296
1297                 </div>
1298                 <div class="mdesc">
1299
1300                    <div class="short">Returns true if this layout is currently being updated</div>
1301
1302
1303
1304                     <div class="long">
1305
1306                                 Returns true if this layout is currently being updated
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317                                 <dl class="detailList">
1318                                 <dt class="heading">Returns:</dt>
1319
1320                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1321
1322                                 </dl>
1323
1324
1325
1326
1327
1328
1329
1330                     </div>
1331                 </div>
1332
1333             </td>
1334             <td class="msource">
1335
1336                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1337                 &nbsp;
1338             </td>
1339         </tr>
1340
1341
1342           <tr class="method-row config-row-alt0 expandable">
1343             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1344
1345
1346             <td class="sig">
1347                 <a id="Roo.BorderLayout-method-layout"   name=".layout"></a>
1348                 <div class="fixedFont">
1349                         <span class="attributes"></span><b class="itemname">layout</b>
1350
1351                                  ()
1352
1353
1354
1355                 </div>
1356                 <div class="mdesc">
1357
1358                    <div class="short">Performs a layout update.</div>
1359
1360
1361
1362                     <div class="long">
1363
1364                                 Performs a layout update.
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381                     </div>
1382                 </div>
1383
1384             </td>
1385             <td class="msource">
1386
1387                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1388                 &nbsp;
1389             </td>
1390         </tr>
1391
1392
1393           <tr class="method-row config-row-alt1 expandable">
1394             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1395
1396
1397             <td class="sig">
1398                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1399                 <div class="fixedFont">
1400                         <span class="attributes"></span><b class="itemname">on</b>
1401
1402                                  (<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>)
1403
1404
1405
1406                 </div>
1407                 <div class="mdesc">
1408
1409                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1410
1411
1412
1413                     <div class="long">
1414
1415                                 Appends an event handler to this element (shorthand for addListener)
1416
1417
1418
1419
1420
1421
1422                                 <dl class="detailList">
1423                                 <dt class="heading">Parameters:</dt>
1424
1425                                         <dt>
1426                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1427
1428                                         </dt>
1429                                         <dd>The type of event to listen for</dd>
1430
1431                                         <dt>
1432                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1433
1434                                         </dt>
1435                                         <dd>The method the event invokes</dd>
1436
1437                                         <dt>
1438                                                 <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>
1439
1440                                         </dt>
1441                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1442
1443                                         <dt>
1444                                                 <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>
1445
1446                                         </dt>
1447                                         <dd>(optional)</dd>
1448
1449                                 </dl>
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461                     </div>
1462                 </div>
1463
1464             </td>
1465             <td class="msource">
1466
1467                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1468                 &nbsp;
1469             </td>
1470         </tr>
1471
1472
1473           <tr class="method-row config-row-alt0 expandable">
1474             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1475
1476
1477             <td class="sig">
1478                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1479                 <div class="fixedFont">
1480                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1481
1482                                  ()
1483
1484
1485
1486                 </div>
1487                 <div class="mdesc">
1488
1489                    <div class="short">Removes all listeners for this object</div>
1490
1491
1492
1493                     <div class="long">
1494
1495                                 Removes all listeners for this object
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512                     </div>
1513                 </div>
1514
1515             </td>
1516             <td class="msource">
1517
1518                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1519                 &nbsp;
1520             </td>
1521         </tr>
1522
1523
1524           <tr class="method-row config-row-alt1 expandable">
1525             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1526
1527
1528             <td class="sig">
1529                 <a id="Roo.BorderLayout-method-remove"   name=".remove"></a>
1530                 <div class="fixedFont">
1531                         <span class="attributes"></span><b class="itemname">remove</b>
1532
1533                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel <B><i>panel</i></B>)
1534
1535
1536                                          :
1537
1538
1539                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1540
1541
1542
1543
1544
1545                 </div>
1546                 <div class="mdesc">
1547
1548                    <div class="short">Remove a ContentPanel (or subclass) to this layout.</div>
1549
1550
1551
1552                     <div class="long">
1553
1554                                 Remove a ContentPanel (or subclass) to this layout.
1555
1556
1557
1558
1559
1560
1561                                 <dl class="detailList">
1562                                 <dt class="heading">Parameters:</dt>
1563
1564                                         <dt>
1565                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
1566
1567                                         </dt>
1568                                         <dd>The target region key (north, south, east, west or center).</dd>
1569
1570                                         <dt>
1571                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel</span>  <b>panel</b>
1572
1573                                         </dt>
1574                                         <dd>The index, id or panel to remove</dd>
1575
1576                                 </dl>
1577
1578
1579
1580
1581
1582                                 <dl class="detailList">
1583                                 <dt class="heading">Returns:</dt>
1584
1585                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The removed panel</dd>
1586
1587                                 </dl>
1588
1589
1590
1591
1592
1593
1594
1595                     </div>
1596                 </div>
1597
1598             </td>
1599             <td class="msource">
1600
1601                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1602                 &nbsp;
1603             </td>
1604         </tr>
1605
1606
1607           <tr class="method-row config-row-alt0 expandable">
1608             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1609
1610
1611             <td class="sig">
1612                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1613                 <div class="fixedFont">
1614                         <span class="attributes"></span><b class="itemname">removeListener</b>
1615
1616                                  (<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>)
1617
1618
1619
1620                 </div>
1621                 <div class="mdesc">
1622
1623                    <div class="short">Removes a listener</div>
1624
1625
1626
1627                     <div class="long">
1628
1629                                 Removes a listener
1630
1631
1632
1633
1634
1635
1636                                 <dl class="detailList">
1637                                 <dt class="heading">Parameters:</dt>
1638
1639                                         <dt>
1640                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1641
1642                                         </dt>
1643                                         <dd>The type of event to listen for</dd>
1644
1645                                         <dt>
1646                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1647
1648                                         </dt>
1649                                         <dd>The handler to remove</dd>
1650
1651                                         <dt>
1652                                                 <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>
1653
1654                                         </dt>
1655                                         <dd>(optional) The scope (this object) for the handler</dd>
1656
1657                                 </dl>
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669                     </div>
1670                 </div>
1671
1672             </td>
1673             <td class="msource">
1674
1675                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1676                 &nbsp;
1677             </td>
1678         </tr>
1679
1680
1681           <tr class="method-row config-row-alt1 expandable">
1682             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1683
1684
1685             <td class="sig">
1686                 <a id="Roo.BorderLayout-method-restoreState"   name=".restoreState"></a>
1687                 <div class="fixedFont">
1688                         <span class="attributes"></span><b class="itemname">restoreState</b>
1689
1690                                  (<a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a> <B><i>provider</i></B>)
1691
1692
1693
1694                 </div>
1695                 <div class="mdesc">
1696
1697                    <div class="short">Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.</div>
1698
1699
1700
1701                     <div class="long">
1702
1703                                 Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.
1704
1705
1706
1707
1708
1709
1710                                 <dl class="detailList">
1711                                 <dt class="heading">Parameters:</dt>
1712
1713                                         <dt>
1714                                                 <span class="fixedFont"><a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a></span>  <b>provider</b>
1715
1716                                         </dt>
1717                                         <dd>(optional) An alternate state provider</dd>
1718
1719                                 </dl>
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731                     </div>
1732                 </div>
1733
1734             </td>
1735             <td class="msource">
1736
1737                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1738                 &nbsp;
1739             </td>
1740         </tr>
1741
1742
1743           <tr class="method-row config-row-alt0 expandable">
1744             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1745
1746
1747             <td class="sig">
1748                 <a id="Roo.BorderLayout-method-showPanel"   name=".showPanel"></a>
1749                 <div class="fixedFont">
1750                         <span class="attributes"></span><b class="itemname">showPanel</b>
1751
1752                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel <B><i>panelId</i></B>)
1753
1754
1755                                          :
1756
1757
1758                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1759
1760
1761
1762
1763
1764                 </div>
1765                 <div class="mdesc">
1766
1767                    <div class="short">Searches all regions for a panel with the specified id and activates (shows) it.</div>
1768
1769
1770
1771                     <div class="long">
1772
1773                                 Searches all regions for a panel with the specified id and activates (shows) it.
1774
1775
1776
1777
1778
1779
1780                                 <dl class="detailList">
1781                                 <dt class="heading">Parameters:</dt>
1782
1783                                         <dt>
1784                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel</span>  <b>panelId</b>
1785
1786                                         </dt>
1787                                         <dd>The panels id or the panel itself</dd>
1788
1789                                 </dl>
1790
1791
1792
1793
1794
1795                                 <dl class="detailList">
1796                                 <dt class="heading">Returns:</dt>
1797
1798                                         <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>
1799
1800                                 </dl>
1801
1802
1803
1804
1805
1806
1807
1808                     </div>
1809                 </div>
1810
1811             </td>
1812             <td class="msource">
1813
1814                         <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1815                 &nbsp;
1816             </td>
1817         </tr>
1818
1819
1820           <tr class="method-row config-row-alt1 expandable">
1821             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1822
1823
1824             <td class="sig">
1825                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1826                 <div class="fixedFont">
1827                         <span class="attributes"></span><b class="itemname">un</b>
1828
1829                                  (<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>)
1830
1831
1832
1833                 </div>
1834                 <div class="mdesc">
1835
1836                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1837
1838
1839
1840                     <div class="long">
1841
1842                                 Removes a listener (shorthand for removeListener)
1843
1844
1845
1846
1847
1848
1849                                 <dl class="detailList">
1850                                 <dt class="heading">Parameters:</dt>
1851
1852                                         <dt>
1853                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1854
1855                                         </dt>
1856                                         <dd>The type of event to listen for</dd>
1857
1858                                         <dt>
1859                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1860
1861                                         </dt>
1862                                         <dd>The handler to remove</dd>
1863
1864                                         <dt>
1865                                                 <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>
1866
1867                                         </dt>
1868                                         <dd>(optional) The scope (this object) for the handler</dd>
1869
1870                                 </dl>
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882                     </div>
1883                 </div>
1884
1885             </td>
1886             <td class="msource">
1887
1888                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1889                 &nbsp;
1890             </td>
1891         </tr>
1892
1893
1894     </table>
1895
1896
1897   <!-- ============================== events summary / details ======================== -->
1898
1899
1900   <a id="Roo.ReaderLayout-events"></a>
1901
1902
1903
1904
1905
1906
1907
1908
1909       <table cellspacing="0" class="member-table">
1910                 <caption>Events</caption>
1911               <thead>
1912                 <tr>
1913                     <th class="sig-header" colspan="2">Event</th>
1914                     <th class="msource-header">Defined By</th>
1915
1916                 </tr>
1917               </thead>
1918
1919
1920
1921
1922
1923           <tr class="method-row expandable config-row-alt0">
1924             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1925
1926             <td class="sig">
1927                 <a id="Roo.LayoutManager-event-*layout"></a>
1928
1929                <div class="fixedFont">
1930                 <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>)
1931
1932                 </div>
1933
1934                 <div class="mdesc">
1935
1936                    <div class="short">Fires when a layout is performed.
1937
1938                 </div>
1939
1940                     <div class="long">
1941
1942                         Fires when a layout is performed.
1943
1944
1945
1946
1947
1948                                 <dl class="detailList">
1949                                 <dt class="heading">Parameters:</dt>
1950
1951                                         <dt>
1952                                                 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
1953
1954                                         </dt>
1955                                         <dd></dd>
1956
1957                                 </dl>
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969                     </div>
1970                 </div>
1971
1972             </td>
1973             <td class="msource">
1974                 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1975             </td>
1976         </tr>
1977
1978           <tr class="method-row expandable config-row-alt1">
1979             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1980
1981             <td class="sig">
1982                 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
1983
1984                <div class="fixedFont">
1985                 <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>)
1986
1987                 </div>
1988
1989                 <div class="mdesc">
1990
1991                    <div class="short">Fires when a region is collapsed.
1992
1993                 </div>
1994
1995                     <div class="long">
1996
1997                         Fires when a region is collapsed.
1998
1999
2000
2001
2002
2003                                 <dl class="detailList">
2004                                 <dt class="heading">Parameters:</dt>
2005
2006                                         <dt>
2007                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2008
2009                                         </dt>
2010                                         <dd>The collapsed region</dd>
2011
2012                                 </dl>
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024                     </div>
2025                 </div>
2026
2027             </td>
2028             <td class="msource">
2029                 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2030             </td>
2031         </tr>
2032
2033           <tr class="method-row expandable config-row-alt0">
2034             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2035
2036             <td class="sig">
2037                 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
2038
2039                <div class="fixedFont">
2040                 <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>)
2041
2042                 </div>
2043
2044                 <div class="mdesc">
2045
2046                    <div class="short">Fires when a region is expanded.
2047
2048                 </div>
2049
2050                     <div class="long">
2051
2052                         Fires when a region is expanded.
2053
2054
2055
2056
2057
2058                                 <dl class="detailList">
2059                                 <dt class="heading">Parameters:</dt>
2060
2061                                         <dt>
2062                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2063
2064                                         </dt>
2065                                         <dd>The expanded region</dd>
2066
2067                                 </dl>
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079                     </div>
2080                 </div>
2081
2082             </td>
2083             <td class="msource">
2084                 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2085             </td>
2086         </tr>
2087
2088           <tr class="method-row expandable config-row-alt1">
2089             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2090
2091             <td class="sig">
2092                 <a id="Roo.LayoutManager-event-*regionresized"></a>
2093
2094                <div class="fixedFont">
2095                 <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>)
2096
2097                 </div>
2098
2099                 <div class="mdesc">
2100
2101                    <div class="short">Fires when the user resizes a region.
2102
2103                 </div>
2104
2105                     <div class="long">
2106
2107                         Fires when the user resizes a region.
2108
2109
2110
2111
2112
2113                                 <dl class="detailList">
2114                                 <dt class="heading">Parameters:</dt>
2115
2116                                         <dt>
2117                                                 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2118
2119                                         </dt>
2120                                         <dd>The resized region</dd>
2121
2122                                         <dt>
2123                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2124
2125                                         </dt>
2126                                         <dd>The new size (width for east/west, height for north/south)</dd>
2127
2128                                 </dl>
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140                     </div>
2141                 </div>
2142
2143             </td>
2144             <td class="msource">
2145                 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2146             </td>
2147         </tr>
2148
2149
2150     </table>
2151
2152
2153
2154
2155
2156 <!-- ============================== footer ================================= -->
2157                 <div class="fineprint" style="clear:both">
2158
2159                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
2160                         Based on
2161                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
2162                 </div>
2163         </body>
2164 </html>