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.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.BorderLayout
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.BorderLayout
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_BorderLayout.js.html">Roo/BorderLayout.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">BorderLayout</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         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>
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.BorderLayout';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.BorderLayout.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.BorderLayout-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.BorderLayout-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.BorderLayout-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 expandable notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo-method-BorderLayout"   name=".BorderLayout"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">BorderLayout</b>
 183
 184                                  (<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>)
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.BorderLayout</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.BorderLayout
 200
 201
 202                                 <dl class="detailList">
 203                                 <dt class="heading">Parameters:</dt>
 204
 205                                         <dt>
 206                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
 207
 208                                         </dt>
 209                                         <dd>The container this layout is bound to</dd>
 210
 211                                         <dt>
 212                                                 <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>
 213
 214                                         </dt>
 215                                         <dd>Configuration options</dd>
 216
 217                                 </dl>
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229                     </div>
 230                 </div>
 231
 232             </td>
 233             <td class="msource">
 234                 &nbsp;
 235             </td>
 236         </tr>
 237
 238
 239           <tr class="method-row config-row-alt1 expandable notInherited">
 240             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 241
 242
 243             <td class="sig">
 244                 <a id="Roo.BorderLayout-method-create"   name=".create"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes">Roo.BorderLayout.</span><b class="itemname">create</b>
 247
 248                                  (<B><i>config</i></B>, <B><i>targetEl</i></B>)
 249
 250
 251
 252                 </div>
 253                 <div class="mdesc">
 254
 255                    <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>
 256
 257
 258
 259                     <div class="long">
 260
 261                                 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>
 262
 263
 264
 265
 266
 267
 268                                 <dl class="detailList">
 269                                 <dt class="heading">Parameters:</dt>
 270
 271                                         <dt>
 272                                                  <b>config</b>
 273
 274                                         </dt>
 275                                         <dd></dd>
 276
 277                                         <dt>
 278                                                  <b>targetEl</b>
 279
 280                                         </dt>
 281                                         <dd></dd>
 282
 283                                 </dl>
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295                     </div>
 296                 </div>
 297
 298             </td>
 299             <td class="msource">
 300
 301                         Roo.BorderLayout
 302                 &nbsp;
 303             </td>
 304         </tr>
 305
 306
 307           <tr class="method-row config-row-alt0 expandable notInherited">
 308             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309
 310
 311             <td class="sig">
 312                 <a id="Roo.BorderLayout-method-add"   name=".add"></a>
 313                 <div class="fixedFont">
 314                         <span class="attributes"></span><b class="itemname">add</b>
 315
 316                                  (<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>)
 317
 318
 319                                          :
 320
 321
 322                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 323
 324
 325
 326
 327
 328                 </div>
 329                 <div class="mdesc">
 330
 331                    <div class="short">Adds a ContentPanel (or subclass) to this layout.</div>
 332
 333
 334
 335                     <div class="long">
 336
 337                                 Adds a ContentPanel (or subclass) to this layout.
 338
 339
 340
 341
 342
 343
 344                                 <dl class="detailList">
 345                                 <dt class="heading">Parameters:</dt>
 346
 347                                         <dt>
 348                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 349
 350                                         </dt>
 351                                         <dd>The target region key (north, south, east, west or center).</dd>
 352
 353                                         <dt>
 354                                                 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  <b>panel</b>
 355
 356                                         </dt>
 357                                         <dd>The panel to add</dd>
 358
 359                                 </dl>
 360
 361
 362
 363
 364
 365                                 <dl class="detailList">
 366                                 <dt class="heading">Returns:</dt>
 367
 368                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The added panel</dd>
 369
 370                                 </dl>
 371
 372
 373
 374
 375
 376
 377
 378                     </div>
 379                 </div>
 380
 381             </td>
 382             <td class="msource">
 383
 384                         Roo.BorderLayout
 385                 &nbsp;
 386             </td>
 387         </tr>
 388
 389
 390           <tr class="method-row config-row-alt1 expandable notInherited">
 391             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 392
 393
 394             <td class="sig">
 395                 <a id="Roo.BorderLayout-method-addRegion"   name=".addRegion"></a>
 396                 <div class="fixedFont">
 397                         <span class="attributes"></span><b class="itemname">addRegion</b>
 398
 399                                  (<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>)
 400
 401
 402                                          :
 403
 404
 405                                                 BorderLayoutRegion
 406
 407
 408
 409
 410
 411                 </div>
 412                 <div class="mdesc">
 413
 414                    <div class="short">Creates and adds a new region if it doesn't already exist.</div>
 415
 416
 417
 418                     <div class="long">
 419
 420                                 Creates and adds a new region if it doesn't already exist.
 421
 422
 423
 424
 425
 426
 427                                 <dl class="detailList">
 428                                 <dt class="heading">Parameters:</dt>
 429
 430                                         <dt>
 431                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 432
 433                                         </dt>
 434                                         <dd>The target region key (north, south, east, west or center).</dd>
 435
 436                                         <dt>
 437                                                 <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>
 438
 439                                         </dt>
 440                                         <dd>The regions config object</dd>
 441
 442                                 </dl>
 443
 444
 445
 446
 447
 448                                 <dl class="detailList">
 449                                 <dt class="heading">Returns:</dt>
 450
 451                                         <dd><span class="fixedFont">BorderLayoutRegion</span>  The new region</dd>
 452
 453                                 </dl>
 454
 455
 456
 457
 458
 459
 460
 461                     </div>
 462                 </div>
 463
 464             </td>
 465             <td class="msource">
 466
 467                         Roo.BorderLayout
 468                 &nbsp;
 469             </td>
 470         </tr>
 471
 472
 473           <tr class="method-row config-row-alt0 expandable notInherited">
 474             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 475
 476
 477             <td class="sig">
 478                 <a id="Roo.BorderLayout-method-addxtype"   name=".addxtype"></a>
 479                 <div class="fixedFont">
 480                         <span class="attributes"></span><b class="itemname">addxtype</b>
 481
 482                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
 483
 484
 485
 486                 </div>
 487                 <div class="mdesc">
 488
 489                    <div class="short">Adds a xtype elements to the layout.</div>
 490
 491
 492
 493                     <div class="long">
 494
 495                                 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>
 496
 497
 498
 499
 500
 501
 502                                 <dl class="detailList">
 503                                 <dt class="heading">Parameters:</dt>
 504
 505                                         <dt>
 506                                                 <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>
 507
 508                                         </dt>
 509                                         <dd>Xtype definition of item to add.</dd>
 510
 511                                 </dl>
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523                     </div>
 524                 </div>
 525
 526             </td>
 527             <td class="msource">
 528
 529                         Roo.BorderLayout
 530                 &nbsp;
 531             </td>
 532         </tr>
 533
 534
 535           <tr class="method-row config-row-alt1 expandable notInherited">
 536             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 537
 538
 539             <td class="sig">
 540                 <a id="Roo.BorderLayout-method-batchAdd"   name=".batchAdd"></a>
 541                 <div class="fixedFont">
 542                         <span class="attributes"></span><b class="itemname">batchAdd</b>
 543
 544                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>regions</i></B>)
 545
 546
 547
 548                 </div>
 549                 <div class="mdesc">
 550
 551                    <div class="short">Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.</div>
 552
 553
 554
 555                     <div class="long">
 556
 557                                 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>
 558
 559
 560
 561
 562
 563
 564                                 <dl class="detailList">
 565                                 <dt class="heading">Parameters:</dt>
 566
 567                                         <dt>
 568                                                 <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>
 569
 570                                         </dt>
 571                                         <dd>An object containing ContentPanel configs by region name</dd>
 572
 573                                 </dl>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585                     </div>
 586                 </div>
 587
 588             </td>
 589             <td class="msource">
 590
 591                         Roo.BorderLayout
 592                 &nbsp;
 593             </td>
 594         </tr>
 595
 596
 597           <tr class="method-row config-row-alt0 expandable notInherited">
 598             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 599
 600
 601             <td class="sig">
 602                 <a id="Roo.BorderLayout-method-findPanel"   name=".findPanel"></a>
 603                 <div class="fixedFont">
 604                         <span class="attributes"></span><b class="itemname">findPanel</b>
 605
 606                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>panelId</i></B>)
 607
 608
 609                                          :
 610
 611
 612                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 613
 614
 615
 616
 617
 618                 </div>
 619                 <div class="mdesc">
 620
 621                    <div class="short">Searches all regions for a panel with the specified id</div>
 622
 623
 624
 625                     <div class="long">
 626
 627                                 Searches all regions for a panel with the specified id
 628
 629
 630
 631
 632
 633
 634                                 <dl class="detailList">
 635                                 <dt class="heading">Parameters:</dt>
 636
 637                                         <dt>
 638                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>panelId</b>
 639
 640                                         </dt>
 641                                         <dd></dd>
 642
 643                                 </dl>
 644
 645
 646
 647
 648
 649                                 <dl class="detailList">
 650                                 <dt class="heading">Returns:</dt>
 651
 652                                         <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>
 653
 654                                 </dl>
 655
 656
 657
 658
 659
 660
 661
 662                     </div>
 663                 </div>
 664
 665             </td>
 666             <td class="msource">
 667
 668                         Roo.BorderLayout
 669                 &nbsp;
 670             </td>
 671         </tr>
 672
 673
 674           <tr class="method-row config-row-alt1 expandable notInherited">
 675             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 676
 677
 678             <td class="sig">
 679                 <a id="Roo.BorderLayout-method-layout"   name=".layout"></a>
 680                 <div class="fixedFont">
 681                         <span class="attributes"></span><b class="itemname">layout</b>
 682
 683                                  ()
 684
 685
 686
 687                 </div>
 688                 <div class="mdesc">
 689
 690                    <div class="short">Performs a layout update.</div>
 691
 692
 693
 694                     <div class="long">
 695
 696                                 Performs a layout update.
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713                     </div>
 714                 </div>
 715
 716             </td>
 717             <td class="msource">
 718
 719                         Roo.BorderLayout
 720                 &nbsp;
 721             </td>
 722         </tr>
 723
 724
 725           <tr class="method-row config-row-alt0 expandable notInherited">
 726             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 727
 728
 729             <td class="sig">
 730                 <a id="Roo.BorderLayout-method-remove"   name=".remove"></a>
 731                 <div class="fixedFont">
 732                         <span class="attributes"></span><b class="itemname">remove</b>
 733
 734                                  (<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>)
 735
 736
 737                                          :
 738
 739
 740                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 741
 742
 743
 744
 745
 746                 </div>
 747                 <div class="mdesc">
 748
 749                    <div class="short">Remove a ContentPanel (or subclass) to this layout.</div>
 750
 751
 752
 753                     <div class="long">
 754
 755                                 Remove a ContentPanel (or subclass) to this layout.
 756
 757
 758
 759
 760
 761
 762                                 <dl class="detailList">
 763                                 <dt class="heading">Parameters:</dt>
 764
 765                                         <dt>
 766                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>target</b>
 767
 768                                         </dt>
 769                                         <dd>The target region key (north, south, east, west or center).</dd>
 770
 771                                         <dt>
 772                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel</span>  <b>panel</b>
 773
 774                                         </dt>
 775                                         <dd>The index, id or panel to remove</dd>
 776
 777                                 </dl>
 778
 779
 780
 781
 782
 783                                 <dl class="detailList">
 784                                 <dt class="heading">Returns:</dt>
 785
 786                                         <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span>  The removed panel</dd>
 787
 788                                 </dl>
 789
 790
 791
 792
 793
 794
 795
 796                     </div>
 797                 </div>
 798
 799             </td>
 800             <td class="msource">
 801
 802                         Roo.BorderLayout
 803                 &nbsp;
 804             </td>
 805         </tr>
 806
 807
 808           <tr class="method-row config-row-alt1 expandable notInherited">
 809             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 810
 811
 812             <td class="sig">
 813                 <a id="Roo.BorderLayout-method-restoreState"   name=".restoreState"></a>
 814                 <div class="fixedFont">
 815                         <span class="attributes"></span><b class="itemname">restoreState</b>
 816
 817                                  (<a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a> <B><i>provider</i></B>)
 818
 819
 820
 821                 </div>
 822                 <div class="mdesc">
 823
 824                    <div class="short">Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.</div>
 825
 826
 827
 828                     <div class="long">
 829
 830                                 Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.
 831
 832
 833
 834
 835
 836
 837                                 <dl class="detailList">
 838                                 <dt class="heading">Parameters:</dt>
 839
 840                                         <dt>
 841                                                 <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>
 842
 843                                         </dt>
 844                                         <dd>(optional) An alternate state provider</dd>
 845
 846                                 </dl>
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858                     </div>
 859                 </div>
 860
 861             </td>
 862             <td class="msource">
 863
 864                         Roo.BorderLayout
 865                 &nbsp;
 866             </td>
 867         </tr>
 868
 869
 870           <tr class="method-row config-row-alt0 expandable notInherited">
 871             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 872
 873
 874             <td class="sig">
 875                 <a id="Roo.BorderLayout-method-showPanel"   name=".showPanel"></a>
 876                 <div class="fixedFont">
 877                         <span class="attributes"></span><b class="itemname">showPanel</b>
 878
 879                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel <B><i>panelId</i></B>)
 880
 881
 882                                          :
 883
 884
 885                                                 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
 886
 887
 888
 889
 890
 891                 </div>
 892                 <div class="mdesc">
 893
 894                    <div class="short">Searches all regions for a panel with the specified id and activates (shows) it.</div>
 895
 896
 897
 898                     <div class="long">
 899
 900                                 Searches all regions for a panel with the specified id and activates (shows) it.
 901
 902
 903
 904
 905
 906
 907                                 <dl class="detailList">
 908                                 <dt class="heading">Parameters:</dt>
 909
 910                                         <dt>
 911                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel</span>  <b>panelId</b>
 912
 913                                         </dt>
 914                                         <dd>The panels id or the panel itself</dd>
 915
 916                                 </dl>
 917
 918
 919
 920
 921
 922                                 <dl class="detailList">
 923                                 <dt class="heading">Returns:</dt>
 924
 925                                         <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>
 926
 927                                 </dl>
 928
 929
 930
 931
 932
 933
 934
 935                     </div>
 936                 </div>
 937
 938             </td>
 939             <td class="msource">
 940
 941                         Roo.BorderLayout
 942                 &nbsp;
 943             </td>
 944         </tr>
 945
 946
 947     </table>
 948
 949
 950   <!-- ============================== events summary / details ======================== -->
 951
 952
 953   <a id="Roo.BorderLayout-events"></a>
 954
 955
 956
 957
 958
 959      <table cellspacing="0" class="member-table">
 960       <caption class="Empty">Events - Has None</caption>
 961      </table>
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971 <!-- ============================== footer ================================= -->
 972                 <div class="fineprint" style="clear:both">
 973
 974                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:11:47 GMT+0800 (HKT)
 975                         Based on
 976                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 977                 </div>
 978         </body>
 979 </html>