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