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