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>
145 <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>
153 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
169 <!-- ============================== public properties ==================== -->
173 <a id="Roo.ReaderLayout-props"></a>
179 <table cellspacing="0" class="member-table">
180 <caption class="Empty">Public Properties - Has None</caption>
186 <!-- ============================== methods summary / details ======================== -->
189 <a id="Roo.ReaderLayout-methods"></a>
190 <!-- constructor?? -->
197 <!-- then dynamics first -->
204 <table cellspacing="0" class="member-table">
205 <caption>Public Methods</caption>
207 <th class="sig-header" colspan="2">Method</th>
208 <th class="msource-header">Defined By</th>
218 <tr class="method-row config-row-alt0 expandable notInherited">
219 <td class="micon"><a class="exi" href="#expand"> </a></td>
223 <a id="Roo-method-ReaderLayout" name=".ReaderLayout"></a>
224 <div class="fixedFont">
225 <span class="attributes">new <B>Roo.</B></span><b class="itemname">ReaderLayout</b>
227 (<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>)
235 <div class="short">Create a new Roo.ReaderLayout</div>
242 Create a new Roo.ReaderLayout
245 <dl class="detailList">
246 <dt class="heading">Parameters:</dt>
249 <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>
252 <dd>Configuration options</dd>
255 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
258 <dd>(optional) The container this layout is bound to (defaults to<br/>document.body if omitted)</dd>
282 <tr class="method-row config-row-alt1 expandable">
283 <td class="micon"><a class="exi" href="#expand"> </a></td>
287 <a id="Roo.BorderLayout-method-add" name=".add"></a>
288 <div class="fixedFont">
289 <span class="attributes"></span><b class="itemname">add</b>
291 (<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>)
297 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
306 <div class="short">Adds a ContentPanel (or subclass) to this layout.</div>
312 Adds a ContentPanel (or subclass) to this layout.
319 <dl class="detailList">
320 <dt class="heading">Parameters:</dt>
323 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
326 <dd>The target region key (north, south, east, west or center).</dd>
329 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
332 <dd>The panel to add</dd>
340 <dl class="detailList">
341 <dt class="heading">Returns:</dt>
343 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The added panel</dd>
359 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
365 <tr class="method-row config-row-alt0 expandable">
366 <td class="micon"><a class="exi" href="#expand"> </a></td>
370 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
371 <div class="fixedFont">
372 <span class="attributes"></span><b class="itemname">addEvents</b>
374 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
381 <div class="short">Used to define events on this Observable</div>
387 Used to define events on this Observable
394 <dl class="detailList">
395 <dt class="heading">Parameters:</dt>
398 <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>
401 <dd>The object with the events defined</dd>
421 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
427 <tr class="method-row config-row-alt1 expandable">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
432 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
433 <div class="fixedFont">
434 <span class="attributes"></span><b class="itemname">addListener</b>
436 (<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>)
443 <div class="short">Appends an event handler to this component</div>
449 Appends an event handler to this component
456 <dl class="detailList">
457 <dt class="heading">Parameters:</dt>
460 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
463 <dd>The type of event to listen for</dd>
466 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
469 <dd>The method the event invokes</dd>
472 <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>
475 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
478 <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>
481 <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>
501 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
507 <tr class="method-row config-row-alt0 expandable">
508 <td class="micon"><a class="exi" href="#expand"> </a></td>
512 <a id="Roo.BorderLayout-method-addRegion" name=".addRegion"></a>
513 <div class="fixedFont">
514 <span class="attributes"></span><b class="itemname">addRegion</b>
516 (<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>)
531 <div class="short">Creates and adds a new region if it doesn't already exist.</div>
537 Creates and adds a new region if it doesn't already exist.
544 <dl class="detailList">
545 <dt class="heading">Parameters:</dt>
548 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
551 <dd>The target region key (north, south, east, west or center).</dd>
554 <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>
557 <dd>The regions config object</dd>
565 <dl class="detailList">
566 <dt class="heading">Returns:</dt>
568 <dd><span class="fixedFont">BorderLayoutRegion</span> The new region</dd>
584 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
590 <tr class="method-row config-row-alt1 expandable">
591 <td class="micon"><a class="exi" href="#expand"> </a></td>
595 <a id="Roo.BorderLayout-method-addxtype" name=".addxtype"></a>
596 <div class="fixedFont">
597 <span class="attributes"></span><b class="itemname">addxtype</b>
599 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
606 <div class="short">Adds a xtype elements to the layout.</div>
612 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>
619 <dl class="detailList">
620 <dt class="heading">Parameters:</dt>
623 <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>
626 <dd>Xtype definition of item to add.</dd>
646 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
652 <tr class="method-row config-row-alt0 expandable">
653 <td class="micon"><a class="exi" href="#expand"> </a></td>
657 <a id="Roo.BorderLayout-method-batchAdd" name=".batchAdd"></a>
658 <div class="fixedFont">
659 <span class="attributes"></span><b class="itemname">batchAdd</b>
661 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>regions</i></B>)
668 <div class="short">Adds a batch of multiple ContentPanels dynamically by passing a special regions config object.</div>
674 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>
681 <dl class="detailList">
682 <dt class="heading">Parameters:</dt>
685 <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>
688 <dd>An object containing ContentPanel configs by region name</dd>
708 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
714 <tr class="method-row config-row-alt1 expandable">
715 <td class="micon"><a class="exi" href="#expand"> </a></td>
719 <a id="Roo.LayoutManager-method-beginUpdate" name=".beginUpdate"></a>
720 <div class="fixedFont">
721 <span class="attributes"></span><b class="itemname">beginUpdate</b>
730 <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
736 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
759 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
765 <tr class="method-row config-row-alt0 expandable">
766 <td class="micon"><a class="exi" href="#expand"> </a></td>
770 <a id="Roo.LayoutManager-method-endUpdate" name=".endUpdate"></a>
771 <div class="fixedFont">
772 <span class="attributes"></span><b class="itemname">endUpdate</b>
774 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
781 <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
787 Restore auto-layouts and optionally disable the manager from performing a layout
794 <dl class="detailList">
795 <dt class="heading">Parameters:</dt>
798 <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>
801 <dd>true to disable a layout update</dd>
821 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
827 <tr class="method-row config-row-alt1 expandable">
828 <td class="micon"><a class="exi" href="#expand"> </a></td>
832 <a id="Roo.BorderLayout-method-findPanel" name=".findPanel"></a>
833 <div class="fixedFont">
834 <span class="attributes"></span><b class="itemname">findPanel</b>
836 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>panelId</i></B>)
842 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
851 <div class="short">Searches all regions for a panel with the specified id</div>
857 Searches all regions for a panel with the specified id
864 <dl class="detailList">
865 <dt class="heading">Parameters:</dt>
868 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>panelId</b>
879 <dl class="detailList">
880 <dt class="heading">Returns:</dt>
882 <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>
898 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
904 <tr class="method-row config-row-alt0 expandable">
905 <td class="micon"><a class="exi" href="#expand"> </a></td>
909 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
910 <div class="fixedFont">
911 <span class="attributes"></span><b class="itemname">fireEvent</b>
913 (<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>)
919 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
928 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
934 Fires the specified event with the passed parameters (minus the event name).
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>eventName</b>
951 <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>
954 <dd>Variable number of parameters are passed to handlers</dd>
962 <dl class="detailList">
963 <dt class="heading">Returns:</dt>
965 <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>
981 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
987 <tr class="method-row config-row-alt1 expandable">
988 <td class="micon"><a class="exi" href="#expand"> </a></td>
992 <a id="Roo.LayoutManager-method-getEl" name=".getEl"></a>
993 <div class="fixedFont">
994 <span class="attributes"></span><b class="itemname">getEl</b>
1002 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1011 <div class="short">Returns the Element this layout is bound to.</div>
1017 Returns the Element this layout is bound to.
1028 <dl class="detailList">
1029 <dt class="heading">Returns:</dt>
1031 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1045 <td class="msource">
1047 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1053 <tr class="method-row config-row-alt0 expandable">
1054 <td class="micon"><a class="exi" href="#expand"> </a></td>
1058 <a id="Roo.LayoutManager-method-getRegion" name=".getRegion"></a>
1059 <div class="fixedFont">
1060 <span class="attributes"></span><b class="itemname">getRegion</b>
1062 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
1068 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
1077 <div class="short">Returns the specified region.</div>
1083 Returns the specified region.
1090 <dl class="detailList">
1091 <dt class="heading">Parameters:</dt>
1094 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1097 <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
1105 <dl class="detailList">
1106 <dt class="heading">Returns:</dt>
1108 <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</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-getViewSize" name=".getViewSize"></a>
1136 <div class="fixedFont">
1137 <span class="attributes"></span><b class="itemname">getViewSize</b>
1145 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1154 <div class="short">Returns the size of the current view.</div>
1160 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
1171 <dl class="detailList">
1172 <dt class="heading">Returns:</dt>
1174 <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>
1188 <td class="msource">
1190 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1196 <tr class="method-row config-row-alt0 expandable">
1197 <td class="micon"><a class="exi" href="#expand"> </a></td>
1201 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1202 <div class="fixedFont">
1203 <span class="attributes"></span><b class="itemname">hasListener</b>
1205 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1211 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1220 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1226 Checks to see if this object has any listeners for a specified event
1233 <dl class="detailList">
1234 <dt class="heading">Parameters:</dt>
1237 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1240 <dd>The name of the event to check for</dd>
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:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1265 <td class="msource">
1267 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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.LayoutManager-method-isUpdating" name=".isUpdating"></a>
1279 <div class="fixedFont">
1280 <span class="attributes"></span><b class="itemname">isUpdating</b>
1288 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1297 <div class="short">Returns true if this layout is currently being updated</div>
1303 Returns true if this layout is currently being updated
1314 <dl class="detailList">
1315 <dt class="heading">Returns:</dt>
1317 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1331 <td class="msource">
1333 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1339 <tr class="method-row config-row-alt0 expandable">
1340 <td class="micon"><a class="exi" href="#expand"> </a></td>
1344 <a id="Roo.BorderLayout-method-layout" name=".layout"></a>
1345 <div class="fixedFont">
1346 <span class="attributes"></span><b class="itemname">layout</b>
1355 <div class="short">Performs a layout update.</div>
1361 Performs a layout update.
1382 <td class="msource">
1384 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1390 <tr class="method-row config-row-alt1 expandable">
1391 <td class="micon"><a class="exi" href="#expand"> </a></td>
1395 <a id="Roo.util.Observable-method-on" name=".on"></a>
1396 <div class="fixedFont">
1397 <span class="attributes"></span><b class="itemname">on</b>
1399 (<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>)
1406 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1412 Appends an event handler to this element (shorthand for addListener)
1419 <dl class="detailList">
1420 <dt class="heading">Parameters:</dt>
1423 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1426 <dd>The type of event to listen for</dd>
1429 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1432 <dd>The method the event invokes</dd>
1435 <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>
1438 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1441 <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>
1462 <td class="msource">
1464 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1470 <tr class="method-row config-row-alt0 expandable">
1471 <td class="micon"><a class="exi" href="#expand"> </a></td>
1475 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1476 <div class="fixedFont">
1477 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1486 <div class="short">Removes all listeners for this object</div>
1492 Removes all listeners for this object
1513 <td class="msource">
1515 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1521 <tr class="method-row config-row-alt1 expandable">
1522 <td class="micon"><a class="exi" href="#expand"> </a></td>
1526 <a id="Roo.BorderLayout-method-remove" name=".remove"></a>
1527 <div class="fixedFont">
1528 <span class="attributes"></span><b class="itemname">remove</b>
1530 (<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>)
1536 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1545 <div class="short">Remove a ContentPanel (or subclass) to this layout.</div>
1551 Remove a ContentPanel (or subclass) to this layout.
1558 <dl class="detailList">
1559 <dt class="heading">Parameters:</dt>
1562 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
1565 <dd>The target region key (north, south, east, west or center).</dd>
1568 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/Roo.ContentPanel</span> <b>panel</b>
1571 <dd>The index, id or panel to remove</dd>
1579 <dl class="detailList">
1580 <dt class="heading">Returns:</dt>
1582 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The removed panel</dd>
1596 <td class="msource">
1598 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1604 <tr class="method-row config-row-alt0 expandable">
1605 <td class="micon"><a class="exi" href="#expand"> </a></td>
1609 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1610 <div class="fixedFont">
1611 <span class="attributes"></span><b class="itemname">removeListener</b>
1613 (<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>)
1620 <div class="short">Removes a listener</div>
1633 <dl class="detailList">
1634 <dt class="heading">Parameters:</dt>
1637 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1640 <dd>The type of event to listen for</dd>
1643 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1646 <dd>The handler to remove</dd>
1649 <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>
1652 <dd>(optional) The scope (this object) for the handler</dd>
1670 <td class="msource">
1672 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1678 <tr class="method-row config-row-alt1 expandable">
1679 <td class="micon"><a class="exi" href="#expand"> </a></td>
1683 <a id="Roo.BorderLayout-method-restoreState" name=".restoreState"></a>
1684 <div class="fixedFont">
1685 <span class="attributes"></span><b class="itemname">restoreState</b>
1687 (<a href="./Roo.state.Provider.html#constructor" roo:cls="Roo.state.Provider.html#constructor">Roo.state.Provider</a> <B><i>provider</i></B>)
1694 <div class="short">Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.</div>
1700 Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.
1707 <dl class="detailList">
1708 <dt class="heading">Parameters:</dt>
1711 <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>
1714 <dd>(optional) An alternate state provider</dd>
1732 <td class="msource">
1734 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1740 <tr class="method-row config-row-alt0 expandable">
1741 <td class="micon"><a class="exi" href="#expand"> </a></td>
1745 <a id="Roo.BorderLayout-method-showPanel" name=".showPanel"></a>
1746 <div class="fixedFont">
1747 <span class="attributes"></span><b class="itemname">showPanel</b>
1749 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel <B><i>panelId</i></B>)
1755 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1764 <div class="short">Searches all regions for a panel with the specified id and activates (shows) it.</div>
1770 Searches all regions for a panel with the specified id and activates (shows) it.
1777 <dl class="detailList">
1778 <dt class="heading">Parameters:</dt>
1781 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/ContentPanel</span> <b>panelId</b>
1784 <dd>The panels id or the panel itself</dd>
1792 <dl class="detailList">
1793 <dt class="heading">Returns:</dt>
1795 <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>
1809 <td class="msource">
1811 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
1817 <tr class="method-row config-row-alt1 expandable">
1818 <td class="micon"><a class="exi" href="#expand"> </a></td>
1822 <a id="Roo.util.Observable-method-un" name=".un"></a>
1823 <div class="fixedFont">
1824 <span class="attributes"></span><b class="itemname">un</b>
1826 (<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>)
1833 <div class="short">Removes a listener (shorthand for removeListener)</div>
1839 Removes a listener (shorthand for removeListener)
1846 <dl class="detailList">
1847 <dt class="heading">Parameters:</dt>
1850 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1853 <dd>The type of event to listen for</dd>
1856 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1859 <dd>The handler to remove</dd>
1862 <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>
1865 <dd>(optional) The scope (this object) for the handler</dd>
1883 <td class="msource">
1885 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1894 <!-- ============================== events summary / details ======================== -->
1897 <a id="Roo.ReaderLayout-events"></a>
1906 <table cellspacing="0" class="member-table">
1907 <caption>Events</caption>
1910 <th class="sig-header" colspan="2">Event</th>
1911 <th class="msource-header">Defined By</th>
1920 <tr class="method-row expandable config-row-alt0">
1921 <td class="micon"><a class="exi" href="#expand"> </a></td>
1924 <a id="Roo.LayoutManager-event-*layout"></a>
1926 <div class="fixedFont">
1927 <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>)
1933 <div class="short">Fires when a layout is performed.
1939 Fires when a layout is performed.
1945 <dl class="detailList">
1946 <dt class="heading">Parameters:</dt>
1949 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
1970 <td class="msource">
1971 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
1975 <tr class="method-row expandable config-row-alt1">
1976 <td class="micon"><a class="exi" href="#expand"> </a></td>
1979 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
1981 <div class="fixedFont">
1982 <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>)
1988 <div class="short">Fires when a region is collapsed.
1994 Fires when a region is collapsed.
2000 <dl class="detailList">
2001 <dt class="heading">Parameters:</dt>
2004 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2007 <dd>The collapsed region</dd>
2025 <td class="msource">
2026 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2030 <tr class="method-row expandable config-row-alt0">
2031 <td class="micon"><a class="exi" href="#expand"> </a></td>
2034 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
2036 <div class="fixedFont">
2037 <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>)
2043 <div class="short">Fires when a region is expanded.
2049 Fires when a region is expanded.
2055 <dl class="detailList">
2056 <dt class="heading">Parameters:</dt>
2059 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2062 <dd>The expanded region</dd>
2080 <td class="msource">
2081 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2085 <tr class="method-row expandable config-row-alt1">
2086 <td class="micon"><a class="exi" href="#expand"> </a></td>
2089 <a id="Roo.LayoutManager-event-*regionresized"></a>
2091 <div class="fixedFont">
2092 <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>)
2098 <div class="short">Fires when the user resizes a region.
2104 Fires when the user resizes a region.
2110 <dl class="detailList">
2111 <dt class="heading">Parameters:</dt>
2114 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
2117 <dd>The resized region</dd>
2120 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2123 <dd>The new size (width for east/west, height for north/south)</dd>
2141 <td class="msource">
2142 <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>
2153 <!-- ============================== footer ================================= -->
2154 <div class="fineprint" style="clear:both">
2156 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 24 2014 16:32:53 GMT+0800 (HKT)
2158 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>