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>
152 list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
162 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
178 <!-- ============================== public properties ==================== -->
182 <a id="Roo.BorderLayout-props"></a>
188 <table cellspacing="0" class="member-table">
189 <caption class="Empty">Public Properties - Has None</caption>
195 <!-- ============================== methods summary / details ======================== -->
198 <a id="Roo.BorderLayout-methods"></a>
199 <!-- constructor?? -->
206 <!-- then dynamics first -->
213 <table cellspacing="0" class="member-table">
214 <caption>Public Methods</caption>
216 <th class="sig-header" colspan="2">Method</th>
217 <th class="msource-header">Defined By</th>
227 <tr class="method-row config-row-alt0 expandable notInherited">
228 <td class="micon"><a class="exi" href="#expand"> </a></td>
232 <a id="Roo-method-BorderLayout" name=".BorderLayout"></a>
233 <div class="fixedFont">
234 <span class="attributes">new <B>Roo.</B></span><b class="itemname">BorderLayout</b>
236 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
244 <div class="short">Create a new Roo.BorderLayout</div>
251 Create a new Roo.BorderLayout
254 <dl class="detailList">
255 <dt class="heading">Parameters:</dt>
258 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
261 <dd>The container this layout is bound to</dd>
264 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
267 <dd>Configuration options</dd>
291 <tr class="method-row config-row-alt1 expandable notInherited">
292 <td class="micon"><a class="exi" href="#expand"> </a></td>
296 <a id="Roo.BorderLayout-method-create" name=".create"></a>
297 <div class="fixedFont">
298 <span class="attributes">Roo.BorderLayout.</span><b class="itemname">create</b>
300 (<B><i>config</i></B>, <B><i>targetEl</i></B>)
307 <div class="short">Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling<br/>the beginUpdate and endUpdate calls internally.</div>
313 Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling<br/>the beginUpdate and endUpdate calls internally. The key to this method is the <b>panels</b> property that can be<br/>provided with each region config, which allows you to add ContentPanel configs in addition to the region configs<br/>during creation. The following code is equivalent to the constructor-based example at the beginning of this class:<br/><pre><code><br/>// shorthand<br/>var CP = Roo.ContentPanel;<br/><br/>var layout = Roo.BorderLayout.create({<br/> north: {<br/> initialSize: 25,<br/> titlebar: false,<br/> panels: [new CP("north", "North")]<br/> },<br/> west: {<br/> split:true,<br/> initialSize: 200,<br/> minSize: 175,<br/> maxSize: 400,<br/> titlebar: true,<br/> collapsible: true,<br/> panels: [new CP("west", {title: "West"})]<br/> },<br/> east: {<br/> split:true,<br/> initialSize: 202,<br/> minSize: 175,<br/> maxSize: 400,<br/> titlebar: true,<br/> collapsible: true,<br/> panels: [new CP("autoTabs", {title: "Auto Tabs", closable: true})]<br/> },<br/> south: {<br/> split:true,<br/> initialSize: 100,<br/> minSize: 100,<br/> maxSize: 200,<br/> titlebar: true,<br/> collapsible: true,<br/> panels: [new CP("south", {title: "South", closable: true})]<br/> },<br/> center: {<br/> titlebar: true,<br/> autoScroll:true,<br/> resizeTabs: true,<br/> minTabWidth: 50,<br/> preferredTabWidth: 150,<br/> panels: [<br/> new CP("center1", {title: "Close Me", closable: true}),<br/> new CP("center2", {title: "Center Panel", closable: false})<br/> ]<br/> }<br/>}, document.body);<br/><br/>layout.getRegion("center").showPanel("center1");<br/></code></pre>
320 <dl class="detailList">
321 <dt class="heading">Parameters:</dt>
359 <tr class="method-row config-row-alt0 expandable notInherited">
360 <td class="micon"><a class="exi" href="#expand"> </a></td>
364 <a id="Roo.BorderLayout-method-add" name=".add"></a>
365 <div class="fixedFont">
366 <span class="attributes"></span><b class="itemname">add</b>
368 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
374 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
383 <div class="short">Adds a ContentPanel (or subclass) to this layout.</div>
389 Adds a ContentPanel (or subclass) to this layout.
396 <dl class="detailList">
397 <dt class="heading">Parameters:</dt>
400 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
403 <dd>The target region key (north, south, east, west or center).</dd>
406 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
409 <dd>The panel to add</dd>
417 <dl class="detailList">
418 <dt class="heading">Returns:</dt>
420 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The added panel</dd>
442 <tr class="method-row config-row-alt1 expandable">
443 <td class="micon"><a class="exi" href="#expand"> </a></td>
447 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
448 <div class="fixedFont">
449 <span class="attributes"></span><b class="itemname">addEvents</b>
451 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
458 <div class="short">Used to define events on this Observable</div>
464 Used to define events on this Observable
471 <dl class="detailList">
472 <dt class="heading">Parameters:</dt>
475 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
478 <dd>The object with the events defined</dd>
498 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
504 <tr class="method-row config-row-alt0 expandable">
505 <td class="micon"><a class="exi" href="#expand"> </a></td>
509 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
510 <div class="fixedFont">
511 <span class="attributes"></span><b class="itemname">addListener</b>
513 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
520 <div class="short">Appends an event handler to this component</div>
526 Appends an event handler to this component
533 <dl class="detailList">
534 <dt class="heading">Parameters:</dt>
537 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
540 <dd>The type of event to listen for</dd>
543 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
546 <dd>The method the event invokes</dd>
549 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
552 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
555 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
558 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
578 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
584 <tr class="method-row config-row-alt1 expandable notInherited">
585 <td class="micon"><a class="exi" href="#expand"> </a></td>
589 <a id="Roo.BorderLayout-method-addRegion" name=".addRegion"></a>
590 <div class="fixedFont">
591 <span class="attributes"></span><b class="itemname">addRegion</b>
593 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
608 <div class="short">Creates and adds a new region if it doesn't already exist.</div>
614 Creates and adds a new region if it doesn't already exist.
621 <dl class="detailList">
622 <dt class="heading">Parameters:</dt>
625 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
628 <dd>The target region key (north, south, east, west or center).</dd>
631 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
634 <dd>The regions config object</dd>
642 <dl class="detailList">
643 <dt class="heading">Returns:</dt>
645 <dd><span class="fixedFont">BorderLayoutRegion</span> The new region</dd>
667 <tr class="method-row config-row-alt0 expandable notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
672 <a id="Roo.BorderLayout-method-addxtype" name=".addxtype"></a>
673 <div class="fixedFont">
674 <span class="attributes"></span><b class="itemname">addxtype</b>
676 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
683 <div class="short">Adds a xtype elements to the layout.</div>
689 Adds a xtype elements to the layout.<br/><pre><code><br/><br/>layout.addxtype({<br/> xtype : 'ContentPanel',<br/> region: 'west',<br/> items: [ .... ]<br/> }<br/>);<br/><br/>layout.addxtype({<br/> xtype : 'NestedLayoutPanel',<br/> region: 'west',<br/> layout: {<br/> center: { },<br/> west: { } <br/> },<br/> items : [ ... list of content panels or nested layout panels.. ]<br/> }<br/>);<br/></code></pre>
696 <dl class="detailList">
697 <dt class="heading">Parameters:</dt>
700 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>cfg</b>
703 <dd>Xtype definition of item to add.</dd>
729 <tr class="method-row config-row-alt1 expandable notInherited">
730 <td class="micon"><a class="exi" href="#expand"> </a></td>
734 <a id="Roo.BorderLayout-method-batchAdd" name=".batchAdd"></a>
735 <div class="fixedFont">
736 <span class="attributes"></span><b class="itemname">batchAdd</b>
738 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>regions</i></B>)
745 <div class="short">Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.</div>
751 Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config<br/>object should contain properties for each region to add ContentPanels to, and each property's value should be<br/>a valid ContentPanel config object. Example:<br/><pre><code><br/>// Create the main layout<br/>var layout = new Roo.BorderLayout('main-ct', {<br/> west: {<br/> split:true,<br/> minSize: 175,<br/> titlebar: true<br/> },<br/> center: {<br/> title:'Components'<br/> }<br/>}, 'main-ct');<br/><br/>// Create and add multiple ContentPanels at once via configs<br/>layout.batchAdd({<br/> west: {<br/> id: 'source-files',<br/> autoCreate:true,<br/> title:'Ext Source Files',<br/> autoScroll:true,<br/> fitToFrame:true<br/> },<br/> center : {<br/> el: cview,<br/> autoScroll:true,<br/> fitToFrame:true,<br/> toolbar: tb,<br/> resizeEl:'cbody'<br/> }<br/>});<br/></code></pre>
758 <dl class="detailList">
759 <dt class="heading">Parameters:</dt>
762 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>regions</b>
765 <dd>An object containing ContentPanel configs by region name</dd>
791 <tr class="method-row config-row-alt0 expandable">
792 <td class="micon"><a class="exi" href="#expand"> </a></td>
796 <a id="Roo.LayoutManager-method-beginUpdate" name=".beginUpdate"></a>
797 <div class="fixedFont">
798 <span class="attributes"></span><b class="itemname">beginUpdate</b>
807 <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
813 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
836 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
842 <tr class="method-row config-row-alt1 expandable">
843 <td class="micon"><a class="exi" href="#expand"> </a></td>
847 <a id="Roo.LayoutManager-method-endUpdate" name=".endUpdate"></a>
848 <div class="fixedFont">
849 <span class="attributes"></span><b class="itemname">endUpdate</b>
851 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
858 <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
864 Restore auto-layouts and optionally disable the manager from performing a layout
871 <dl class="detailList">
872 <dt class="heading">Parameters:</dt>
875 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>noLayout</b>
878 <dd>true to disable a layout update</dd>
898 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
904 <tr class="method-row config-row-alt0 expandable notInherited">
905 <td class="micon"><a class="exi" href="#expand"> </a></td>
909 <a id="Roo.BorderLayout-method-findPanel" name=".findPanel"></a>
910 <div class="fixedFont">
911 <span class="attributes"></span><b class="itemname">findPanel</b>
913 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>panelId</i></B>)
919 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
928 <div class="short">Searches all regions for a panel with the specified id</div>
934 Searches all regions for a panel with the specified id
941 <dl class="detailList">
942 <dt class="heading">Parameters:</dt>
945 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>panelId</b>
956 <dl class="detailList">
957 <dt class="heading">Returns:</dt>
959 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The panel or null if it wasn't found</dd>
981 <tr class="method-row config-row-alt1 expandable">
982 <td class="micon"><a class="exi" href="#expand"> </a></td>
986 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
987 <div class="fixedFont">
988 <span class="attributes"></span><b class="itemname">fireEvent</b>
990 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
996 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1005 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1011 Fires the specified event with the passed parameters (minus the event name).
1018 <dl class="detailList">
1019 <dt class="heading">Parameters:</dt>
1022 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1028 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1031 <dd>Variable number of parameters are passed to handlers</dd>
1039 <dl class="detailList">
1040 <dt class="heading">Returns:</dt>
1042 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1056 <td class="msource">
1058 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1064 <tr class="method-row config-row-alt0 expandable">
1065 <td class="micon"><a class="exi" href="#expand"> </a></td>
1069 <a id="Roo.LayoutManager-method-getEl" name=".getEl"></a>
1070 <div class="fixedFont">
1071 <span class="attributes"></span><b class="itemname">getEl</b>
1079 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1088 <div class="short">Returns the Element this layout is bound to.</div>
1094 Returns the Element this layout is bound to.
1105 <dl class="detailList">
1106 <dt class="heading">Returns:</dt>
1108 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1122 <td class="msource">
1124 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1130 <tr class="method-row config-row-alt1 expandable">
1131 <td class="micon"><a class="exi" href="#expand"> </a></td>
1135 <a id="Roo.LayoutManager-method-getRegion" name=".getRegion"></a>
1136 <div class="fixedFont">
1137 <span class="attributes"></span><b class="itemname">getRegion</b>
1139 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
1145 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
1154 <div class="short">Returns the specified region.</div>
1160 Returns the specified region.
1167 <dl class="detailList">
1168 <dt class="heading">Parameters:</dt>
1171 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1174 <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
1182 <dl class="detailList">
1183 <dt class="heading">Returns:</dt>
1185 <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> </dd>
1199 <td class="msource">
1201 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1207 <tr class="method-row config-row-alt0 expandable">
1208 <td class="micon"><a class="exi" href="#expand"> </a></td>
1212 <a id="Roo.LayoutManager-method-getViewSize" name=".getViewSize"></a>
1213 <div class="fixedFont">
1214 <span class="attributes"></span><b class="itemname">getViewSize</b>
1222 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1231 <div class="short">Returns the size of the current view.</div>
1237 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
1248 <dl class="detailList">
1249 <dt class="heading">Returns:</dt>
1251 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> The size as an object {width: (the width), height: (the height)}</dd>
1265 <td class="msource">
1267 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1273 <tr class="method-row config-row-alt1 expandable">
1274 <td class="micon"><a class="exi" href="#expand"> </a></td>
1278 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1279 <div class="fixedFont">
1280 <span class="attributes"></span><b class="itemname">hasListener</b>
1282 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1288 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1297 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1303 Checks to see if this object has any listeners for a specified event
1310 <dl class="detailList">
1311 <dt class="heading">Parameters:</dt>
1314 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1317 <dd>The name of the event to check for</dd>
1325 <dl class="detailList">
1326 <dt class="heading">Returns:</dt>
1328 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1342 <td class="msource">
1344 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1350 <tr class="method-row config-row-alt0 expandable">
1351 <td class="micon"><a class="exi" href="#expand"> </a></td>
1355 <a id="Roo.LayoutManager-method-isUpdating" name=".isUpdating"></a>
1356 <div class="fixedFont">
1357 <span class="attributes"></span><b class="itemname">isUpdating</b>
1365 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1374 <div class="short">Returns true if this layout is currently being updated</div>
1380 Returns true if this layout is currently being updated
1391 <dl class="detailList">
1392 <dt class="heading">Returns:</dt>
1394 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1408 <td class="msource">
1410 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1416 <tr class="method-row config-row-alt1 expandable notInherited">
1417 <td class="micon"><a class="exi" href="#expand"> </a></td>
1421 <a id="Roo.BorderLayout-method-layout" name=".layout"></a>
1422 <div class="fixedFont">
1423 <span class="attributes"></span><b class="itemname">layout</b>
1432 <div class="short">Performs a layout update.</div>
1438 Performs a layout update.
1459 <td class="msource">
1467 <tr class="method-row config-row-alt0 expandable">
1468 <td class="micon"><a class="exi" href="#expand"> </a></td>
1472 <a id="Roo.util.Observable-method-on" name=".on"></a>
1473 <div class="fixedFont">
1474 <span class="attributes"></span><b class="itemname">on</b>
1476 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1483 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1489 Appends an event handler to this element (shorthand for addListener)
1496 <dl class="detailList">
1497 <dt class="heading">Parameters:</dt>
1500 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1503 <dd>The type of event to listen for</dd>
1506 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1509 <dd>The method the event invokes</dd>
1512 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1515 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1518 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1539 <td class="msource">
1541 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1547 <tr class="method-row config-row-alt1 expandable">
1548 <td class="micon"><a class="exi" href="#expand"> </a></td>
1552 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1553 <div class="fixedFont">
1554 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1563 <div class="short">Removes all listeners for this object</div>
1569 Removes all listeners for this object
1590 <td class="msource">
1592 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1598 <tr class="method-row config-row-alt0 expandable notInherited">
1599 <td class="micon"><a class="exi" href="#expand"> </a></td>
1603 <a id="Roo.BorderLayout-method-remove" name=".remove"></a>
1604 <div class="fixedFont">
1605 <span class="attributes"></span><b class="itemname">remove</b>
1607 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel <B><i>panel</i></B>)
1613 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1622 <div class="short">Remove a ContentPanel (or subclass) to this layout.</div>
1628 Remove a ContentPanel (or subclass) to this layout.
1635 <dl class="detailList">
1636 <dt class="heading">Parameters:</dt>
1639 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1642 <dd>The target region key (north, south, east, west or center).</dd>
1645 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel</span> <b>panel</b>
1648 <dd>The index, id or panel to remove</dd>
1656 <dl class="detailList">
1657 <dt class="heading">Returns:</dt>
1659 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The removed panel</dd>
1673 <td class="msource">
1681 <tr class="method-row config-row-alt1 expandable">
1682 <td class="micon"><a class="exi" href="#expand"> </a></td>
1686 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1687 <div class="fixedFont">
1688 <span class="attributes"></span><b class="itemname">removeListener</b>
1690 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1697 <div class="short">Removes a listener</div>
1710 <dl class="detailList">
1711 <dt class="heading">Parameters:</dt>
1714 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1717 <dd>The type of event to listen for</dd>
1720 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1723 <dd>The handler to remove</dd>
1726 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1729 <dd>(optional) The scope (this object) for the handler</dd>
1747 <td class="msource">
1749 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1755 <tr class="method-row config-row-alt0 expandable notInherited">
1756 <td class="micon"><a class="exi" href="#expand"> </a></td>
1760 <a id="Roo.BorderLayout-method-restoreState" name=".restoreState"></a>
1761 <div class="fixedFont">
1762 <span class="attributes"></span><b class="itemname">restoreState</b>
1764 (<a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a> <B><i>provider</i></B>)
1771 <div class="short">Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.</div>
1777 Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.
1784 <dl class="detailList">
1785 <dt class="heading">Parameters:</dt>
1788 <span class="fixedFont"><a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a></span> <b>provider</b>
1791 <dd>(optional) An alternate state provider</dd>
1809 <td class="msource">
1817 <tr class="method-row config-row-alt1 expandable notInherited">
1818 <td class="micon"><a class="exi" href="#expand"> </a></td>
1822 <a id="Roo.BorderLayout-method-showPanel" name=".showPanel"></a>
1823 <div class="fixedFont">
1824 <span class="attributes"></span><b class="itemname">showPanel</b>
1826 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel <B><i>panelId</i></B>)
1832 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1841 <div class="short">Searches all regions for a panel with the specified id and activates (shows) it.</div>
1847 Searches all regions for a panel with the specified id and activates (shows) it.
1854 <dl class="detailList">
1855 <dt class="heading">Parameters:</dt>
1858 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel</span> <b>panelId</b>
1861 <dd>The panels id or the panel itself</dd>
1869 <dl class="detailList">
1870 <dt class="heading">Returns:</dt>
1872 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The shown panel or null</dd>
1886 <td class="msource">
1894 <tr class="method-row config-row-alt0 expandable">
1895 <td class="micon"><a class="exi" href="#expand"> </a></td>
1899 <a id="Roo.util.Observable-method-un" name=".un"></a>
1900 <div class="fixedFont">
1901 <span class="attributes"></span><b class="itemname">un</b>
1903 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1910 <div class="short">Removes a listener (shorthand for removeListener)</div>
1916 Removes a listener (shorthand for removeListener)
1923 <dl class="detailList">
1924 <dt class="heading">Parameters:</dt>
1927 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1930 <dd>The type of event to listen for</dd>
1933 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1936 <dd>The handler to remove</dd>
1939 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1942 <dd>(optional) The scope (this object) for the handler</dd>
1960 <td class="msource">
1962 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1971 <!-- ============================== events summary / details ======================== -->
1974 <a id="Roo.BorderLayout-events"></a>
1983 <table cellspacing="0" class="member-table">
1984 <caption>Events</caption>
1987 <th class="sig-header" colspan="2">Event</th>
1988 <th class="msource-header">Defined By</th>
1997 <tr class="method-row expandable config-row-alt0">
1998 <td class="micon"><a class="exi" href="#expand"> </a></td>
2001 <a id="Roo.LayoutManager-event-*layout"></a>
2003 <div class="fixedFont">
2004 <b class="itemname">layout</b> (<a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a> <B><i>this</i></B>)
2010 <div class="short">Fires when a layout is performed.
2016 Fires when a layout is performed.
2022 <dl class="detailList">
2023 <dt class="heading">Parameters:</dt>
2026 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
2047 <td class="msource">
2048 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2052 <tr class="method-row expandable config-row-alt1">
2053 <td class="micon"><a class="exi" href="#expand"> </a></td>
2056 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
2058 <div class="fixedFont">
2059 <b class="itemname">regioncollapsed</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>)
2065 <div class="short">Fires when a region is collapsed.
2071 Fires when a region is collapsed.
2077 <dl class="detailList">
2078 <dt class="heading">Parameters:</dt>
2081 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2084 <dd>The collapsed region</dd>
2102 <td class="msource">
2103 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2107 <tr class="method-row expandable config-row-alt0">
2108 <td class="micon"><a class="exi" href="#expand"> </a></td>
2111 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
2113 <div class="fixedFont">
2114 <b class="itemname">regionexpanded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>)
2120 <div class="short">Fires when a region is expanded.
2126 Fires when a region is expanded.
2132 <dl class="detailList">
2133 <dt class="heading">Parameters:</dt>
2136 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2139 <dd>The expanded region</dd>
2157 <td class="msource">
2158 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2162 <tr class="method-row expandable config-row-alt1">
2163 <td class="micon"><a class="exi" href="#expand"> </a></td>
2166 <a id="Roo.LayoutManager-event-*regionresized"></a>
2168 <div class="fixedFont">
2169 <b class="itemname">regionresized</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
2175 <div class="short">Fires when the user resizes a region.
2181 Fires when the user resizes a region.
2187 <dl class="detailList">
2188 <dt class="heading">Parameters:</dt>
2191 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2194 <dd>The resized region</dd>
2197 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2200 <dd>The new size (width for east/west, height for north/south)</dd>
2218 <td class="msource">
2219 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2230 <!-- ============================== footer ================================= -->
2231 <div class="fineprint" style="clear:both">
2233 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Sep 08 2016 17:35:59 GMT+0800 (HKT)
2235 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>