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.ReaderLayout</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.ReaderLayout-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.ReaderLayout-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.ReaderLayout-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.ReaderLayout-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.ReaderLayout
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.ReaderLayout
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_ReaderLayout.js.html">Roo/ReaderLayout.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">ReaderLayout</td></tr>
76 <tr><td class="label">Extends:</td><td class="hd-info">
77 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
85 <!-- ============================== class summary ========================== -->
86 <div class="description">
87 This is a pre-built layout that represents a classic, 5-pane application. It consists of a header, a primary<br/>center region containing two nested regions (a top one for a list view and one for item preview below),<br/>and regions on either side that can be used for navigation, application commands, informational displays, etc.<br/>The setup and configuration work exactly the same as it does for a {<b>link</b> Roo.BorderLayout} - this class simply<br/>expedites the setup of the overall layout and regions for this common application style.<br/>Example:<br/> <pre><code><br/>var reader = new Roo.ReaderLayout();<br/>var CP = Roo.ContentPanel; // shortcut for adding<br/><br/>reader.beginUpdate();<br/>reader.add("north", new CP("north", "North"));<br/>reader.add("west", new CP("west", {title: "West"}));<br/>reader.add("east", new CP("east", {title: "East"}));<br/><br/>reader.regions.listView.add(new CP("listView", "List"));<br/>reader.regions.preview.add(new CP("preview", "Preview"));<br/>reader.endUpdate();<br/></code></pre>
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.ReaderLayout';">[Add Your comment/notes about this class]</u>
97 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
98 src="/blog.php/GtkDjsComments/Roo.ReaderLayout.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.ReaderLayout-configs"></a>
115 <table cellspacing="0" class="member-table">
116 <caption>Config Options (Usually are also Properties)</caption>
120 <th class="sig-header" colspan="2">Options</th>
122 <th class="msource-header">Defined By</th>
129 <tr class="config-row expandable config-row-alt0">
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
133 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
134 <div class="fixedFont">
135 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
141 <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>
146 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>
156 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
172 <!-- ============================== public properties ==================== -->
176 <a id="Roo.ReaderLayout-props"></a>
182 <table cellspacing="0" class="member-table">
183 <caption class="Empty">Public Properties - Has None</caption>
189 <!-- ============================== methods summary / details ======================== -->
192 <a id="Roo.ReaderLayout-methods"></a>
193 <!-- constructor?? -->
200 <!-- then dynamics first -->
207 <table cellspacing="0" class="member-table">
208 <caption>Public Methods</caption>
210 <th class="sig-header" colspan="2">Method</th>
211 <th class="msource-header">Defined By</th>
221 <tr class="method-row config-row-alt0 expandable notInherited">
222 <td class="micon"><a class="exi" href="#expand"> </a></td>
226 <a id="Roo-method-ReaderLayout" name=".ReaderLayout"></a>
227 <div class="fixedFont">
228 <span class="attributes">new <B>Roo.</B></span><b class="itemname">ReaderLayout</b>
230 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
238 <div class="short">Create a new Roo.ReaderLayout</div>
245 Create a new Roo.ReaderLayout
248 <dl class="detailList">
249 <dt class="heading">Parameters:</dt>
252 <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>
255 <dd>Configuration options</dd>
258 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
261 <dd>(optional) The container this layout is bound to (defaults to<br/>document.body if omitted)</dd>
285 <tr class="method-row config-row-alt1 expandable">
286 <td class="micon"><a class="exi" href="#expand"> </a></td>
290 <a id="Roo.BorderLayout-method-add" name=".add"></a>
291 <div class="fixedFont">
292 <span class="attributes"></span><b class="itemname">add</b>
294 (<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>)
300 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
309 <div class="short">Adds a ContentPanel (or subclass) to this layout.</div>
315 Adds a ContentPanel (or subclass) to this layout.
322 <dl class="detailList">
323 <dt class="heading">Parameters:</dt>
326 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
329 <dd>The target region key (north, south, east, west or center).</dd>
332 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
335 <dd>The panel to add</dd>
343 <dl class="detailList">
344 <dt class="heading">Returns:</dt>
346 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The added panel</dd>
362 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
368 <tr class="method-row config-row-alt0 expandable">
369 <td class="micon"><a class="exi" href="#expand"> </a></td>
373 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
374 <div class="fixedFont">
375 <span class="attributes"></span><b class="itemname">addEvents</b>
377 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
384 <div class="short">Used to define events on this Observable</div>
390 Used to define events on this Observable
397 <dl class="detailList">
398 <dt class="heading">Parameters:</dt>
401 <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>
404 <dd>The object with the events defined</dd>
424 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
430 <tr class="method-row config-row-alt1 expandable">
431 <td class="micon"><a class="exi" href="#expand"> </a></td>
435 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
436 <div class="fixedFont">
437 <span class="attributes"></span><b class="itemname">addListener</b>
439 (<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>)
446 <div class="short">Appends an event handler to this component</div>
452 Appends an event handler to this component
459 <dl class="detailList">
460 <dt class="heading">Parameters:</dt>
463 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
466 <dd>The type of event to listen for</dd>
469 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
472 <dd>The method the event invokes</dd>
475 <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>
478 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
481 <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>
484 <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>
504 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
510 <tr class="method-row config-row-alt0 expandable">
511 <td class="micon"><a class="exi" href="#expand"> </a></td>
515 <a id="Roo.BorderLayout-method-addRegion" name=".addRegion"></a>
516 <div class="fixedFont">
517 <span class="attributes"></span><b class="itemname">addRegion</b>
519 (<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>)
534 <div class="short">Creates and adds a new region if it doesn't already exist.</div>
540 Creates and adds a new region if it doesn't already exist.
547 <dl class="detailList">
548 <dt class="heading">Parameters:</dt>
551 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
554 <dd>The target region key (north, south, east, west or center).</dd>
557 <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>
560 <dd>The regions config object</dd>
568 <dl class="detailList">
569 <dt class="heading">Returns:</dt>
571 <dd><span class="fixedFont">BorderLayoutRegion</span> The new region</dd>
587 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
593 <tr class="method-row config-row-alt1 expandable">
594 <td class="micon"><a class="exi" href="#expand"> </a></td>
598 <a id="Roo.BorderLayout-method-addxtype" name=".addxtype"></a>
599 <div class="fixedFont">
600 <span class="attributes"></span><b class="itemname">addxtype</b>
602 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
609 <div class="short">Adds a xtype elements to the layout.</div>
615 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>
622 <dl class="detailList">
623 <dt class="heading">Parameters:</dt>
626 <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>
629 <dd>Xtype definition of item to add.</dd>
649 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
655 <tr class="method-row config-row-alt0 expandable">
656 <td class="micon"><a class="exi" href="#expand"> </a></td>
660 <a id="Roo.BorderLayout-method-batchAdd" name=".batchAdd"></a>
661 <div class="fixedFont">
662 <span class="attributes"></span><b class="itemname">batchAdd</b>
664 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>regions</i></B>)
671 <div class="short">Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.</div>
677 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>
684 <dl class="detailList">
685 <dt class="heading">Parameters:</dt>
688 <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>
691 <dd>An object containing ContentPanel configs by region name</dd>
711 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
717 <tr class="method-row config-row-alt1 expandable">
718 <td class="micon"><a class="exi" href="#expand"> </a></td>
722 <a id="Roo.LayoutManager-method-beginUpdate" name=".beginUpdate"></a>
723 <div class="fixedFont">
724 <span class="attributes"></span><b class="itemname">beginUpdate</b>
733 <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
739 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
762 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
768 <tr class="method-row config-row-alt0 expandable">
769 <td class="micon"><a class="exi" href="#expand"> </a></td>
773 <a id="Roo.LayoutManager-method-endUpdate" name=".endUpdate"></a>
774 <div class="fixedFont">
775 <span class="attributes"></span><b class="itemname">endUpdate</b>
777 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
784 <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
790 Restore auto-layouts and optionally disable the manager from performing a layout
797 <dl class="detailList">
798 <dt class="heading">Parameters:</dt>
801 <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>
804 <dd>true to disable a layout update</dd>
824 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
830 <tr class="method-row config-row-alt1 expandable">
831 <td class="micon"><a class="exi" href="#expand"> </a></td>
835 <a id="Roo.BorderLayout-method-findPanel" name=".findPanel"></a>
836 <div class="fixedFont">
837 <span class="attributes"></span><b class="itemname">findPanel</b>
839 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>panelId</i></B>)
845 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
854 <div class="short">Searches all regions for a panel with the specified id</div>
860 Searches all regions for a panel with the specified id
867 <dl class="detailList">
868 <dt class="heading">Parameters:</dt>
871 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>panelId</b>
882 <dl class="detailList">
883 <dt class="heading">Returns:</dt>
885 <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>
901 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
907 <tr class="method-row config-row-alt0 expandable">
908 <td class="micon"><a class="exi" href="#expand"> </a></td>
912 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
913 <div class="fixedFont">
914 <span class="attributes"></span><b class="itemname">fireEvent</b>
916 (<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>)
922 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
931 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
937 Fires the specified event with the passed parameters (minus the event name).
944 <dl class="detailList">
945 <dt class="heading">Parameters:</dt>
948 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
954 <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>
957 <dd>Variable number of parameters are passed to handlers</dd>
965 <dl class="detailList">
966 <dt class="heading">Returns:</dt>
968 <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>
984 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
990 <tr class="method-row config-row-alt1 expandable">
991 <td class="micon"><a class="exi" href="#expand"> </a></td>
995 <a id="Roo.LayoutManager-method-getEl" name=".getEl"></a>
996 <div class="fixedFont">
997 <span class="attributes"></span><b class="itemname">getEl</b>
1005 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1014 <div class="short">Returns the Element this layout is bound to.</div>
1020 Returns the Element this layout is bound to.
1031 <dl class="detailList">
1032 <dt class="heading">Returns:</dt>
1034 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1048 <td class="msource">
1050 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1056 <tr class="method-row config-row-alt0 expandable">
1057 <td class="micon"><a class="exi" href="#expand"> </a></td>
1061 <a id="Roo.LayoutManager-method-getRegion" name=".getRegion"></a>
1062 <div class="fixedFont">
1063 <span class="attributes"></span><b class="itemname">getRegion</b>
1065 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
1071 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
1080 <div class="short">Returns the specified region.</div>
1086 Returns the specified region.
1093 <dl class="detailList">
1094 <dt class="heading">Parameters:</dt>
1097 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1100 <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
1108 <dl class="detailList">
1109 <dt class="heading">Returns:</dt>
1111 <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> </dd>
1125 <td class="msource">
1127 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1133 <tr class="method-row config-row-alt1 expandable">
1134 <td class="micon"><a class="exi" href="#expand"> </a></td>
1138 <a id="Roo.LayoutManager-method-getViewSize" name=".getViewSize"></a>
1139 <div class="fixedFont">
1140 <span class="attributes"></span><b class="itemname">getViewSize</b>
1148 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1157 <div class="short">Returns the size of the current view.</div>
1163 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
1174 <dl class="detailList">
1175 <dt class="heading">Returns:</dt>
1177 <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>
1191 <td class="msource">
1193 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1199 <tr class="method-row config-row-alt0 expandable">
1200 <td class="micon"><a class="exi" href="#expand"> </a></td>
1204 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1205 <div class="fixedFont">
1206 <span class="attributes"></span><b class="itemname">hasListener</b>
1208 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1214 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1223 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1229 Checks to see if this object has any listeners for a specified event
1236 <dl class="detailList">
1237 <dt class="heading">Parameters:</dt>
1240 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1243 <dd>The name of the event to check for</dd>
1251 <dl class="detailList">
1252 <dt class="heading">Returns:</dt>
1254 <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>
1268 <td class="msource">
1270 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1276 <tr class="method-row config-row-alt1 expandable">
1277 <td class="micon"><a class="exi" href="#expand"> </a></td>
1281 <a id="Roo.LayoutManager-method-isUpdating" name=".isUpdating"></a>
1282 <div class="fixedFont">
1283 <span class="attributes"></span><b class="itemname">isUpdating</b>
1291 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1300 <div class="short">Returns true if this layout is currently being updated</div>
1306 Returns true if this layout is currently being updated
1317 <dl class="detailList">
1318 <dt class="heading">Returns:</dt>
1320 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1334 <td class="msource">
1336 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1342 <tr class="method-row config-row-alt0 expandable">
1343 <td class="micon"><a class="exi" href="#expand"> </a></td>
1347 <a id="Roo.BorderLayout-method-layout" name=".layout"></a>
1348 <div class="fixedFont">
1349 <span class="attributes"></span><b class="itemname">layout</b>
1358 <div class="short">Performs a layout update.</div>
1364 Performs a layout update.
1385 <td class="msource">
1387 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1393 <tr class="method-row config-row-alt1 expandable">
1394 <td class="micon"><a class="exi" href="#expand"> </a></td>
1398 <a id="Roo.util.Observable-method-on" name=".on"></a>
1399 <div class="fixedFont">
1400 <span class="attributes"></span><b class="itemname">on</b>
1402 (<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>)
1409 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1415 Appends an event handler to this element (shorthand for addListener)
1422 <dl class="detailList">
1423 <dt class="heading">Parameters:</dt>
1426 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1429 <dd>The type of event to listen for</dd>
1432 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1435 <dd>The method the event invokes</dd>
1438 <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>
1441 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1444 <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>
1465 <td class="msource">
1467 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1473 <tr class="method-row config-row-alt0 expandable">
1474 <td class="micon"><a class="exi" href="#expand"> </a></td>
1478 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1479 <div class="fixedFont">
1480 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1489 <div class="short">Removes all listeners for this object</div>
1495 Removes all listeners for this object
1516 <td class="msource">
1518 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1524 <tr class="method-row config-row-alt1 expandable">
1525 <td class="micon"><a class="exi" href="#expand"> </a></td>
1529 <a id="Roo.BorderLayout-method-remove" name=".remove"></a>
1530 <div class="fixedFont">
1531 <span class="attributes"></span><b class="itemname">remove</b>
1533 (<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>)
1539 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1548 <div class="short">Remove a ContentPanel (or subclass) to this layout.</div>
1554 Remove a ContentPanel (or subclass) to this layout.
1561 <dl class="detailList">
1562 <dt class="heading">Parameters:</dt>
1565 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1568 <dd>The target region key (north, south, east, west or center).</dd>
1571 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel</span> <b>panel</b>
1574 <dd>The index, id or panel to remove</dd>
1582 <dl class="detailList">
1583 <dt class="heading">Returns:</dt>
1585 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The removed panel</dd>
1599 <td class="msource">
1601 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1607 <tr class="method-row config-row-alt0 expandable">
1608 <td class="micon"><a class="exi" href="#expand"> </a></td>
1612 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1613 <div class="fixedFont">
1614 <span class="attributes"></span><b class="itemname">removeListener</b>
1616 (<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>)
1623 <div class="short">Removes a listener</div>
1636 <dl class="detailList">
1637 <dt class="heading">Parameters:</dt>
1640 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1643 <dd>The type of event to listen for</dd>
1646 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1649 <dd>The handler to remove</dd>
1652 <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>
1655 <dd>(optional) The scope (this object) for the handler</dd>
1673 <td class="msource">
1675 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1681 <tr class="method-row config-row-alt1 expandable">
1682 <td class="micon"><a class="exi" href="#expand"> </a></td>
1686 <a id="Roo.BorderLayout-method-restoreState" name=".restoreState"></a>
1687 <div class="fixedFont">
1688 <span class="attributes"></span><b class="itemname">restoreState</b>
1690 (<a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a> <B><i>provider</i></B>)
1697 <div class="short">Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.</div>
1703 Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.
1710 <dl class="detailList">
1711 <dt class="heading">Parameters:</dt>
1714 <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>
1717 <dd>(optional) An alternate state provider</dd>
1735 <td class="msource">
1737 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1743 <tr class="method-row config-row-alt0 expandable">
1744 <td class="micon"><a class="exi" href="#expand"> </a></td>
1748 <a id="Roo.BorderLayout-method-showPanel" name=".showPanel"></a>
1749 <div class="fixedFont">
1750 <span class="attributes"></span><b class="itemname">showPanel</b>
1752 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel <B><i>panelId</i></B>)
1758 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1767 <div class="short">Searches all regions for a panel with the specified id and activates (shows) it.</div>
1773 Searches all regions for a panel with the specified id and activates (shows) it.
1780 <dl class="detailList">
1781 <dt class="heading">Parameters:</dt>
1784 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel</span> <b>panelId</b>
1787 <dd>The panels id or the panel itself</dd>
1795 <dl class="detailList">
1796 <dt class="heading">Returns:</dt>
1798 <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>
1812 <td class="msource">
1814 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1820 <tr class="method-row config-row-alt1 expandable">
1821 <td class="micon"><a class="exi" href="#expand"> </a></td>
1825 <a id="Roo.util.Observable-method-un" name=".un"></a>
1826 <div class="fixedFont">
1827 <span class="attributes"></span><b class="itemname">un</b>
1829 (<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>)
1836 <div class="short">Removes a listener (shorthand for removeListener)</div>
1842 Removes a listener (shorthand for removeListener)
1849 <dl class="detailList">
1850 <dt class="heading">Parameters:</dt>
1853 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1856 <dd>The type of event to listen for</dd>
1859 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1862 <dd>The handler to remove</dd>
1865 <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>
1868 <dd>(optional) The scope (this object) for the handler</dd>
1886 <td class="msource">
1888 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1897 <!-- ============================== events summary / details ======================== -->
1900 <a id="Roo.ReaderLayout-events"></a>
1909 <table cellspacing="0" class="member-table">
1910 <caption>Events</caption>
1913 <th class="sig-header" colspan="2">Event</th>
1914 <th class="msource-header">Defined By</th>
1923 <tr class="method-row expandable config-row-alt0">
1924 <td class="micon"><a class="exi" href="#expand"> </a></td>
1927 <a id="Roo.LayoutManager-event-*layout"></a>
1929 <div class="fixedFont">
1930 <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>)
1936 <div class="short">Fires when a layout is performed.
1942 Fires when a layout is performed.
1948 <dl class="detailList">
1949 <dt class="heading">Parameters:</dt>
1952 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
1973 <td class="msource">
1974 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1978 <tr class="method-row expandable config-row-alt1">
1979 <td class="micon"><a class="exi" href="#expand"> </a></td>
1982 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
1984 <div class="fixedFont">
1985 <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>)
1991 <div class="short">Fires when a region is collapsed.
1997 Fires when a region is collapsed.
2003 <dl class="detailList">
2004 <dt class="heading">Parameters:</dt>
2007 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2010 <dd>The collapsed region</dd>
2028 <td class="msource">
2029 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2033 <tr class="method-row expandable config-row-alt0">
2034 <td class="micon"><a class="exi" href="#expand"> </a></td>
2037 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
2039 <div class="fixedFont">
2040 <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>)
2046 <div class="short">Fires when a region is expanded.
2052 Fires when a region is expanded.
2058 <dl class="detailList">
2059 <dt class="heading">Parameters:</dt>
2062 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2065 <dd>The expanded region</dd>
2083 <td class="msource">
2084 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2088 <tr class="method-row expandable config-row-alt1">
2089 <td class="micon"><a class="exi" href="#expand"> </a></td>
2092 <a id="Roo.LayoutManager-event-*regionresized"></a>
2094 <div class="fixedFont">
2095 <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>)
2101 <div class="short">Fires when the user resizes a region.
2107 Fires when the user resizes a region.
2113 <dl class="detailList">
2114 <dt class="heading">Parameters:</dt>
2117 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2120 <dd>The resized region</dd>
2123 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2126 <dd>The new size (width for east/west, height for north/south)</dd>
2144 <td class="msource">
2145 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2156 <!-- ============================== footer ================================= -->
2157 <div class="fineprint" style="clear:both">
2159 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
2161 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>