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