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>
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>
150 <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>
158 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
174 <!-- ============================== public properties ==================== -->
178 <a id="Roo.BasicLayoutRegion-props"></a>
184 <table cellspacing="0" class="member-table">
185 <caption class="Empty">Public Properties - Has None</caption>
191 <!-- ============================== methods summary / details ======================== -->
194 <a id="Roo.BasicLayoutRegion-methods"></a>
195 <!-- constructor?? -->
202 <!-- then dynamics first -->
209 <table cellspacing="0" class="member-table">
210 <caption>Public Methods</caption>
212 <th class="sig-header" colspan="2">Method</th>
213 <th class="msource-header">Defined By</th>
223 <tr class="method-row config-row-alt0 notInherited">
224 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo-method-BasicLayoutRegion" name=".BasicLayoutRegion"></a>
229 <div class="fixedFont">
230 <span class="attributes">new <B>Roo.</B></span><b class="itemname">BasicLayoutRegion</b>
240 <div class="short">Create a new Roo.BasicLayoutRegion</div>
247 Create a new Roo.BasicLayoutRegion
270 <tr class="method-row config-row-alt1 expandable notInherited">
271 <td class="micon"><a class="exi" href="#expand"> </a></td>
275 <a id="Roo.BasicLayoutRegion-method-add" name=".add"></a>
276 <div class="fixedFont">
277 <span class="attributes"></span><b class="itemname">add</b>
279 (ContentPanel... <B><i>panel</i></B>)
285 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
294 <div class="short">Add the passed ContentPanel(s)</div>
300 Add the passed ContentPanel(s)
307 <dl class="detailList">
308 <dt class="heading">Parameters:</dt>
311 <span class="fixedFont">ContentPanel...</span> <b>panel</b>
314 <dd>The ContentPanel(s) to add (you can pass more than one)</dd>
322 <dl class="detailList">
323 <dt class="heading">Returns:</dt>
325 <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>
341 Roo.BasicLayoutRegion
347 <tr class="method-row config-row-alt0 expandable">
348 <td class="micon"><a class="exi" href="#expand"> </a></td>
352 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
353 <div class="fixedFont">
354 <span class="attributes"></span><b class="itemname">addEvents</b>
356 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
363 <div class="short">Used to define events on this Observable</div>
369 Used to define events on this Observable
376 <dl class="detailList">
377 <dt class="heading">Parameters:</dt>
380 <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>
383 <dd>The object with the events defined</dd>
403 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
409 <tr class="method-row config-row-alt1 expandable">
410 <td class="micon"><a class="exi" href="#expand"> </a></td>
414 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
415 <div class="fixedFont">
416 <span class="attributes"></span><b class="itemname">addListener</b>
418 (<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>)
425 <div class="short">Appends an event handler to this component</div>
431 Appends an event handler to this component
438 <dl class="detailList">
439 <dt class="heading">Parameters:</dt>
442 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
445 <dd>The type of event to listen for</dd>
448 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
451 <dd>The method the event invokes</dd>
454 <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>
457 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
460 <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>
463 <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>
483 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
489 <tr class="method-row config-row-alt0 expandable">
490 <td class="micon"><a class="exi" href="#expand"> </a></td>
494 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
495 <div class="fixedFont">
496 <span class="attributes"></span><b class="itemname">fireEvent</b>
498 (<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>)
504 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
513 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
519 Fires the specified event with the passed parameters (minus the event name).
526 <dl class="detailList">
527 <dt class="heading">Parameters:</dt>
530 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
536 <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>
539 <dd>Variable number of parameters are passed to handlers</dd>
547 <dl class="detailList">
548 <dt class="heading">Returns:</dt>
550 <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>
566 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
572 <tr class="method-row config-row-alt1 expandable notInherited">
573 <td class="micon"><a class="exi" href="#expand"> </a></td>
577 <a id="Roo.BasicLayoutRegion-method-getActivePanel" name=".getActivePanel"></a>
578 <div class="fixedFont">
579 <span class="attributes"></span><b class="itemname">getActivePanel</b>
587 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
596 <div class="short">Get the active panel for this region.</div>
602 Get the active panel for this region.
613 <dl class="detailList">
614 <dt class="heading">Returns:</dt>
616 <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>
632 Roo.BasicLayoutRegion
638 <tr class="method-row config-row-alt0 expandable notInherited">
639 <td class="micon"><a class="exi" href="#expand"> </a></td>
643 <a id="Roo.BasicLayoutRegion-method-getEl" name=".getEl"></a>
644 <div class="fixedFont">
645 <span class="attributes"></span><b class="itemname">getEl</b>
653 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
662 <div class="short">Returns the container element for this region.</div>
668 Returns the container element for this region.
679 <dl class="detailList">
680 <dt class="heading">Returns:</dt>
682 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
698 Roo.BasicLayoutRegion
704 <tr class="method-row config-row-alt1 expandable notInherited">
705 <td class="micon"><a class="exi" href="#expand"> </a></td>
709 <a id="Roo.BasicLayoutRegion-method-getPanel" name=".getPanel"></a>
710 <div class="fixedFont">
711 <span class="attributes"></span><b class="itemname">getPanel</b>
713 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
719 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
728 <div class="short">Returns the panel specified or null if it's not in this region.</div>
734 Returns the panel specified or null if it's not in this region.
741 <dl class="detailList">
742 <dt class="heading">Parameters:</dt>
745 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
748 <dd>The panels index, id or the panel itself</dd>
756 <dl class="detailList">
757 <dt class="heading">Returns:</dt>
759 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> </dd>
775 Roo.BasicLayoutRegion
781 <tr class="method-row config-row-alt0 expandable notInherited">
782 <td class="micon"><a class="exi" href="#expand"> </a></td>
786 <a id="Roo.BasicLayoutRegion-method-getPosition" name=".getPosition"></a>
787 <div class="fixedFont">
788 <span class="attributes"></span><b class="itemname">getPosition</b>
796 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
805 <div class="short">Returns this regions position (north/south/east/west/center).</div>
811 Returns this regions position (north/south/east/west/center).
822 <dl class="detailList">
823 <dt class="heading">Returns:</dt>
825 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
841 Roo.BasicLayoutRegion
847 <tr class="method-row config-row-alt1 expandable">
848 <td class="micon"><a class="exi" href="#expand"> </a></td>
852 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
853 <div class="fixedFont">
854 <span class="attributes"></span><b class="itemname">hasListener</b>
856 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
862 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
871 <div class="short">Checks to see if this object has any listeners for a specified event</div>
877 Checks to see if this object has any listeners for a specified event
884 <dl class="detailList">
885 <dt class="heading">Parameters:</dt>
888 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
891 <dd>The name of the event to check for</dd>
899 <dl class="detailList">
900 <dt class="heading">Returns:</dt>
902 <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>
918 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
924 <tr class="method-row config-row-alt0 expandable notInherited">
925 <td class="micon"><a class="exi" href="#expand"> </a></td>
929 <a id="Roo.BasicLayoutRegion-method-hasPanel" name=".hasPanel"></a>
930 <div class="fixedFont">
931 <span class="attributes"></span><b class="itemname">hasPanel</b>
933 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
939 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
948 <div class="short">Returns true if the panel is in this region.</div>
954 Returns true if the panel is in this region.
961 <dl class="detailList">
962 <dt class="heading">Parameters:</dt>
965 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
968 <dd>The panels index, id or the panel itself</dd>
976 <dl class="detailList">
977 <dt class="heading">Returns:</dt>
979 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
995 Roo.BasicLayoutRegion
1001 <tr class="method-row config-row-alt1 expandable notInherited">
1002 <td class="micon"><a class="exi" href="#expand"> </a></td>
1006 <a id="Roo.BasicLayoutRegion-method-isVisible" name=".isVisible"></a>
1007 <div class="fixedFont">
1008 <span class="attributes"></span><b class="itemname">isVisible</b>
1016 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1025 <div class="short">Returns true if this region is currently visible.</div>
1031 Returns true if this region is currently visible.
1042 <dl class="detailList">
1043 <dt class="heading">Returns:</dt>
1045 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1059 <td class="msource">
1061 Roo.BasicLayoutRegion
1067 <tr class="method-row config-row-alt0 expandable">
1068 <td class="micon"><a class="exi" href="#expand"> </a></td>
1072 <a id="Roo.util.Observable-method-on" name=".on"></a>
1073 <div class="fixedFont">
1074 <span class="attributes"></span><b class="itemname">on</b>
1076 (<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>)
1083 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1089 Appends an event handler to this element (shorthand for addListener)
1096 <dl class="detailList">
1097 <dt class="heading">Parameters:</dt>
1100 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1103 <dd>The type of event to listen for</dd>
1106 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1109 <dd>The method the event invokes</dd>
1112 <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>
1115 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1118 <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>
1139 <td class="msource">
1141 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1147 <tr class="method-row config-row-alt1 expandable">
1148 <td class="micon"><a class="exi" href="#expand"> </a></td>
1152 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1153 <div class="fixedFont">
1154 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1163 <div class="short">Removes all listeners for this object</div>
1169 Removes all listeners for this object
1190 <td class="msource">
1192 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1198 <tr class="method-row config-row-alt0 expandable notInherited">
1199 <td class="micon"><a class="exi" href="#expand"> </a></td>
1203 <a id="Roo.BasicLayoutRegion-method-remove" name=".remove"></a>
1204 <div class="fixedFont">
1205 <span class="attributes"></span><b class="itemname">remove</b>
1207 (<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>)
1213 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1222 <div class="short">Removes the specified panel.</div>
1228 Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
1235 <dl class="detailList">
1236 <dt class="heading">Parameters:</dt>
1239 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1242 <dd>The panels index, id or the panel itself</dd>
1245 <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>
1248 <dd>Overrides the config preservePanel option</dd>
1256 <dl class="detailList">
1257 <dt class="heading">Returns:</dt>
1259 <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>
1273 <td class="msource">
1275 Roo.BasicLayoutRegion
1281 <tr class="method-row config-row-alt1 expandable">
1282 <td class="micon"><a class="exi" href="#expand"> </a></td>
1286 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1287 <div class="fixedFont">
1288 <span class="attributes"></span><b class="itemname">removeListener</b>
1290 (<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>)
1297 <div class="short">Removes a listener</div>
1310 <dl class="detailList">
1311 <dt class="heading">Parameters:</dt>
1314 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1317 <dd>The type of event to listen for</dd>
1320 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1323 <dd>The handler to remove</dd>
1326 <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>
1329 <dd>(optional) The scope (this object) for the handler</dd>
1347 <td class="msource">
1349 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1355 <tr class="method-row config-row-alt0 expandable notInherited">
1356 <td class="micon"><a class="exi" href="#expand"> </a></td>
1360 <a id="Roo.BasicLayoutRegion-method-resizeTo" name=".resizeTo"></a>
1361 <div class="fixedFont">
1362 <span class="attributes"></span><b class="itemname">resizeTo</b>
1364 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
1371 <div class="short">Resizes the region to the specified size.</div>
1377 Resizes the region to the specified size. For vertical regions (west, east) this adjusts <br/>the width, for horizontal (north, south) the height.
1384 <dl class="detailList">
1385 <dt class="heading">Parameters:</dt>
1388 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
1391 <dd>The new width or height</dd>
1409 <td class="msource">
1411 Roo.BasicLayoutRegion
1417 <tr class="method-row config-row-alt1 expandable notInherited">
1418 <td class="micon"><a class="exi" href="#expand"> </a></td>
1422 <a id="Roo.BasicLayoutRegion-method-showPanel" name=".showPanel"></a>
1423 <div class="fixedFont">
1424 <span class="attributes"></span><b class="itemname">showPanel</b>
1426 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panelId</i></B>)
1432 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1441 <div class="short">Show the specified panel.</div>
1447 Show the specified panel.
1454 <dl class="detailList">
1455 <dt class="heading">Parameters:</dt>
1458 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panelId</b>
1461 <dd>The panels index, id or the panel itself</dd>
1469 <dl class="detailList">
1470 <dt class="heading">Returns:</dt>
1472 <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>
1486 <td class="msource">
1488 Roo.BasicLayoutRegion
1494 <tr class="method-row config-row-alt0 expandable">
1495 <td class="micon"><a class="exi" href="#expand"> </a></td>
1499 <a id="Roo.util.Observable-method-un" name=".un"></a>
1500 <div class="fixedFont">
1501 <span class="attributes"></span><b class="itemname">un</b>
1503 (<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>)
1510 <div class="short">Removes a listener (shorthand for removeListener)</div>
1516 Removes a listener (shorthand for removeListener)
1523 <dl class="detailList">
1524 <dt class="heading">Parameters:</dt>
1527 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1530 <dd>The type of event to listen for</dd>
1533 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1536 <dd>The handler to remove</dd>
1539 <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>
1542 <dd>(optional) The scope (this object) for the handler</dd>
1560 <td class="msource">
1562 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1571 <!-- ============================== events summary / details ======================== -->
1574 <a id="Roo.BasicLayoutRegion-events"></a>
1583 <table cellspacing="0" class="member-table">
1584 <caption>Events</caption>
1587 <th class="sig-header" colspan="2">Event</th>
1588 <th class="msource-header">Defined By</th>
1597 <tr class="method-row expandable config-row-alt0 notInherited">
1598 <td class="micon"><a class="exi" href="#expand"> </a></td>
1601 <a id="Roo.BasicLayoutRegion-event-*beforeremove"></a>
1603 <div class="fixedFont">
1604 <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>)
1610 <div class="short">Fires before a panel is removed (or closed).
1616 Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
1622 <dl class="detailList">
1623 <dt class="heading">Parameters:</dt>
1626 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1632 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1638 <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>
1641 <dd>The cancel event object</dd>
1659 <td class="msource">
1660 Roo.BasicLayoutRegion
1664 <tr class="method-row expandable config-row-alt1 notInherited">
1665 <td class="micon"><a class="exi" href="#expand"> </a></td>
1668 <a id="Roo.BasicLayoutRegion-event-*collapsed"></a>
1670 <div class="fixedFont">
1671 <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>)
1677 <div class="short">Fires when this region is collapsed.
1683 Fires when this region is collapsed.
1689 <dl class="detailList">
1690 <dt class="heading">Parameters:</dt>
1693 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1714 <td class="msource">
1715 Roo.BasicLayoutRegion
1719 <tr class="method-row expandable config-row-alt0 notInherited">
1720 <td class="micon"><a class="exi" href="#expand"> </a></td>
1723 <a id="Roo.BasicLayoutRegion-event-*expanded"></a>
1725 <div class="fixedFont">
1726 <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>)
1732 <div class="short">Fires when this region is expanded.
1738 Fires when this region is expanded.
1744 <dl class="detailList">
1745 <dt class="heading">Parameters:</dt>
1748 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1769 <td class="msource">
1770 Roo.BasicLayoutRegion
1774 <tr class="method-row expandable config-row-alt1 notInherited">
1775 <td class="micon"><a class="exi" href="#expand"> </a></td>
1778 <a id="Roo.BasicLayoutRegion-event-*invalidated"></a>
1780 <div class="fixedFont">
1781 <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>)
1787 <div class="short">Fires when the layout for this region is changed.
1793 Fires when the layout for this region is changed.
1799 <dl class="detailList">
1800 <dt class="heading">Parameters:</dt>
1803 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1824 <td class="msource">
1825 Roo.BasicLayoutRegion
1829 <tr class="method-row expandable config-row-alt0 notInherited">
1830 <td class="micon"><a class="exi" href="#expand"> </a></td>
1833 <a id="Roo.BasicLayoutRegion-event-*panelactivated"></a>
1835 <div class="fixedFont">
1836 <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>)
1842 <div class="short">Fires when a panel is activated.
1848 Fires when a panel is activated.
1854 <dl class="detailList">
1855 <dt class="heading">Parameters:</dt>
1858 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1864 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1867 <dd>The activated panel</dd>
1885 <td class="msource">
1886 Roo.BasicLayoutRegion
1890 <tr class="method-row expandable config-row-alt1 notInherited">
1891 <td class="micon"><a class="exi" href="#expand"> </a></td>
1894 <a id="Roo.BasicLayoutRegion-event-*paneladded"></a>
1896 <div class="fixedFont">
1897 <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>)
1903 <div class="short">Fires when a panel is added.
1909 Fires when a panel is added.
1915 <dl class="detailList">
1916 <dt class="heading">Parameters:</dt>
1919 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1925 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
1946 <td class="msource">
1947 Roo.BasicLayoutRegion
1951 <tr class="method-row expandable config-row-alt0 notInherited">
1952 <td class="micon"><a class="exi" href="#expand"> </a></td>
1955 <a id="Roo.BasicLayoutRegion-event-*panelremoved"></a>
1957 <div class="fixedFont">
1958 <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>)
1964 <div class="short">Fires when a panel is removed.
1970 Fires when a panel is removed.
1976 <dl class="detailList">
1977 <dt class="heading">Parameters:</dt>
1980 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
1986 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
2007 <td class="msource">
2008 Roo.BasicLayoutRegion
2012 <tr class="method-row expandable config-row-alt1 notInherited">
2013 <td class="micon"><a class="exi" href="#expand"> </a></td>
2016 <a id="Roo.BasicLayoutRegion-event-*resized"></a>
2018 <div class="fixedFont">
2019 <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>)
2025 <div class="short">Fires when the user resizes this region.
2031 Fires when the user resizes this region.
2037 <dl class="detailList">
2038 <dt class="heading">Parameters:</dt>
2041 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2047 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2050 <dd>The new size (width for east/west, height for north/south)</dd>
2068 <td class="msource">
2069 Roo.BasicLayoutRegion
2073 <tr class="method-row expandable config-row-alt0 notInherited">
2074 <td class="micon"><a class="exi" href="#expand"> </a></td>
2077 <a id="Roo.BasicLayoutRegion-event-*slidehide"></a>
2079 <div class="fixedFont">
2080 <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>)
2086 <div class="short">Fires when this region slides out of view.
2092 Fires when this region slides out of view.
2098 <dl class="detailList">
2099 <dt class="heading">Parameters:</dt>
2102 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2123 <td class="msource">
2124 Roo.BasicLayoutRegion
2128 <tr class="method-row expandable config-row-alt1 notInherited">
2129 <td class="micon"><a class="exi" href="#expand"> </a></td>
2132 <a id="Roo.BasicLayoutRegion-event-*slideshow"></a>
2134 <div class="fixedFont">
2135 <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>)
2141 <div class="short">Fires when this region is slid into view.
2147 Fires when this region is slid into view.
2153 <dl class="detailList">
2154 <dt class="heading">Parameters:</dt>
2157 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2178 <td class="msource">
2179 Roo.BasicLayoutRegion
2183 <tr class="method-row expandable config-row-alt0 notInherited">
2184 <td class="micon"><a class="exi" href="#expand"> </a></td>
2187 <a id="Roo.BasicLayoutRegion-event-*visibilitychange"></a>
2189 <div class="fixedFont">
2190 <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>)
2196 <div class="short">Fires when this region is shown or hidden
2202 Fires when this region is shown or hidden
2208 <dl class="detailList">
2209 <dt class="heading">Parameters:</dt>
2212 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2218 <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>
2221 <dd>true or false</dd>
2239 <td class="msource">
2240 Roo.BasicLayoutRegion
2251 <!-- ============================== footer ================================= -->
2252 <div class="fineprint" style="clear:both">
2254 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT)
2256 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob