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.LayoutRegion</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.LayoutRegion-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.LayoutRegion-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.LayoutRegion-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.LayoutRegion-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.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.LayoutRegion
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
58 Class Roo.LayoutRegion
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_LayoutRegion.js.html">Roo/LayoutRegion.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">LayoutRegion</td></tr>
73 <tr><td class="label">Subclasses:</td><td class="hd-info">
74 <a href="./Roo.SplitLayoutRegion.html#constructor" roo:cls="Roo.SplitLayoutRegion.html#constructor">Roo.SplitLayoutRegion</a>
82 <tr><td class="label">Extends:</td><td class="hd-info">
83 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
91 <!-- ============================== class summary ========================== -->
92 <div class="description">
93 This class represents a region in a layout manager.
97 <!-- ============================== Class comment block... ========================== -->
99 <div class="comments">
100 <b>Class Comments / Notes</B> =>
101 <u onclick="parent.CommentDialog.showCommentId = 'Roo.LayoutRegion';">[Add Your comment/notes about this class]</u>
103 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
104 src="/blog.php/GtkDjsComments/Roo.LayoutRegion.html"></iframe>
109 <!-- ============================== config options ========================== -->
114 <div class="hr"></div>
115 <a id="Roo.LayoutRegion-configs"></a>
121 <table cellspacing="0" class="member-table">
122 <caption>Config Options (Usually are also Properties)</caption>
126 <th class="sig-header" colspan="2">Options</th>
128 <th class="msource-header">Defined By</th>
135 <tr class="config-row expandable config-row-alt0 notInherited">
136 <td class="micon"><a class="exi" href="#expand"> </a></td>
139 <a id="Roo.LayoutRegion-cfg-alwaysShowTabs" name=".alwaysShowTabs"></a>
140 <div class="fixedFont">
141 <b class="itemname">alwaysShowTabs</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
147 <div class="short">True to always display tabs even when there is only 1 panel (defaults to false)</div>
151 <div class="long">True to always display tabs even when there is only 1 panel (defaults to false)</div>
165 <tr class="config-row expandable config-row-alt1 notInherited">
166 <td class="micon"><a class="exi" href="#expand"> </a></td>
169 <a id="Roo.LayoutRegion-cfg-animate" name=".animate"></a>
170 <div class="fixedFont">
171 <b class="itemname">animate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
177 <div class="short">True to animate expand/collapse (defaults to false)</div>
181 <div class="long">True to animate expand/collapse (defaults to false)</div>
195 <tr class="config-row expandable config-row-alt0 notInherited">
196 <td class="micon"><a class="exi" href="#expand"> </a></td>
199 <a id="Roo.LayoutRegion-cfg-autoHide" name=".autoHide"></a>
200 <div class="fixedFont">
201 <b class="itemname">autoHide</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
207 <div class="short">False to disable auto hiding when the mouse leaves the "floated" region (defaults to true)</div>
211 <div class="long">False to disable auto hiding when the mouse leaves the "floated" region (defaults to true)</div>
225 <tr class="config-row expandable config-row-alt1 notInherited">
226 <td class="micon"><a class="exi" href="#expand"> </a></td>
229 <a id="Roo.LayoutRegion-cfg-autoScroll" name=".autoScroll"></a>
230 <div class="fixedFont">
231 <b class="itemname">autoScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
237 <div class="short">True to enable overflow scrolling (defaults to false)</div>
241 <div class="long">True to enable overflow scrolling (defaults to false)</div>
255 <tr class="config-row expandable config-row-alt0 notInherited">
256 <td class="micon"><a class="exi" href="#expand"> </a></td>
259 <a id="Roo.LayoutRegion-cfg-closeOnTab" name=".closeOnTab"></a>
260 <div class="fixedFont">
261 <b class="itemname">closeOnTab</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
267 <div class="short">True to place the close icon on the tabs instead of the region titlebar (defaults to false)</div>
271 <div class="long">True to place the close icon on the tabs instead of the region titlebar (defaults to false)</div>
285 <tr class="config-row expandable config-row-alt1 notInherited">
286 <td class="micon"><a class="exi" href="#expand"> </a></td>
289 <a id="Roo.LayoutRegion-cfg-cmargins" name=".cmargins"></a>
290 <div class="fixedFont">
291 <b class="itemname">cmargins</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
297 <div class="short">Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})</div>
301 <div class="long">Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})</div>
315 <tr class="config-row expandable config-row-alt0 notInherited">
316 <td class="micon"><a class="exi" href="#expand"> </a></td>
319 <a id="Roo.LayoutRegion-cfg-collapsed" name=".collapsed"></a>
320 <div class="fixedFont">
321 <b class="itemname">collapsed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
327 <div class="short">True to set the initial display to collapsed (defaults to false)</div>
331 <div class="long">True to set the initial display to collapsed (defaults to false)</div>
345 <tr class="config-row expandable config-row-alt1 notInherited">
346 <td class="micon"><a class="exi" href="#expand"> </a></td>
349 <a id="Roo.LayoutRegion-cfg-collapsedTitle" name=".collapsedTitle"></a>
350 <div class="fixedFont">
351 <b class="itemname">collapsedTitle</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
357 <div class="short">Optional string message to display in the collapsed block of a north or south region</div>
361 <div class="long">Optional string message to display in the collapsed block of a north or south region</div>
375 <tr class="config-row expandable config-row-alt0 notInherited">
376 <td class="micon"><a class="exi" href="#expand"> </a></td>
379 <a id="Roo.LayoutRegion-cfg-collapsible" name=".collapsible"></a>
380 <div class="fixedFont">
381 <b class="itemname">collapsible</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
387 <div class="short">False to disable collapsing (defaults to true)</div>
391 <div class="long">False to disable collapsing (defaults to true)</div>
405 <tr class="config-row expandable config-row-alt1 notInherited">
406 <td class="micon"><a class="exi" href="#expand"> </a></td>
409 <a id="Roo.LayoutRegion-cfg-disableTabTips" name=".disableTabTips"></a>
410 <div class="fixedFont">
411 <b class="itemname">disableTabTips</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
417 <div class="short">True to disable tab tooltips</div>
421 <div class="long">True to disable tab tooltips</div>
435 <tr class="config-row expandable config-row-alt0 notInherited">
436 <td class="micon"><a class="exi" href="#expand"> </a></td>
439 <a id="Roo.LayoutRegion-cfg-floatable" name=".floatable"></a>
440 <div class="fixedFont">
441 <b class="itemname">floatable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
447 <div class="short">False to disable floating (defaults to true)</div>
451 <div class="long">False to disable floating (defaults to true)</div>
465 <tr class="config-row expandable config-row-alt1 notInherited">
466 <td class="micon"><a class="exi" href="#expand"> </a></td>
469 <a id="Roo.LayoutRegion-cfg-height" name=".height"></a>
470 <div class="fixedFont">
471 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
477 <div class="short">For North/South panels</div>
481 <div class="long">For North/South panels</div>
495 <tr class="config-row expandable config-row-alt0 notInherited">
496 <td class="micon"><a class="exi" href="#expand"> </a></td>
499 <a id="Roo.LayoutRegion-cfg-hidden" name=".hidden"></a>
500 <div class="fixedFont">
501 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
507 <div class="short">True to start the region hidden (defaults to false)</div>
511 <div class="long">True to start the region hidden (defaults to false)</div>
525 <tr class="config-row expandable config-row-alt1 notInherited">
526 <td class="micon"><a class="exi" href="#expand"> </a></td>
529 <a id="Roo.LayoutRegion-cfg-hideTabs" name=".hideTabs"></a>
530 <div class="fixedFont">
531 <b class="itemname">hideTabs</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
537 <div class="short">True to hide the tab strip (defaults to false)</div>
541 <div class="long">True to hide the tab strip (defaults to false)</div>
555 <tr class="config-row expandable config-row-alt0 notInherited">
556 <td class="micon"><a class="exi" href="#expand"> </a></td>
559 <a id="Roo.LayoutRegion-cfg-hideWhenEmpty" name=".hideWhenEmpty"></a>
560 <div class="fixedFont">
561 <b class="itemname">hideWhenEmpty</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
567 <div class="short">True to hide the region when it has no panels</div>
571 <div class="long">True to hide the region when it has no panels</div>
585 <tr class="config-row expandable config-row-alt1">
586 <td class="micon"><a class="exi" href="#expand"> </a></td>
589 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
590 <div class="fixedFont">
591 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
597 <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>
601 <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>
609 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
615 <tr class="config-row expandable config-row-alt0 notInherited">
616 <td class="micon"><a class="exi" href="#expand"> </a></td>
619 <a id="Roo.LayoutRegion-cfg-margins" name=".margins"></a>
620 <div class="fixedFont">
621 <b class="itemname">margins</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
627 <div class="short">Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})</div>
631 <div class="long">Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})</div>
645 <tr class="config-row expandable config-row-alt1 notInherited">
646 <td class="micon"><a class="exi" href="#expand"> </a></td>
649 <a id="Roo.LayoutRegion-cfg-minTabWidth" name=".minTabWidth"></a>
650 <div class="fixedFont">
651 <b class="itemname">minTabWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
657 <div class="short">The minimum tab width (defaults to 40)</div>
661 <div class="long">The minimum tab width (defaults to 40)</div>
675 <tr class="config-row expandable config-row-alt0 notInherited">
676 <td class="micon"><a class="exi" href="#expand"> </a></td>
679 <a id="Roo.LayoutRegion-cfg-preferredTabWidth" name=".preferredTabWidth"></a>
680 <div class="fixedFont">
681 <b class="itemname">preferredTabWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
687 <div class="short">The preferred tab width (defaults to 150)</div>
691 <div class="long">The preferred tab width (defaults to 150)</div>
705 <tr class="config-row expandable config-row-alt1 notInherited">
706 <td class="micon"><a class="exi" href="#expand"> </a></td>
709 <a id="Roo.LayoutRegion-cfg-preservePanels" name=".preservePanels"></a>
710 <div class="fixedFont">
711 <b class="itemname">preservePanels</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
717 <div class="short">True to preserve removed panels so they can be readded later (defaults to false)</div>
721 <div class="long">True to preserve removed panels so they can be readded later (defaults to false)</div>
735 <tr class="config-row expandable config-row-alt0 notInherited">
736 <td class="micon"><a class="exi" href="#expand"> </a></td>
739 <a id="Roo.LayoutRegion-cfg-resizeTabs" name=".resizeTabs"></a>
740 <div class="fixedFont">
741 <b class="itemname">resizeTabs</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
747 <div class="short">True to enable automatic tab resizing.</div>
751 <div class="long">True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within<br/> the space available, similar to FireFox 1.5 tabs (defaults to false)</div>
765 <tr class="config-row expandable config-row-alt1 notInherited">
766 <td class="micon"><a class="exi" href="#expand"> </a></td>
769 <a id="Roo.LayoutRegion-cfg-showPin" name=".showPin"></a>
770 <div class="fixedFont">
771 <b class="itemname">showPin</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
777 <div class="short">True to show a pin button</div>
781 <div class="long">True to show a pin button</div>
795 <tr class="config-row expandable config-row-alt0 notInherited">
796 <td class="micon"><a class="exi" href="#expand"> </a></td>
799 <a id="Roo.LayoutRegion-cfg-split" name=".split"></a>
800 <div class="fixedFont">
801 <b class="itemname">split</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
807 <div class="short">To show the splitter</div>
811 <div class="long">To show the splitter</div>
825 <tr class="config-row expandable config-row-alt1 notInherited">
826 <td class="micon"><a class="exi" href="#expand"> </a></td>
829 <a id="Roo.LayoutRegion-cfg-tabPosition" name=".tabPosition"></a>
830 <div class="fixedFont">
831 <b class="itemname">tabPosition</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
837 <div class="short">"top" or "bottom" (defaults to "bottom")</div>
841 <div class="long">"top" or "bottom" (defaults to "bottom")</div>
855 <tr class="config-row expandable config-row-alt0 notInherited">
856 <td class="micon"><a class="exi" href="#expand"> </a></td>
859 <a id="Roo.LayoutRegion-cfg-title" name=".title"></a>
860 <div class="fixedFont">
861 <b class="itemname">title</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
867 <div class="short">The title for the region (overrides panel titles)</div>
871 <div class="long">The title for the region (overrides panel titles)</div>
885 <tr class="config-row expandable config-row-alt1 notInherited">
886 <td class="micon"><a class="exi" href="#expand"> </a></td>
889 <a id="Roo.LayoutRegion-cfg-titlebar" name=".titlebar"></a>
890 <div class="fixedFont">
891 <b class="itemname">titlebar</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
897 <div class="short">True to display a title bar (defaults to true)</div>
901 <div class="long">True to display a title bar (defaults to true)</div>
915 <tr class="config-row expandable config-row-alt0 notInherited">
916 <td class="micon"><a class="exi" href="#expand"> </a></td>
919 <a id="Roo.LayoutRegion-cfg-toolbar" name=".toolbar"></a>
920 <div class="fixedFont">
921 <b class="itemname">toolbar</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
927 <div class="short">xtype configuration for a toolbar - shows on right of tabbar</div>
931 <div class="long">xtype configuration for a toolbar - shows on right of tabbar</div>
945 <tr class="config-row expandable config-row-alt1 notInherited">
946 <td class="micon"><a class="exi" href="#expand"> </a></td>
949 <a id="Roo.LayoutRegion-cfg-width" name=".width"></a>
950 <div class="fixedFont">
951 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
957 <div class="short">For East/West panels</div>
961 <div class="long">For East/West panels</div>
985 <!-- ============================== public properties ==================== -->
989 <a id="Roo.LayoutRegion-props"></a>
995 <table cellspacing="0" class="member-table">
996 <caption class="Empty">Public Properties - Has None</caption>
1002 <!-- ============================== methods summary / details ======================== -->
1005 <a id="Roo.LayoutRegion-methods"></a>
1006 <!-- constructor?? -->
1013 <!-- then dynamics first -->
1020 <table cellspacing="0" class="member-table">
1021 <caption>Public Methods</caption>
1023 <th class="sig-header" colspan="2">Method</th>
1024 <th class="msource-header">Defined By</th>
1034 <tr class="method-row config-row-alt0 notInherited">
1035 <td class="micon"><a class="exi" href="#expand"> </a></td>
1039 <a id="Roo-method-LayoutRegion" name=".LayoutRegion"></a>
1040 <div class="fixedFont">
1041 <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutRegion</b>
1051 <div class="short">Create a new Roo.LayoutRegion</div>
1058 Create a new Roo.LayoutRegion
1075 <td class="msource">
1081 <tr class="method-row config-row-alt1 expandable notInherited">
1082 <td class="micon"><a class="exi" href="#expand"> </a></td>
1086 <a id="Roo.LayoutRegion-method-add" name=".add"></a>
1087 <div class="fixedFont">
1088 <span class="attributes"></span><b class="itemname">add</b>
1090 (ContentPanel... <B><i>panel</i></B>)
1096 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1105 <div class="short">Adds the passed ContentPanel(s) to this region.</div>
1111 Adds the passed ContentPanel(s) to this region.
1118 <dl class="detailList">
1119 <dt class="heading">Parameters:</dt>
1122 <span class="fixedFont">ContentPanel...</span> <b>panel</b>
1125 <dd>The ContentPanel(s) to add (you can pass more than one)</dd>
1133 <dl class="detailList">
1134 <dt class="heading">Returns:</dt>
1136 <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; null otherwise)</dd>
1150 <td class="msource">
1158 <tr class="method-row config-row-alt0 expandable">
1159 <td class="micon"><a class="exi" href="#expand"> </a></td>
1163 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1164 <div class="fixedFont">
1165 <span class="attributes"></span><b class="itemname">addEvents</b>
1167 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1174 <div class="short">Used to define events on this Observable</div>
1180 Used to define events on this Observable
1187 <dl class="detailList">
1188 <dt class="heading">Parameters:</dt>
1191 <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>
1194 <dd>The object with the events defined</dd>
1212 <td class="msource">
1214 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1220 <tr class="method-row config-row-alt1 expandable">
1221 <td class="micon"><a class="exi" href="#expand"> </a></td>
1225 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1226 <div class="fixedFont">
1227 <span class="attributes"></span><b class="itemname">addListener</b>
1229 (<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>)
1236 <div class="short">Appends an event handler to this component</div>
1242 Appends an event handler to this component
1249 <dl class="detailList">
1250 <dt class="heading">Parameters:</dt>
1253 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1256 <dd>The type of event to listen for</dd>
1259 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1262 <dd>The method the event invokes</dd>
1265 <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>
1268 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1271 <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>
1274 <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>
1292 <td class="msource">
1294 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1300 <tr class="method-row config-row-alt0 expandable notInherited">
1301 <td class="micon"><a class="exi" href="#expand"> </a></td>
1305 <a id="Roo.LayoutRegion-method-collapse" name=".collapse"></a>
1306 <div class="fixedFont">
1307 <span class="attributes"></span><b class="itemname">collapse</b>
1309 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>skipAnim</i></B>)
1316 <div class="short">Collapses this region.</div>
1322 Collapses this region.
1329 <dl class="detailList">
1330 <dt class="heading">Parameters:</dt>
1333 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>skipAnim</b>
1336 <dd>(optional) true to collapse the element without animation (if animate is true)</dd>
1354 <td class="msource">
1362 <tr class="method-row config-row-alt1 expandable notInherited">
1363 <td class="micon"><a class="exi" href="#expand"> </a></td>
1367 <a id="Roo.LayoutRegion-method-expand" name=".expand"></a>
1368 <div class="fixedFont">
1369 <span class="attributes"></span><b class="itemname">expand</b>
1371 (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>skipAnim</i></B>)
1378 <div class="short">Expands this region if it was previously collapsed.</div>
1384 Expands this region if it was previously collapsed.
1391 <dl class="detailList">
1392 <dt class="heading">Parameters:</dt>
1395 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1398 <dd>The event that triggered the expand (or null if calling manually)</dd>
1401 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>skipAnim</b>
1404 <dd>(optional) true to expand the element without animation (if animate is true)</dd>
1422 <td class="msource">
1430 <tr class="method-row config-row-alt0 expandable">
1431 <td class="micon"><a class="exi" href="#expand"> </a></td>
1435 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1436 <div class="fixedFont">
1437 <span class="attributes"></span><b class="itemname">fireEvent</b>
1439 (<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>)
1445 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1454 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1460 Fires the specified event with the passed parameters (minus the event name).
1467 <dl class="detailList">
1468 <dt class="heading">Parameters:</dt>
1471 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1477 <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>
1480 <dd>Variable number of parameters are passed to handlers</dd>
1488 <dl class="detailList">
1489 <dt class="heading">Returns:</dt>
1491 <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>
1505 <td class="msource">
1507 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1513 <tr class="method-row config-row-alt1 expandable notInherited">
1514 <td class="micon"><a class="exi" href="#expand"> </a></td>
1518 <a id="Roo.LayoutRegion-method-getActivePanel" name=".getActivePanel"></a>
1519 <div class="fixedFont">
1520 <span class="attributes"></span><b class="itemname">getActivePanel</b>
1528 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1537 <div class="short">Get the active panel for this region.</div>
1543 Get the active panel for this region.
1554 <dl class="detailList">
1555 <dt class="heading">Returns:</dt>
1557 <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>
1571 <td class="msource">
1579 <tr class="method-row config-row-alt0 expandable notInherited">
1580 <td class="micon"><a class="exi" href="#expand"> </a></td>
1584 <a id="Roo.LayoutRegion-method-getEl" name=".getEl"></a>
1585 <div class="fixedFont">
1586 <span class="attributes"></span><b class="itemname">getEl</b>
1594 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1603 <div class="short">Returns the container element for this region.</div>
1609 Returns the container element for this region.
1620 <dl class="detailList">
1621 <dt class="heading">Returns:</dt>
1623 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1637 <td class="msource">
1645 <tr class="method-row config-row-alt1 expandable">
1646 <td class="micon"><a class="exi" href="#expand"> </a></td>
1650 <a id="Roo.BasicLayoutRegion-method-getPanel" name=".getPanel"></a>
1651 <div class="fixedFont">
1652 <span class="attributes"></span><b class="itemname">getPanel</b>
1654 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
1660 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1669 <div class="short">Returns the panel specified or null if it's not in this region.</div>
1675 Returns the panel specified or null if it's not in this region.
1682 <dl class="detailList">
1683 <dt class="heading">Parameters:</dt>
1686 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1689 <dd>The panels index, id or the panel itself</dd>
1697 <dl class="detailList">
1698 <dt class="heading">Returns:</dt>
1700 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> </dd>
1714 <td class="msource">
1716 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1722 <tr class="method-row config-row-alt0 expandable">
1723 <td class="micon"><a class="exi" href="#expand"> </a></td>
1727 <a id="Roo.BasicLayoutRegion-method-getPosition" name=".getPosition"></a>
1728 <div class="fixedFont">
1729 <span class="attributes"></span><b class="itemname">getPosition</b>
1737 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1746 <div class="short">Returns this regions position (north/south/east/west/center).</div>
1752 Returns this regions position (north/south/east/west/center).
1763 <dl class="detailList">
1764 <dt class="heading">Returns:</dt>
1766 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1780 <td class="msource">
1782 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1788 <tr class="method-row config-row-alt1 expandable notInherited">
1789 <td class="micon"><a class="exi" href="#expand"> </a></td>
1793 <a id="Roo.LayoutRegion-method-getTabs" name=".getTabs"></a>
1794 <div class="fixedFont">
1795 <span class="attributes"></span><b class="itemname">getTabs</b>
1803 <a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a>
1812 <div class="short">Returns the TabPanel component used by this region</div>
1818 Returns the TabPanel component used by this region
1829 <dl class="detailList">
1830 <dt class="heading">Returns:</dt>
1832 <dd><span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> </dd>
1846 <td class="msource">
1854 <tr class="method-row config-row-alt0 expandable">
1855 <td class="micon"><a class="exi" href="#expand"> </a></td>
1859 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1860 <div class="fixedFont">
1861 <span class="attributes"></span><b class="itemname">hasListener</b>
1863 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1869 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1878 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1884 Checks to see if this object has any listeners for a specified event
1891 <dl class="detailList">
1892 <dt class="heading">Parameters:</dt>
1895 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1898 <dd>The name of the event to check for</dd>
1906 <dl class="detailList">
1907 <dt class="heading">Returns:</dt>
1909 <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>
1923 <td class="msource">
1925 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1931 <tr class="method-row config-row-alt1 expandable">
1932 <td class="micon"><a class="exi" href="#expand"> </a></td>
1936 <a id="Roo.BasicLayoutRegion-method-hasPanel" name=".hasPanel"></a>
1937 <div class="fixedFont">
1938 <span class="attributes"></span><b class="itemname">hasPanel</b>
1940 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
1946 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1955 <div class="short">Returns true if the panel is in this region.</div>
1961 Returns true if the panel is in this region.
1968 <dl class="detailList">
1969 <dt class="heading">Parameters:</dt>
1972 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1975 <dd>The panels index, id or the panel itself</dd>
1983 <dl class="detailList">
1984 <dt class="heading">Returns:</dt>
1986 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2000 <td class="msource">
2002 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2008 <tr class="method-row config-row-alt0 expandable notInherited">
2009 <td class="micon"><a class="exi" href="#expand"> </a></td>
2013 <a id="Roo.LayoutRegion-method-hide" name=".hide"></a>
2014 <div class="fixedFont">
2015 <span class="attributes"></span><b class="itemname">hide</b>
2024 <div class="short">Hides this region.</div>
2051 <td class="msource">
2059 <tr class="method-row config-row-alt1 expandable notInherited">
2060 <td class="micon"><a class="exi" href="#expand"> </a></td>
2064 <a id="Roo.LayoutRegion-method-hidePanel" name=".hidePanel"></a>
2065 <div class="fixedFont">
2066 <span class="attributes"></span><b class="itemname">hidePanel</b>
2068 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2075 <div class="short">Hides the tab for the specified panel.</div>
2081 Hides the tab for the specified panel.
2088 <dl class="detailList">
2089 <dt class="heading">Parameters:</dt>
2092 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2095 <dd>The panel's index, id or the panel itself</dd>
2113 <td class="msource">
2121 <tr class="method-row config-row-alt0 expandable notInherited">
2122 <td class="micon"><a class="exi" href="#expand"> </a></td>
2126 <a id="Roo.LayoutRegion-method-isVisible" name=".isVisible"></a>
2127 <div class="fixedFont">
2128 <span class="attributes"></span><b class="itemname">isVisible</b>
2136 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2145 <div class="short">Returns true if this region is currently visible.</div>
2151 Returns true if this region is currently visible.
2162 <dl class="detailList">
2163 <dt class="heading">Returns:</dt>
2165 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2179 <td class="msource">
2187 <tr class="method-row config-row-alt1 expandable">
2188 <td class="micon"><a class="exi" href="#expand"> </a></td>
2192 <a id="Roo.util.Observable-method-on" name=".on"></a>
2193 <div class="fixedFont">
2194 <span class="attributes"></span><b class="itemname">on</b>
2196 (<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>)
2203 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2209 Appends an event handler to this element (shorthand for addListener)
2216 <dl class="detailList">
2217 <dt class="heading">Parameters:</dt>
2220 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2223 <dd>The type of event to listen for</dd>
2226 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2229 <dd>The method the event invokes</dd>
2232 <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>
2235 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2238 <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>
2259 <td class="msource">
2261 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2267 <tr class="method-row config-row-alt0 expandable">
2268 <td class="micon"><a class="exi" href="#expand"> </a></td>
2272 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2273 <div class="fixedFont">
2274 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2283 <div class="short">Removes all listeners for this object</div>
2289 Removes all listeners for this object
2310 <td class="msource">
2312 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2318 <tr class="method-row config-row-alt1 expandable notInherited">
2319 <td class="micon"><a class="exi" href="#expand"> </a></td>
2323 <a id="Roo.LayoutRegion-method-remove" name=".remove"></a>
2324 <div class="fixedFont">
2325 <span class="attributes"></span><b class="itemname">remove</b>
2327 (<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>)
2333 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
2342 <div class="short">Removes the specified panel.</div>
2348 Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
2355 <dl class="detailList">
2356 <dt class="heading">Parameters:</dt>
2359 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2362 <dd>The panel's index, id or the panel itself</dd>
2365 <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>
2368 <dd>Overrides the config preservePanel option</dd>
2376 <dl class="detailList">
2377 <dt class="heading">Returns:</dt>
2379 <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>
2393 <td class="msource">
2401 <tr class="method-row config-row-alt0 expandable">
2402 <td class="micon"><a class="exi" href="#expand"> </a></td>
2406 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2407 <div class="fixedFont">
2408 <span class="attributes"></span><b class="itemname">removeListener</b>
2410 (<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>)
2417 <div class="short">Removes a listener</div>
2430 <dl class="detailList">
2431 <dt class="heading">Parameters:</dt>
2434 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2437 <dd>The type of event to listen for</dd>
2440 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2443 <dd>The handler to remove</dd>
2446 <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>
2449 <dd>(optional) The scope (this object) for the handler</dd>
2467 <td class="msource">
2469 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2475 <tr class="method-row config-row-alt1 expandable">
2476 <td class="micon"><a class="exi" href="#expand"> </a></td>
2480 <a id="Roo.BasicLayoutRegion-method-resizeTo" name=".resizeTo"></a>
2481 <div class="fixedFont">
2482 <span class="attributes"></span><b class="itemname">resizeTo</b>
2484 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
2491 <div class="short">Resizes the region to the specified size.</div>
2497 Resizes the region to the specified size. For vertical regions (west, east) this adjusts <br/>the width, for horizontal (north, south) the height.
2504 <dl class="detailList">
2505 <dt class="heading">Parameters:</dt>
2508 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2511 <dd>The new width or height</dd>
2529 <td class="msource">
2531 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2537 <tr class="method-row config-row-alt0 expandable notInherited">
2538 <td class="micon"><a class="exi" href="#expand"> </a></td>
2542 <a id="Roo.LayoutRegion-method-setCollapsedTitle" name=".setCollapsedTitle"></a>
2543 <div class="fixedFont">
2544 <span class="attributes"></span><b class="itemname">setCollapsedTitle</b>
2546 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>)
2553 <div class="short">Updates the title for collapsed north/south regions (used with {<b>link</b> <b>collapsedTitle</b>} config option)</div>
2559 Updates the title for collapsed north/south regions (used with {<b>link</b> <b>collapsedTitle</b>} config option)
2566 <dl class="detailList">
2567 <dt class="heading">Parameters:</dt>
2570 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
2573 <dd>(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, "&#160;")</dd>
2591 <td class="msource">
2599 <tr class="method-row config-row-alt1 expandable notInherited">
2600 <td class="micon"><a class="exi" href="#expand"> </a></td>
2604 <a id="Roo.LayoutRegion-method-show" name=".show"></a>
2605 <div class="fixedFont">
2606 <span class="attributes"></span><b class="itemname">show</b>
2615 <div class="short">Shows this region if it was previously hidden.</div>
2621 Shows this region if it was previously hidden.
2642 <td class="msource">
2650 <tr class="method-row config-row-alt0 expandable notInherited">
2651 <td class="micon"><a class="exi" href="#expand"> </a></td>
2655 <a id="Roo.LayoutRegion-method-showPanel" name=".showPanel"></a>
2656 <div class="fixedFont">
2657 <span class="attributes"></span><b class="itemname">showPanel</b>
2659 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panelId</i></B>)
2665 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
2674 <div class="short">Shows the specified panel.</div>
2680 Shows the specified panel.
2687 <dl class="detailList">
2688 <dt class="heading">Parameters:</dt>
2691 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panelId</b>
2694 <dd>The panel's index, id or the panel itself</dd>
2702 <dl class="detailList">
2703 <dt class="heading">Returns:</dt>
2705 <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 if a panel could not be found from panelId</dd>
2719 <td class="msource">
2727 <tr class="method-row config-row-alt1 expandable">
2728 <td class="micon"><a class="exi" href="#expand"> </a></td>
2732 <a id="Roo.util.Observable-method-un" name=".un"></a>
2733 <div class="fixedFont">
2734 <span class="attributes"></span><b class="itemname">un</b>
2736 (<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>)
2743 <div class="short">Removes a listener (shorthand for removeListener)</div>
2749 Removes a listener (shorthand for removeListener)
2756 <dl class="detailList">
2757 <dt class="heading">Parameters:</dt>
2760 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2763 <dd>The type of event to listen for</dd>
2766 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2769 <dd>The handler to remove</dd>
2772 <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>
2775 <dd>(optional) The scope (this object) for the handler</dd>
2793 <td class="msource">
2795 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2801 <tr class="method-row config-row-alt0 expandable notInherited">
2802 <td class="micon"><a class="exi" href="#expand"> </a></td>
2806 <a id="Roo.LayoutRegion-method-unhidePanel" name=".unhidePanel"></a>
2807 <div class="fixedFont">
2808 <span class="attributes"></span><b class="itemname">unhidePanel</b>
2810 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2817 <div class="short">Unhides the tab for a previously hidden panel.</div>
2823 Unhides the tab for a previously hidden panel.
2830 <dl class="detailList">
2831 <dt class="heading">Parameters:</dt>
2834 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2837 <dd>The panel's index, id or the panel itself</dd>
2855 <td class="msource">
2866 <!-- ============================== events summary / details ======================== -->
2869 <a id="Roo.LayoutRegion-events"></a>
2878 <table cellspacing="0" class="member-table">
2879 <caption>Events</caption>
2882 <th class="sig-header" colspan="2">Event</th>
2883 <th class="msource-header">Defined By</th>
2892 <tr class="method-row expandable config-row-alt0">
2893 <td class="micon"><a class="exi" href="#expand"> </a></td>
2896 <a id="Roo.BasicLayoutRegion-event-*beforeremove"></a>
2898 <div class="fixedFont">
2899 <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>)
2905 <div class="short">Fires before a panel is removed (or closed).
2911 Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
2917 <dl class="detailList">
2918 <dt class="heading">Parameters:</dt>
2921 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2927 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
2933 <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>
2936 <dd>The cancel event object</dd>
2954 <td class="msource">
2955 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2959 <tr class="method-row expandable config-row-alt1">
2960 <td class="micon"><a class="exi" href="#expand"> </a></td>
2963 <a id="Roo.BasicLayoutRegion-event-*collapsed"></a>
2965 <div class="fixedFont">
2966 <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>)
2972 <div class="short">Fires when this region is collapsed.
2978 Fires when this region is collapsed.
2984 <dl class="detailList">
2985 <dt class="heading">Parameters:</dt>
2988 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3009 <td class="msource">
3010 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3014 <tr class="method-row expandable config-row-alt0">
3015 <td class="micon"><a class="exi" href="#expand"> </a></td>
3018 <a id="Roo.BasicLayoutRegion-event-*expanded"></a>
3020 <div class="fixedFont">
3021 <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>)
3027 <div class="short">Fires when this region is expanded.
3033 Fires when this region is expanded.
3039 <dl class="detailList">
3040 <dt class="heading">Parameters:</dt>
3043 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3064 <td class="msource">
3065 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3069 <tr class="method-row expandable config-row-alt1">
3070 <td class="micon"><a class="exi" href="#expand"> </a></td>
3073 <a id="Roo.BasicLayoutRegion-event-*invalidated"></a>
3075 <div class="fixedFont">
3076 <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>)
3082 <div class="short">Fires when the layout for this region is changed.
3088 Fires when the layout for this region is changed.
3094 <dl class="detailList">
3095 <dt class="heading">Parameters:</dt>
3098 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3119 <td class="msource">
3120 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3124 <tr class="method-row expandable config-row-alt0">
3125 <td class="micon"><a class="exi" href="#expand"> </a></td>
3128 <a id="Roo.BasicLayoutRegion-event-*panelactivated"></a>
3130 <div class="fixedFont">
3131 <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>)
3137 <div class="short">Fires when a panel is activated.
3143 Fires when a panel is activated.
3149 <dl class="detailList">
3150 <dt class="heading">Parameters:</dt>
3153 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3159 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3162 <dd>The activated panel</dd>
3180 <td class="msource">
3181 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3185 <tr class="method-row expandable config-row-alt1">
3186 <td class="micon"><a class="exi" href="#expand"> </a></td>
3189 <a id="Roo.BasicLayoutRegion-event-*paneladded"></a>
3191 <div class="fixedFont">
3192 <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>)
3198 <div class="short">Fires when a panel is added.
3204 Fires when a panel is added.
3210 <dl class="detailList">
3211 <dt class="heading">Parameters:</dt>
3214 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3220 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3241 <td class="msource">
3242 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3246 <tr class="method-row expandable config-row-alt0">
3247 <td class="micon"><a class="exi" href="#expand"> </a></td>
3250 <a id="Roo.BasicLayoutRegion-event-*panelremoved"></a>
3252 <div class="fixedFont">
3253 <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>)
3259 <div class="short">Fires when a panel is removed.
3265 Fires when a panel is removed.
3271 <dl class="detailList">
3272 <dt class="heading">Parameters:</dt>
3275 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3281 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3302 <td class="msource">
3303 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3307 <tr class="method-row expandable config-row-alt1">
3308 <td class="micon"><a class="exi" href="#expand"> </a></td>
3311 <a id="Roo.BasicLayoutRegion-event-*resized"></a>
3313 <div class="fixedFont">
3314 <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>)
3320 <div class="short">Fires when the user resizes this region.
3326 Fires when the user resizes this region.
3332 <dl class="detailList">
3333 <dt class="heading">Parameters:</dt>
3336 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3342 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
3345 <dd>The new size (width for east/west, height for north/south)</dd>
3363 <td class="msource">
3364 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3368 <tr class="method-row expandable config-row-alt0">
3369 <td class="micon"><a class="exi" href="#expand"> </a></td>
3372 <a id="Roo.BasicLayoutRegion-event-*slidehide"></a>
3374 <div class="fixedFont">
3375 <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>)
3381 <div class="short">Fires when this region slides out of view.
3387 Fires when this region slides out of view.
3393 <dl class="detailList">
3394 <dt class="heading">Parameters:</dt>
3397 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3418 <td class="msource">
3419 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3423 <tr class="method-row expandable config-row-alt1">
3424 <td class="micon"><a class="exi" href="#expand"> </a></td>
3427 <a id="Roo.BasicLayoutRegion-event-*slideshow"></a>
3429 <div class="fixedFont">
3430 <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>)
3436 <div class="short">Fires when this region is slid into view.
3442 Fires when this region is slid into view.
3448 <dl class="detailList">
3449 <dt class="heading">Parameters:</dt>
3452 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3473 <td class="msource">
3474 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3478 <tr class="method-row expandable config-row-alt0">
3479 <td class="micon"><a class="exi" href="#expand"> </a></td>
3482 <a id="Roo.BasicLayoutRegion-event-*visibilitychange"></a>
3484 <div class="fixedFont">
3485 <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>)
3491 <div class="short">Fires when this region is shown or hidden
3497 Fires when this region is shown or hidden
3503 <dl class="detailList">
3504 <dt class="heading">Parameters:</dt>
3507 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3513 <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>
3516 <dd>true or false</dd>
3534 <td class="msource">
3535 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3546 <!-- ============================== footer ================================= -->
3547 <div class="fineprint" style="clear:both">
3549 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Dec 06 2011 15:43:32 GMT+0800 (HKT)
3551 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>