1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.BorderLayout</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
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
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
58 Class Roo.BorderLayout
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_BorderLayout.js.html">Roo/BorderLayout.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">BorderLayout</td></tr>
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>
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>
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>
97 <!-- ============================== Class comment block... ========================== -->
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>
103 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
104 src="/blog.php/GtkDjsComments/Roo.BorderLayout.html"></iframe>
109 <!-- ============================== config options ========================== -->
114 <div class="hr"></div>
115 <a id="Roo.BorderLayout-configs"></a>
121 <table cellspacing="0" class="member-table">
122 <caption>Config Options (Usually are also Properties)</caption>
126 <th class="sig-header" colspan="2">Options</th>
128 <th class="msource-header">Defined By</th>
135 <tr class="config-row expandable config-row-alt0">
136 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>
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>
159 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
175 <!-- ============================== public properties ==================== -->
179 <a id="Roo.BorderLayout-props"></a>
185 <table cellspacing="0" class="member-table">
186 <caption class="Empty">Public Properties - Has None</caption>
192 <!-- ============================== methods summary / details ======================== -->
195 <a id="Roo.BorderLayout-methods"></a>
196 <!-- constructor?? -->
203 <!-- then dynamics first -->
210 <table cellspacing="0" class="member-table">
211 <caption>Public Methods</caption>
213 <th class="sig-header" colspan="2">Method</th>
214 <th class="msource-header">Defined By</th>
224 <tr class="method-row config-row-alt0 expandable notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
241 <div class="short">Create a new Roo.BorderLayout</div>
248 Create a new Roo.BorderLayout
251 <dl class="detailList">
252 <dt class="heading">Parameters:</dt>
255 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
258 <dd>The container this layout is bound to</dd>
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>
264 <dd>Configuration options</dd>
288 <tr class="method-row config-row-alt1 expandable notInherited">
289 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
297 (<B><i>config</i></B>, <B><i>targetEl</i></B>)
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>
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>
317 <dl class="detailList">
318 <dt class="heading">Parameters:</dt>
356 <tr class="method-row config-row-alt0 expandable notInherited">
357 <td class="micon"><a class="exi" href="#expand"> </a></td>
361 <a id="Roo.BorderLayout-method-add" name=".add"></a>
362 <div class="fixedFont">
363 <span class="attributes"></span><b class="itemname">add</b>
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>)
371 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
380 <div class="short">Adds a ContentPanel (or subclass) to this layout.</div>
386 Adds a ContentPanel (or subclass) to this layout.
393 <dl class="detailList">
394 <dt class="heading">Parameters:</dt>
397 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
400 <dd>The target region key (north, south, east, west or center).</dd>
403 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
406 <dd>The panel to add</dd>
414 <dl class="detailList">
415 <dt class="heading">Returns:</dt>
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>
439 <tr class="method-row config-row-alt1 expandable">
440 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
448 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
455 <div class="short">Used to define events on this Observable</div>
461 Used to define events on this Observable
468 <dl class="detailList">
469 <dt class="heading">Parameters:</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>
475 <dd>The object with the events defined</dd>
495 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
501 <tr class="method-row config-row-alt0 expandable">
502 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
517 <div class="short">Appends an event handler to this component</div>
523 Appends an event handler to this component
530 <dl class="detailList">
531 <dt class="heading">Parameters:</dt>
534 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
537 <dd>The type of event to listen for</dd>
540 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
543 <dd>The method the event invokes</dd>
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>
549 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
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>
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>
575 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
581 <tr class="method-row config-row-alt1 expandable notInherited">
582 <td class="micon"><a class="exi" href="#expand"> </a></td>
586 <a id="Roo.BorderLayout-method-addRegion" name=".addRegion"></a>
587 <div class="fixedFont">
588 <span class="attributes"></span><b class="itemname">addRegion</b>
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>)
605 <div class="short">Creates and adds a new region if it doesn't already exist.</div>
611 Creates and adds a new region if it doesn't already exist.
618 <dl class="detailList">
619 <dt class="heading">Parameters:</dt>
622 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
625 <dd>The target region key (north, south, east, west or center).</dd>
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>
631 <dd>The regions config object</dd>
639 <dl class="detailList">
640 <dt class="heading">Returns:</dt>
642 <dd><span class="fixedFont">BorderLayoutRegion</span> The new region</dd>
664 <tr class="method-row config-row-alt0 expandable notInherited">
665 <td class="micon"><a class="exi" href="#expand"> </a></td>
669 <a id="Roo.BorderLayout-method-addxtype" name=".addxtype"></a>
670 <div class="fixedFont">
671 <span class="attributes"></span><b class="itemname">addxtype</b>
673 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
680 <div class="short">Adds a xtype elements to the layout.</div>
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>
693 <dl class="detailList">
694 <dt class="heading">Parameters:</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>
700 <dd>Xtype definition of item to add.</dd>
726 <tr class="method-row config-row-alt1 expandable notInherited">
727 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.BorderLayout-method-batchAdd" name=".batchAdd"></a>
732 <div class="fixedFont">
733 <span class="attributes"></span><b class="itemname">batchAdd</b>
735 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>regions</i></B>)
742 <div class="short">Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.</div>
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>
755 <dl class="detailList">
756 <dt class="heading">Parameters:</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>
762 <dd>An object containing ContentPanel configs by region name</dd>
788 <tr class="method-row config-row-alt0 expandable">
789 <td class="micon"><a class="exi" href="#expand"> </a></td>
793 <a id="Roo.LayoutManager-method-beginUpdate" name=".beginUpdate"></a>
794 <div class="fixedFont">
795 <span class="attributes"></span><b class="itemname">beginUpdate</b>
804 <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
810 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
833 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
839 <tr class="method-row config-row-alt1 expandable">
840 <td class="micon"><a class="exi" href="#expand"> </a></td>
844 <a id="Roo.LayoutManager-method-endUpdate" name=".endUpdate"></a>
845 <div class="fixedFont">
846 <span class="attributes"></span><b class="itemname">endUpdate</b>
848 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
855 <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
861 Restore auto-layouts and optionally disable the manager from performing a layout
868 <dl class="detailList">
869 <dt class="heading">Parameters:</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>
875 <dd>true to disable a layout update</dd>
895 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
901 <tr class="method-row config-row-alt0 expandable notInherited">
902 <td class="micon"><a class="exi" href="#expand"> </a></td>
906 <a id="Roo.BorderLayout-method-findPanel" name=".findPanel"></a>
907 <div class="fixedFont">
908 <span class="attributes"></span><b class="itemname">findPanel</b>
910 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>panelId</i></B>)
916 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
925 <div class="short">Searches all regions for a panel with the specified id</div>
931 Searches all regions for a panel with the specified id
938 <dl class="detailList">
939 <dt class="heading">Parameters:</dt>
942 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>panelId</b>
953 <dl class="detailList">
954 <dt class="heading">Returns:</dt>
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>
978 <tr class="method-row config-row-alt1 expandable">
979 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
993 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1002 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1008 Fires the specified event with the passed parameters (minus the event name).
1015 <dl class="detailList">
1016 <dt class="heading">Parameters:</dt>
1019 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
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>
1028 <dd>Variable number of parameters are passed to handlers</dd>
1036 <dl class="detailList">
1037 <dt class="heading">Returns:</dt>
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>
1053 <td class="msource">
1055 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1061 <tr class="method-row config-row-alt0 expandable">
1062 <td class="micon"><a class="exi" href="#expand"> </a></td>
1066 <a id="Roo.LayoutManager-method-getEl" name=".getEl"></a>
1067 <div class="fixedFont">
1068 <span class="attributes"></span><b class="itemname">getEl</b>
1076 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1085 <div class="short">Returns the Element this layout is bound to.</div>
1091 Returns the Element this layout is bound to.
1102 <dl class="detailList">
1103 <dt class="heading">Returns:</dt>
1105 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1119 <td class="msource">
1121 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1127 <tr class="method-row config-row-alt1 expandable">
1128 <td class="micon"><a class="exi" href="#expand"> </a></td>
1132 <a id="Roo.LayoutManager-method-getRegion" name=".getRegion"></a>
1133 <div class="fixedFont">
1134 <span class="attributes"></span><b class="itemname">getRegion</b>
1136 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
1142 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
1151 <div class="short">Returns the specified region.</div>
1157 Returns the specified region.
1164 <dl class="detailList">
1165 <dt class="heading">Parameters:</dt>
1168 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1171 <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
1179 <dl class="detailList">
1180 <dt class="heading">Returns:</dt>
1182 <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> </dd>
1196 <td class="msource">
1198 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1204 <tr class="method-row config-row-alt0 expandable">
1205 <td class="micon"><a class="exi" href="#expand"> </a></td>
1209 <a id="Roo.LayoutManager-method-getViewSize" name=".getViewSize"></a>
1210 <div class="fixedFont">
1211 <span class="attributes"></span><b class="itemname">getViewSize</b>
1219 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1228 <div class="short">Returns the size of the current view.</div>
1234 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
1245 <dl class="detailList">
1246 <dt class="heading">Returns:</dt>
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>
1262 <td class="msource">
1264 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1270 <tr class="method-row config-row-alt1 expandable">
1271 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
1279 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1285 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1294 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1300 Checks to see if this object has any listeners for a specified event
1307 <dl class="detailList">
1308 <dt class="heading">Parameters:</dt>
1311 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1314 <dd>The name of the event to check for</dd>
1322 <dl class="detailList">
1323 <dt class="heading">Returns:</dt>
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>
1339 <td class="msource">
1341 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1347 <tr class="method-row config-row-alt0 expandable">
1348 <td class="micon"><a class="exi" href="#expand"> </a></td>
1352 <a id="Roo.LayoutManager-method-isUpdating" name=".isUpdating"></a>
1353 <div class="fixedFont">
1354 <span class="attributes"></span><b class="itemname">isUpdating</b>
1362 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1371 <div class="short">Returns true if this layout is currently being updated</div>
1377 Returns true if this layout is currently being updated
1388 <dl class="detailList">
1389 <dt class="heading">Returns:</dt>
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>
1405 <td class="msource">
1407 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1413 <tr class="method-row config-row-alt1 expandable notInherited">
1414 <td class="micon"><a class="exi" href="#expand"> </a></td>
1418 <a id="Roo.BorderLayout-method-layout" name=".layout"></a>
1419 <div class="fixedFont">
1420 <span class="attributes"></span><b class="itemname">layout</b>
1429 <div class="short">Performs a layout update.</div>
1435 Performs a layout update.
1456 <td class="msource">
1464 <tr class="method-row config-row-alt0 expandable">
1465 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
1480 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1486 Appends an event handler to this element (shorthand for addListener)
1493 <dl class="detailList">
1494 <dt class="heading">Parameters:</dt>
1497 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1500 <dd>The type of event to listen for</dd>
1503 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1506 <dd>The method the event invokes</dd>
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>
1512 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
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>
1536 <td class="msource">
1538 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1544 <tr class="method-row config-row-alt1 expandable">
1545 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
1560 <div class="short">Removes all listeners for this object</div>
1566 Removes all listeners for this object
1587 <td class="msource">
1589 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1595 <tr class="method-row config-row-alt0 expandable notInherited">
1596 <td class="micon"><a class="exi" href="#expand"> </a></td>
1600 <a id="Roo.BorderLayout-method-remove" name=".remove"></a>
1601 <div class="fixedFont">
1602 <span class="attributes"></span><b class="itemname">remove</b>
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>)
1610 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1619 <div class="short">Remove a ContentPanel (or subclass) to this layout.</div>
1625 Remove a ContentPanel (or subclass) to this layout.
1632 <dl class="detailList">
1633 <dt class="heading">Parameters:</dt>
1636 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1639 <dd>The target region key (north, south, east, west or center).</dd>
1642 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel</span> <b>panel</b>
1645 <dd>The index, id or panel to remove</dd>
1653 <dl class="detailList">
1654 <dt class="heading">Returns:</dt>
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>
1670 <td class="msource">
1678 <tr class="method-row config-row-alt1 expandable">
1679 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
1694 <div class="short">Removes a listener</div>
1707 <dl class="detailList">
1708 <dt class="heading">Parameters:</dt>
1711 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1714 <dd>The type of event to listen for</dd>
1717 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1720 <dd>The handler to remove</dd>
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>
1726 <dd>(optional) The scope (this object) for the handler</dd>
1744 <td class="msource">
1746 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1752 <tr class="method-row config-row-alt0 expandable notInherited">
1753 <td class="micon"><a class="exi" href="#expand"> </a></td>
1757 <a id="Roo.BorderLayout-method-restoreState" name=".restoreState"></a>
1758 <div class="fixedFont">
1759 <span class="attributes"></span><b class="itemname">restoreState</b>
1761 (<a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a> <B><i>provider</i></B>)
1768 <div class="short">Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.</div>
1774 Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.
1781 <dl class="detailList">
1782 <dt class="heading">Parameters:</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>
1788 <dd>(optional) An alternate state provider</dd>
1806 <td class="msource">
1814 <tr class="method-row config-row-alt1 expandable notInherited">
1815 <td class="micon"><a class="exi" href="#expand"> </a></td>
1819 <a id="Roo.BorderLayout-method-showPanel" name=".showPanel"></a>
1820 <div class="fixedFont">
1821 <span class="attributes"></span><b class="itemname">showPanel</b>
1823 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel <B><i>panelId</i></B>)
1829 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1838 <div class="short">Searches all regions for a panel with the specified id and activates (shows) it.</div>
1844 Searches all regions for a panel with the specified id and activates (shows) it.
1851 <dl class="detailList">
1852 <dt class="heading">Parameters:</dt>
1855 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel</span> <b>panelId</b>
1858 <dd>The panels id or the panel itself</dd>
1866 <dl class="detailList">
1867 <dt class="heading">Returns:</dt>
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>
1883 <td class="msource">
1891 <tr class="method-row config-row-alt0 expandable">
1892 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
1907 <div class="short">Removes a listener (shorthand for removeListener)</div>
1913 Removes a listener (shorthand for removeListener)
1920 <dl class="detailList">
1921 <dt class="heading">Parameters:</dt>
1924 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1927 <dd>The type of event to listen for</dd>
1930 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1933 <dd>The handler to remove</dd>
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>
1939 <dd>(optional) The scope (this object) for the handler</dd>
1957 <td class="msource">
1959 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1968 <!-- ============================== events summary / details ======================== -->
1971 <a id="Roo.BorderLayout-events"></a>
1980 <table cellspacing="0" class="member-table">
1981 <caption>Events</caption>
1984 <th class="sig-header" colspan="2">Event</th>
1985 <th class="msource-header">Defined By</th>
1994 <tr class="method-row expandable config-row-alt0">
1995 <td class="micon"><a class="exi" href="#expand"> </a></td>
1998 <a id="Roo.LayoutManager-event-*layout"></a>
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>)
2007 <div class="short">Fires when a layout is performed.
2013 Fires when a layout is performed.
2019 <dl class="detailList">
2020 <dt class="heading">Parameters:</dt>
2023 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
2044 <td class="msource">
2045 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2049 <tr class="method-row expandable config-row-alt1">
2050 <td class="micon"><a class="exi" href="#expand"> </a></td>
2053 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
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>)
2062 <div class="short">Fires when a region is collapsed.
2068 Fires when a region is collapsed.
2074 <dl class="detailList">
2075 <dt class="heading">Parameters:</dt>
2078 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2081 <dd>The collapsed region</dd>
2099 <td class="msource">
2100 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2104 <tr class="method-row expandable config-row-alt0">
2105 <td class="micon"><a class="exi" href="#expand"> </a></td>
2108 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
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>)
2117 <div class="short">Fires when a region is expanded.
2123 Fires when a region is expanded.
2129 <dl class="detailList">
2130 <dt class="heading">Parameters:</dt>
2133 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2136 <dd>The expanded region</dd>
2154 <td class="msource">
2155 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2159 <tr class="method-row expandable config-row-alt1">
2160 <td class="micon"><a class="exi" href="#expand"> </a></td>
2163 <a id="Roo.LayoutManager-event-*regionresized"></a>
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>)
2172 <div class="short">Fires when the user resizes a region.
2178 Fires when the user resizes a region.
2184 <dl class="detailList">
2185 <dt class="heading">Parameters:</dt>
2188 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2191 <dd>The resized region</dd>
2194 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2197 <dd>The new size (width for east/west, height for north/south)</dd>
2215 <td class="msource">
2216 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2227 <!-- ============================== footer ================================= -->
2228 <div class="fineprint" style="clear:both">
2230 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 24 2014 16:54:28 GMT+0800 (HKT)
2232 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>