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.BasicLayoutRegion</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.BasicLayoutRegion-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.BasicLayoutRegion-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.BasicLayoutRegion-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.BasicLayoutRegion-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.BasicLayoutRegion
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.BasicLayoutRegion
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_BasicLayoutRegion.js.html">Roo/BasicLayoutRegion.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">BasicLayoutRegion</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>, <a href="./Roo.SplitLayoutRegion.html#constructor" roo:cls="Roo.SplitLayoutRegion.html#constructor">Roo.SplitLayoutRegion</a>, <a href="./Roo.bootstrap.layout.Split.html#constructor" roo:cls="Roo.bootstrap.layout.Split.html#constructor">Roo.bootstrap.layout.Split</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 This class represents a lightweight region in a layout manager. This region does not move dom nodes<br/>and does not have a titlebar, tabs or any other features. All it does is size and position <br/>panels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.BasicLayoutRegion';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.BasicLayoutRegion.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.BasicLayoutRegion-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
139 <div class="fixedFont">
140 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
146 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
151 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>
161 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
177 <!-- ============================== public properties ==================== -->
181 <a id="Roo.BasicLayoutRegion-props"></a>
187 <table cellspacing="0" class="member-table">
188 <caption class="Empty">Public Properties - Has None</caption>
194 <!-- ============================== methods summary / details ======================== -->
197 <a id="Roo.BasicLayoutRegion-methods"></a>
198 <!-- constructor?? -->
205 <!-- then dynamics first -->
212 <table cellspacing="0" class="member-table">
213 <caption>Public Methods</caption>
215 <th class="sig-header" colspan="2">Method</th>
216 <th class="msource-header">Defined By</th>
226 <tr class="method-row config-row-alt0 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
231 <a id="Roo-method-BasicLayoutRegion" name=".BasicLayoutRegion"></a>
232 <div class="fixedFont">
233 <span class="attributes">new <B>Roo.</B></span><b class="itemname">BasicLayoutRegion</b>
243 <div class="short">Create a new Roo.BasicLayoutRegion</div>
250 Create a new Roo.BasicLayoutRegion
273 <tr class="method-row config-row-alt1 expandable notInherited">
274 <td class="micon"><a class="exi" href="#expand"> </a></td>
278 <a id="Roo.BasicLayoutRegion-method-add" name=".add"></a>
279 <div class="fixedFont">
280 <span class="attributes"></span><b class="itemname">add</b>
282 (ContentPanel... <B><i>panel</i></B>)
288 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
297 <div class="short">Add the passed ContentPanel(s)</div>
303 Add the passed ContentPanel(s)
310 <dl class="detailList">
311 <dt class="heading">Parameters:</dt>
314 <span class="fixedFont">ContentPanel...</span> <b>panel</b>
317 <dd>The ContentPanel(s) to add (you can pass more than one)</dd>
325 <dl class="detailList">
326 <dt class="heading">Returns:</dt>
328 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The panel added (if only one was added)</dd>
344 Roo.BasicLayoutRegion
350 <tr class="method-row config-row-alt0 expandable">
351 <td class="micon"><a class="exi" href="#expand"> </a></td>
355 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
356 <div class="fixedFont">
357 <span class="attributes"></span><b class="itemname">addEvents</b>
359 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
366 <div class="short">Used to define events on this Observable</div>
372 Used to define events on this Observable
379 <dl class="detailList">
380 <dt class="heading">Parameters:</dt>
383 <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>
386 <dd>The object with the events defined</dd>
406 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
412 <tr class="method-row config-row-alt1 expandable">
413 <td class="micon"><a class="exi" href="#expand"> </a></td>
417 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
418 <div class="fixedFont">
419 <span class="attributes"></span><b class="itemname">addListener</b>
421 (<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>)
428 <div class="short">Appends an event handler to this component</div>
434 Appends an event handler to this component
441 <dl class="detailList">
442 <dt class="heading">Parameters:</dt>
445 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
448 <dd>The type of event to listen for</dd>
451 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
454 <dd>The method the event invokes</dd>
457 <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>
460 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
463 <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>
466 <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>
486 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
492 <tr class="method-row config-row-alt0 expandable">
493 <td class="micon"><a class="exi" href="#expand"> </a></td>
497 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
498 <div class="fixedFont">
499 <span class="attributes"></span><b class="itemname">fireEvent</b>
501 (<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>)
507 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
516 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
522 Fires the specified event with the passed parameters (minus the event name).
529 <dl class="detailList">
530 <dt class="heading">Parameters:</dt>
533 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
539 <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>
542 <dd>Variable number of parameters are passed to handlers</dd>
550 <dl class="detailList">
551 <dt class="heading">Returns:</dt>
553 <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>
569 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
575 <tr class="method-row config-row-alt1 expandable notInherited">
576 <td class="micon"><a class="exi" href="#expand"> </a></td>
580 <a id="Roo.BasicLayoutRegion-method-getActivePanel" name=".getActivePanel"></a>
581 <div class="fixedFont">
582 <span class="attributes"></span><b class="itemname">getActivePanel</b>
590 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
599 <div class="short">Get the active panel for this region.</div>
605 Get the active panel for this region.
616 <dl class="detailList">
617 <dt class="heading">Returns:</dt>
619 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The active panel or null</dd>
635 Roo.BasicLayoutRegion
641 <tr class="method-row config-row-alt0 expandable notInherited">
642 <td class="micon"><a class="exi" href="#expand"> </a></td>
646 <a id="Roo.BasicLayoutRegion-method-getEl" name=".getEl"></a>
647 <div class="fixedFont">
648 <span class="attributes"></span><b class="itemname">getEl</b>
656 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
665 <div class="short">Returns the container element for this region.</div>
671 Returns the container element for this region.
682 <dl class="detailList">
683 <dt class="heading">Returns:</dt>
685 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
701 Roo.BasicLayoutRegion
707 <tr class="method-row config-row-alt1 expandable notInherited">
708 <td class="micon"><a class="exi" href="#expand"> </a></td>
712 <a id="Roo.BasicLayoutRegion-method-getPanel" name=".getPanel"></a>
713 <div class="fixedFont">
714 <span class="attributes"></span><b class="itemname">getPanel</b>
716 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
722 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
731 <div class="short">Returns the panel specified or null if it's not in this region.</div>
737 Returns the panel specified or null if it's not in this region.
744 <dl class="detailList">
745 <dt class="heading">Parameters:</dt>
748 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
751 <dd>The panels index, id or the panel itself</dd>
759 <dl class="detailList">
760 <dt class="heading">Returns:</dt>
762 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> </dd>
778 Roo.BasicLayoutRegion
784 <tr class="method-row config-row-alt0 expandable notInherited">
785 <td class="micon"><a class="exi" href="#expand"> </a></td>
789 <a id="Roo.BasicLayoutRegion-method-getPosition" name=".getPosition"></a>
790 <div class="fixedFont">
791 <span class="attributes"></span><b class="itemname">getPosition</b>
799 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
808 <div class="short">Returns this regions position (north/south/east/west/center).</div>
814 Returns this regions position (north/south/east/west/center).
825 <dl class="detailList">
826 <dt class="heading">Returns:</dt>
828 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
844 Roo.BasicLayoutRegion
850 <tr class="method-row config-row-alt1 expandable">
851 <td class="micon"><a class="exi" href="#expand"> </a></td>
855 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
856 <div class="fixedFont">
857 <span class="attributes"></span><b class="itemname">hasListener</b>
859 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
865 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
874 <div class="short">Checks to see if this object has any listeners for a specified event</div>
880 Checks to see if this object has any listeners for a specified event
887 <dl class="detailList">
888 <dt class="heading">Parameters:</dt>
891 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
894 <dd>The name of the event to check for</dd>
902 <dl class="detailList">
903 <dt class="heading">Returns:</dt>
905 <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>
921 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
927 <tr class="method-row config-row-alt0 expandable notInherited">
928 <td class="micon"><a class="exi" href="#expand"> </a></td>
932 <a id="Roo.BasicLayoutRegion-method-hasPanel" name=".hasPanel"></a>
933 <div class="fixedFont">
934 <span class="attributes"></span><b class="itemname">hasPanel</b>
936 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
942 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
951 <div class="short">Returns true if the panel is in this region.</div>
957 Returns true if the panel is in this region.
964 <dl class="detailList">
965 <dt class="heading">Parameters:</dt>
968 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
971 <dd>The panels index, id or the panel itself</dd>
979 <dl class="detailList">
980 <dt class="heading">Returns:</dt>
982 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
998 Roo.BasicLayoutRegion
1004 <tr class="method-row config-row-alt1 expandable notInherited">
1005 <td class="micon"><a class="exi" href="#expand"> </a></td>
1009 <a id="Roo.BasicLayoutRegion-method-isVisible" name=".isVisible"></a>
1010 <div class="fixedFont">
1011 <span class="attributes"></span><b class="itemname">isVisible</b>
1019 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1028 <div class="short">Returns true if this region is currently visible.</div>
1034 Returns true if this region is currently visible.
1045 <dl class="detailList">
1046 <dt class="heading">Returns:</dt>
1048 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1062 <td class="msource">
1064 Roo.BasicLayoutRegion
1070 <tr class="method-row config-row-alt0 expandable">
1071 <td class="micon"><a class="exi" href="#expand"> </a></td>
1075 <a id="Roo.util.Observable-method-on" name=".on"></a>
1076 <div class="fixedFont">
1077 <span class="attributes"></span><b class="itemname">on</b>
1079 (<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>)
1086 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1092 Appends an event handler to this element (shorthand for addListener)
1099 <dl class="detailList">
1100 <dt class="heading">Parameters:</dt>
1103 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1106 <dd>The type of event to listen for</dd>
1109 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1112 <dd>The method the event invokes</dd>
1115 <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>
1118 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1121 <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>
1142 <td class="msource">
1144 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1150 <tr class="method-row config-row-alt1 expandable">
1151 <td class="micon"><a class="exi" href="#expand"> </a></td>
1155 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1156 <div class="fixedFont">
1157 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1166 <div class="short">Removes all listeners for this object</div>
1172 Removes all listeners for this object
1193 <td class="msource">
1195 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1201 <tr class="method-row config-row-alt0 expandable notInherited">
1202 <td class="micon"><a class="exi" href="#expand"> </a></td>
1206 <a id="Roo.BasicLayoutRegion-method-remove" name=".remove"></a>
1207 <div class="fixedFont">
1208 <span class="attributes"></span><b class="itemname">remove</b>
1210 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preservePanel</i></B>)
1216 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1225 <div class="short">Removes the specified panel.</div>
1231 Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
1238 <dl class="detailList">
1239 <dt class="heading">Parameters:</dt>
1242 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1245 <dd>The panels index, id or the panel itself</dd>
1248 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>preservePanel</b>
1251 <dd>Overrides the config preservePanel option</dd>
1259 <dl class="detailList">
1260 <dt class="heading">Returns:</dt>
1262 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> The panel that was removed</dd>
1276 <td class="msource">
1278 Roo.BasicLayoutRegion
1284 <tr class="method-row config-row-alt1 expandable">
1285 <td class="micon"><a class="exi" href="#expand"> </a></td>
1289 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1290 <div class="fixedFont">
1291 <span class="attributes"></span><b class="itemname">removeListener</b>
1293 (<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>)
1300 <div class="short">Removes a listener</div>
1313 <dl class="detailList">
1314 <dt class="heading">Parameters:</dt>
1317 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1320 <dd>The type of event to listen for</dd>
1323 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1326 <dd>The handler to remove</dd>
1329 <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>
1332 <dd>(optional) The scope (this object) for the handler</dd>
1350 <td class="msource">
1352 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1358 <tr class="method-row config-row-alt0 expandable notInherited">
1359 <td class="micon"><a class="exi" href="#expand"> </a></td>
1363 <a id="Roo.BasicLayoutRegion-method-resizeTo" name=".resizeTo"></a>
1364 <div class="fixedFont">
1365 <span class="attributes"></span><b class="itemname">resizeTo</b>
1367 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
1374 <div class="short">Resizes the region to the specified size.</div>
1380 Resizes the region to the specified size. For vertical regions (west, east) this adjusts <br/>the width, for horizontal (north, south) the height.
1387 <dl class="detailList">
1388 <dt class="heading">Parameters:</dt>
1391 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
1394 <dd>The new width or height</dd>
1412 <td class="msource">
1414 Roo.BasicLayoutRegion
1420 <tr class="method-row config-row-alt1 expandable notInherited">
1421 <td class="micon"><a class="exi" href="#expand"> </a></td>
1425 <a id="Roo.BasicLayoutRegion-method-showPanel" name=".showPanel"></a>
1426 <div class="fixedFont">
1427 <span class="attributes"></span><b class="itemname">showPanel</b>
1429 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panelId</i></B>)
1435 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1444 <div class="short">Show the specified panel.</div>
1450 Show the specified panel.
1457 <dl class="detailList">
1458 <dt class="heading">Parameters:</dt>
1461 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panelId</b>
1464 <dd>The panels index, id or the panel itself</dd>
1472 <dl class="detailList">
1473 <dt class="heading">Returns:</dt>
1475 <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>
1489 <td class="msource">
1491 Roo.BasicLayoutRegion
1497 <tr class="method-row config-row-alt0 expandable">
1498 <td class="micon"><a class="exi" href="#expand"> </a></td>
1502 <a id="Roo.util.Observable-method-un" name=".un"></a>
1503 <div class="fixedFont">
1504 <span class="attributes"></span><b class="itemname">un</b>
1506 (<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>)
1513 <div class="short">Removes a listener (shorthand for removeListener)</div>
1519 Removes a listener (shorthand for removeListener)
1526 <dl class="detailList">
1527 <dt class="heading">Parameters:</dt>
1530 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1533 <dd>The type of event to listen for</dd>
1536 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1539 <dd>The handler to remove</dd>
1542 <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>
1545 <dd>(optional) The scope (this object) for the handler</dd>
1563 <td class="msource">
1565 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1574 <!-- ============================== events summary / details ======================== -->
1577 <a id="Roo.BasicLayoutRegion-events"></a>
1586 <table cellspacing="0" class="member-table">
1587 <caption>Events</caption>
1590 <th class="sig-header" colspan="2">Event</th>
1591 <th class="msource-header">Defined By</th>
1600 <tr class="method-row expandable config-row-alt0 notInherited">
1601 <td class="micon"><a class="exi" href="#expand"> </a></td>
1604 <a id="Roo.BasicLayoutRegion-event-*beforecollapse"></a>
1606 <div class="fixedFont">
1607 <b class="itemname">beforecollapse</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1613 <div class="short">Fires when this region before collapse.
1619 Fires when this region before collapse.
1625 <dl class="detailList">
1626 <dt class="heading">Parameters:</dt>
1629 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1650 <td class="msource">
1651 Roo.BasicLayoutRegion
1655 <tr class="method-row expandable config-row-alt1 notInherited">
1656 <td class="micon"><a class="exi" href="#expand"> </a></td>
1659 <a id="Roo.BasicLayoutRegion-event-*beforeremove"></a>
1661 <div class="fixedFont">
1662 <b class="itemname">beforeremove</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
1668 <div class="short">Fires before a panel is removed (or closed).
1674 Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
1680 <dl class="detailList">
1681 <dt class="heading">Parameters:</dt>
1684 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1690 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1696 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
1699 <dd>The cancel event object</dd>
1717 <td class="msource">
1718 Roo.BasicLayoutRegion
1722 <tr class="method-row expandable config-row-alt0 notInherited">
1723 <td class="micon"><a class="exi" href="#expand"> </a></td>
1726 <a id="Roo.BasicLayoutRegion-event-*collapsed"></a>
1728 <div class="fixedFont">
1729 <b class="itemname">collapsed</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1735 <div class="short">Fires when this region is collapsed.
1741 Fires when this region is collapsed.
1747 <dl class="detailList">
1748 <dt class="heading">Parameters:</dt>
1751 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1772 <td class="msource">
1773 Roo.BasicLayoutRegion
1777 <tr class="method-row expandable config-row-alt1 notInherited">
1778 <td class="micon"><a class="exi" href="#expand"> </a></td>
1781 <a id="Roo.BasicLayoutRegion-event-*expanded"></a>
1783 <div class="fixedFont">
1784 <b class="itemname">expanded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1790 <div class="short">Fires when this region is expanded.
1796 Fires when this region is expanded.
1802 <dl class="detailList">
1803 <dt class="heading">Parameters:</dt>
1806 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1827 <td class="msource">
1828 Roo.BasicLayoutRegion
1832 <tr class="method-row expandable config-row-alt0 notInherited">
1833 <td class="micon"><a class="exi" href="#expand"> </a></td>
1836 <a id="Roo.BasicLayoutRegion-event-*invalidated"></a>
1838 <div class="fixedFont">
1839 <b class="itemname">invalidated</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
1845 <div class="short">Fires when the layout for this region is changed.
1851 Fires when the layout for this region is changed.
1857 <dl class="detailList">
1858 <dt class="heading">Parameters:</dt>
1861 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1882 <td class="msource">
1883 Roo.BasicLayoutRegion
1887 <tr class="method-row expandable config-row-alt1 notInherited">
1888 <td class="micon"><a class="exi" href="#expand"> </a></td>
1891 <a id="Roo.BasicLayoutRegion-event-*panelactivated"></a>
1893 <div class="fixedFont">
1894 <b class="itemname">panelactivated</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
1900 <div class="short">Fires when a panel is activated.
1906 Fires when a panel is activated.
1912 <dl class="detailList">
1913 <dt class="heading">Parameters:</dt>
1916 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1922 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1925 <dd>The activated panel</dd>
1943 <td class="msource">
1944 Roo.BasicLayoutRegion
1948 <tr class="method-row expandable config-row-alt0 notInherited">
1949 <td class="micon"><a class="exi" href="#expand"> </a></td>
1952 <a id="Roo.BasicLayoutRegion-event-*paneladded"></a>
1954 <div class="fixedFont">
1955 <b class="itemname">paneladded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
1961 <div class="short">Fires when a panel is added.
1967 Fires when a panel is added.
1973 <dl class="detailList">
1974 <dt class="heading">Parameters:</dt>
1977 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1983 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
2004 <td class="msource">
2005 Roo.BasicLayoutRegion
2009 <tr class="method-row expandable config-row-alt1 notInherited">
2010 <td class="micon"><a class="exi" href="#expand"> </a></td>
2013 <a id="Roo.BasicLayoutRegion-event-*panelremoved"></a>
2015 <div class="fixedFont">
2016 <b class="itemname">panelremoved</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>panel</i></B>)
2022 <div class="short">Fires when a panel is removed.
2028 Fires when a panel is removed.
2034 <dl class="detailList">
2035 <dt class="heading">Parameters:</dt>
2038 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2044 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
2065 <td class="msource">
2066 Roo.BasicLayoutRegion
2070 <tr class="method-row expandable config-row-alt0 notInherited">
2071 <td class="micon"><a class="exi" href="#expand"> </a></td>
2074 <a id="Roo.BasicLayoutRegion-event-*resized"></a>
2076 <div class="fixedFont">
2077 <b class="itemname">resized</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
2083 <div class="short">Fires when the user resizes this region.
2089 Fires when the user resizes this region.
2095 <dl class="detailList">
2096 <dt class="heading">Parameters:</dt>
2099 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2105 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2108 <dd>The new size (width for east/west, height for north/south)</dd>
2126 <td class="msource">
2127 Roo.BasicLayoutRegion
2131 <tr class="method-row expandable config-row-alt1 notInherited">
2132 <td class="micon"><a class="exi" href="#expand"> </a></td>
2135 <a id="Roo.BasicLayoutRegion-event-*slidehide"></a>
2137 <div class="fixedFont">
2138 <b class="itemname">slidehide</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
2144 <div class="short">Fires when this region slides out of view.
2150 Fires when this region slides out of view.
2156 <dl class="detailList">
2157 <dt class="heading">Parameters:</dt>
2160 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2181 <td class="msource">
2182 Roo.BasicLayoutRegion
2186 <tr class="method-row expandable config-row-alt0 notInherited">
2187 <td class="micon"><a class="exi" href="#expand"> </a></td>
2190 <a id="Roo.BasicLayoutRegion-event-*slideshow"></a>
2192 <div class="fixedFont">
2193 <b class="itemname">slideshow</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>)
2199 <div class="short">Fires when this region is slid into view.
2205 Fires when this region is slid into view.
2211 <dl class="detailList">
2212 <dt class="heading">Parameters:</dt>
2215 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2236 <td class="msource">
2237 Roo.BasicLayoutRegion
2241 <tr class="method-row expandable config-row-alt1 notInherited">
2242 <td class="micon"><a class="exi" href="#expand"> </a></td>
2245 <a id="Roo.BasicLayoutRegion-event-*visibilitychange"></a>
2247 <div class="fixedFont">
2248 <b class="itemname">visibilitychange</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visibility</i></B>)
2254 <div class="short">Fires when this region is shown or hidden
2260 Fires when this region is shown or hidden
2266 <dl class="detailList">
2267 <dt class="heading">Parameters:</dt>
2270 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2276 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visibility</b>
2279 <dd>true or false</dd>
2297 <td class="msource">
2298 Roo.BasicLayoutRegion
2309 <!-- ============================== footer ================================= -->
2310 <div class="fineprint" style="clear:both">
2312 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Nov 17 2017 18:23:44 GMT+0800 (HKT)
2314 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>