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-width" name=".width"></a>
920 <div class="fixedFont">
921 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
927 <div class="short">For East/West panels</div>
931 <div class="long">For East/West panels</div>
955 <!-- ============================== public properties ==================== -->
959 <a id="Roo.LayoutRegion-props"></a>
965 <table cellspacing="0" class="member-table">
966 <caption class="Empty">Public Properties - Has None</caption>
972 <!-- ============================== methods summary / details ======================== -->
975 <a id="Roo.LayoutRegion-methods"></a>
976 <!-- constructor?? -->
983 <!-- then dynamics first -->
990 <table cellspacing="0" class="member-table">
991 <caption>Public Methods</caption>
993 <th class="sig-header" colspan="2">Method</th>
994 <th class="msource-header">Defined By</th>
1004 <tr class="method-row config-row-alt0 notInherited">
1005 <td class="micon"><a class="exi" href="#expand"> </a></td>
1009 <a id="Roo-method-LayoutRegion" name=".LayoutRegion"></a>
1010 <div class="fixedFont">
1011 <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutRegion</b>
1021 <div class="short">Create a new Roo.LayoutRegion</div>
1028 Create a new Roo.LayoutRegion
1045 <td class="msource">
1051 <tr class="method-row config-row-alt1 expandable notInherited">
1052 <td class="micon"><a class="exi" href="#expand"> </a></td>
1056 <a id="Roo.LayoutRegion-method-add" name=".add"></a>
1057 <div class="fixedFont">
1058 <span class="attributes"></span><b class="itemname">add</b>
1060 (ContentPanel... <B><i>panel</i></B>)
1066 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1075 <div class="short">Adds the passed ContentPanel(s) to this region.</div>
1081 Adds the passed ContentPanel(s) to this region.
1088 <dl class="detailList">
1089 <dt class="heading">Parameters:</dt>
1092 <span class="fixedFont">ContentPanel...</span> <b>panel</b>
1095 <dd>The ContentPanel(s) to add (you can pass more than one)</dd>
1103 <dl class="detailList">
1104 <dt class="heading">Returns:</dt>
1106 <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>
1120 <td class="msource">
1128 <tr class="method-row config-row-alt0 expandable">
1129 <td class="micon"><a class="exi" href="#expand"> </a></td>
1133 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1134 <div class="fixedFont">
1135 <span class="attributes"></span><b class="itemname">addEvents</b>
1137 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1144 <div class="short">Used to define events on this Observable</div>
1150 Used to define events on this Observable
1157 <dl class="detailList">
1158 <dt class="heading">Parameters:</dt>
1161 <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>
1164 <dd>The object with the events defined</dd>
1182 <td class="msource">
1184 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1190 <tr class="method-row config-row-alt1 expandable">
1191 <td class="micon"><a class="exi" href="#expand"> </a></td>
1195 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1196 <div class="fixedFont">
1197 <span class="attributes"></span><b class="itemname">addListener</b>
1199 (<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>)
1206 <div class="short">Appends an event handler to this component</div>
1212 Appends an event handler to this component
1219 <dl class="detailList">
1220 <dt class="heading">Parameters:</dt>
1223 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1226 <dd>The type of event to listen for</dd>
1229 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1232 <dd>The method the event invokes</dd>
1235 <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>
1238 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1241 <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>
1244 <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>
1262 <td class="msource">
1264 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1270 <tr class="method-row config-row-alt0 expandable notInherited">
1271 <td class="micon"><a class="exi" href="#expand"> </a></td>
1275 <a id="Roo.LayoutRegion-method-collapse" name=".collapse"></a>
1276 <div class="fixedFont">
1277 <span class="attributes"></span><b class="itemname">collapse</b>
1279 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>skipAnim</i></B>)
1286 <div class="short">Collapses this region.</div>
1292 Collapses this region.
1299 <dl class="detailList">
1300 <dt class="heading">Parameters:</dt>
1303 <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>
1306 <dd>(optional) true to collapse the element without animation (if animate is true)</dd>
1324 <td class="msource">
1332 <tr class="method-row config-row-alt1 expandable notInherited">
1333 <td class="micon"><a class="exi" href="#expand"> </a></td>
1337 <a id="Roo.LayoutRegion-method-expand" name=".expand"></a>
1338 <div class="fixedFont">
1339 <span class="attributes"></span><b class="itemname">expand</b>
1341 (<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>)
1348 <div class="short">Expands this region if it was previously collapsed.</div>
1354 Expands this region if it was previously collapsed.
1361 <dl class="detailList">
1362 <dt class="heading">Parameters:</dt>
1365 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1368 <dd>The event that triggered the expand (or null if calling manually)</dd>
1371 <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>
1374 <dd>(optional) true to expand the element without animation (if animate is true)</dd>
1392 <td class="msource">
1400 <tr class="method-row config-row-alt0 expandable">
1401 <td class="micon"><a class="exi" href="#expand"> </a></td>
1405 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1406 <div class="fixedFont">
1407 <span class="attributes"></span><b class="itemname">fireEvent</b>
1409 (<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>)
1415 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1424 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1430 Fires the specified event with the passed parameters (minus the event name).
1437 <dl class="detailList">
1438 <dt class="heading">Parameters:</dt>
1441 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1447 <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>
1450 <dd>Variable number of parameters are passed to handlers</dd>
1458 <dl class="detailList">
1459 <dt class="heading">Returns:</dt>
1461 <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>
1475 <td class="msource">
1477 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1483 <tr class="method-row config-row-alt1 expandable notInherited">
1484 <td class="micon"><a class="exi" href="#expand"> </a></td>
1488 <a id="Roo.LayoutRegion-method-getActivePanel" name=".getActivePanel"></a>
1489 <div class="fixedFont">
1490 <span class="attributes"></span><b class="itemname">getActivePanel</b>
1498 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1507 <div class="short">Get the active panel for this region.</div>
1513 Get the active panel for this region.
1524 <dl class="detailList">
1525 <dt class="heading">Returns:</dt>
1527 <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>
1541 <td class="msource">
1549 <tr class="method-row config-row-alt0 expandable notInherited">
1550 <td class="micon"><a class="exi" href="#expand"> </a></td>
1554 <a id="Roo.LayoutRegion-method-getEl" name=".getEl"></a>
1555 <div class="fixedFont">
1556 <span class="attributes"></span><b class="itemname">getEl</b>
1564 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1573 <div class="short">Returns the container element for this region.</div>
1579 Returns the container element for this region.
1590 <dl class="detailList">
1591 <dt class="heading">Returns:</dt>
1593 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1607 <td class="msource">
1615 <tr class="method-row config-row-alt1 expandable">
1616 <td class="micon"><a class="exi" href="#expand"> </a></td>
1620 <a id="Roo.BasicLayoutRegion-method-getPanel" name=".getPanel"></a>
1621 <div class="fixedFont">
1622 <span class="attributes"></span><b class="itemname">getPanel</b>
1624 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
1630 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1639 <div class="short">Returns the panel specified or null if it's not in this region.</div>
1645 Returns the panel specified or null if it's not in this region.
1652 <dl class="detailList">
1653 <dt class="heading">Parameters:</dt>
1656 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1659 <dd>The panels index, id or the panel itself</dd>
1667 <dl class="detailList">
1668 <dt class="heading">Returns:</dt>
1670 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> </dd>
1684 <td class="msource">
1686 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1692 <tr class="method-row config-row-alt0 expandable">
1693 <td class="micon"><a class="exi" href="#expand"> </a></td>
1697 <a id="Roo.BasicLayoutRegion-method-getPosition" name=".getPosition"></a>
1698 <div class="fixedFont">
1699 <span class="attributes"></span><b class="itemname">getPosition</b>
1707 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1716 <div class="short">Returns this regions position (north/south/east/west/center).</div>
1722 Returns this regions position (north/south/east/west/center).
1733 <dl class="detailList">
1734 <dt class="heading">Returns:</dt>
1736 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1750 <td class="msource">
1752 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1758 <tr class="method-row config-row-alt1 expandable notInherited">
1759 <td class="micon"><a class="exi" href="#expand"> </a></td>
1763 <a id="Roo.LayoutRegion-method-getTabs" name=".getTabs"></a>
1764 <div class="fixedFont">
1765 <span class="attributes"></span><b class="itemname">getTabs</b>
1773 <a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a>
1782 <div class="short">Returns the TabPanel component used by this region</div>
1788 Returns the TabPanel component used by this region
1799 <dl class="detailList">
1800 <dt class="heading">Returns:</dt>
1802 <dd><span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> </dd>
1816 <td class="msource">
1824 <tr class="method-row config-row-alt0 expandable">
1825 <td class="micon"><a class="exi" href="#expand"> </a></td>
1829 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1830 <div class="fixedFont">
1831 <span class="attributes"></span><b class="itemname">hasListener</b>
1833 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1839 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1848 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1854 Checks to see if this object has any listeners for a specified event
1861 <dl class="detailList">
1862 <dt class="heading">Parameters:</dt>
1865 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1868 <dd>The name of the event to check for</dd>
1876 <dl class="detailList">
1877 <dt class="heading">Returns:</dt>
1879 <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>
1893 <td class="msource">
1895 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1901 <tr class="method-row config-row-alt1 expandable">
1902 <td class="micon"><a class="exi" href="#expand"> </a></td>
1906 <a id="Roo.BasicLayoutRegion-method-hasPanel" name=".hasPanel"></a>
1907 <div class="fixedFont">
1908 <span class="attributes"></span><b class="itemname">hasPanel</b>
1910 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
1916 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1925 <div class="short">Returns true if the panel is in this region.</div>
1931 Returns true if the panel is in this region.
1938 <dl class="detailList">
1939 <dt class="heading">Parameters:</dt>
1942 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1945 <dd>The panels index, id or the panel itself</dd>
1953 <dl class="detailList">
1954 <dt class="heading">Returns:</dt>
1956 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1970 <td class="msource">
1972 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1978 <tr class="method-row config-row-alt0 expandable notInherited">
1979 <td class="micon"><a class="exi" href="#expand"> </a></td>
1983 <a id="Roo.LayoutRegion-method-hide" name=".hide"></a>
1984 <div class="fixedFont">
1985 <span class="attributes"></span><b class="itemname">hide</b>
1994 <div class="short">Hides this region.</div>
2021 <td class="msource">
2029 <tr class="method-row config-row-alt1 expandable notInherited">
2030 <td class="micon"><a class="exi" href="#expand"> </a></td>
2034 <a id="Roo.LayoutRegion-method-hidePanel" name=".hidePanel"></a>
2035 <div class="fixedFont">
2036 <span class="attributes"></span><b class="itemname">hidePanel</b>
2038 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2045 <div class="short">Hides the tab for the specified panel.</div>
2051 Hides the tab for the specified panel.
2058 <dl class="detailList">
2059 <dt class="heading">Parameters:</dt>
2062 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2065 <dd>The panel's index, id or the panel itself</dd>
2083 <td class="msource">
2091 <tr class="method-row config-row-alt0 expandable notInherited">
2092 <td class="micon"><a class="exi" href="#expand"> </a></td>
2096 <a id="Roo.LayoutRegion-method-isVisible" name=".isVisible"></a>
2097 <div class="fixedFont">
2098 <span class="attributes"></span><b class="itemname">isVisible</b>
2106 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2115 <div class="short">Returns true if this region is currently visible.</div>
2121 Returns true if this region is currently visible.
2132 <dl class="detailList">
2133 <dt class="heading">Returns:</dt>
2135 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2149 <td class="msource">
2157 <tr class="method-row config-row-alt1 expandable">
2158 <td class="micon"><a class="exi" href="#expand"> </a></td>
2162 <a id="Roo.util.Observable-method-on" name=".on"></a>
2163 <div class="fixedFont">
2164 <span class="attributes"></span><b class="itemname">on</b>
2166 (<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>)
2173 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2179 Appends an event handler to this element (shorthand for addListener)
2186 <dl class="detailList">
2187 <dt class="heading">Parameters:</dt>
2190 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2193 <dd>The type of event to listen for</dd>
2196 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2199 <dd>The method the event invokes</dd>
2202 <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>
2205 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2208 <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>
2229 <td class="msource">
2231 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2237 <tr class="method-row config-row-alt0 expandable">
2238 <td class="micon"><a class="exi" href="#expand"> </a></td>
2242 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2243 <div class="fixedFont">
2244 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2253 <div class="short">Removes all listeners for this object</div>
2259 Removes all listeners for this object
2280 <td class="msource">
2282 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2288 <tr class="method-row config-row-alt1 expandable notInherited">
2289 <td class="micon"><a class="exi" href="#expand"> </a></td>
2293 <a id="Roo.LayoutRegion-method-remove" name=".remove"></a>
2294 <div class="fixedFont">
2295 <span class="attributes"></span><b class="itemname">remove</b>
2297 (<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>)
2303 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
2312 <div class="short">Removes the specified panel.</div>
2318 Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
2325 <dl class="detailList">
2326 <dt class="heading">Parameters:</dt>
2329 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2332 <dd>The panel's index, id or the panel itself</dd>
2335 <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>
2338 <dd>Overrides the config preservePanel option</dd>
2346 <dl class="detailList">
2347 <dt class="heading">Returns:</dt>
2349 <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>
2363 <td class="msource">
2371 <tr class="method-row config-row-alt0 expandable">
2372 <td class="micon"><a class="exi" href="#expand"> </a></td>
2376 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2377 <div class="fixedFont">
2378 <span class="attributes"></span><b class="itemname">removeListener</b>
2380 (<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>)
2387 <div class="short">Removes a listener</div>
2400 <dl class="detailList">
2401 <dt class="heading">Parameters:</dt>
2404 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2407 <dd>The type of event to listen for</dd>
2410 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2413 <dd>The handler to remove</dd>
2416 <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>
2419 <dd>(optional) The scope (this object) for the handler</dd>
2437 <td class="msource">
2439 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2445 <tr class="method-row config-row-alt1 expandable">
2446 <td class="micon"><a class="exi" href="#expand"> </a></td>
2450 <a id="Roo.BasicLayoutRegion-method-resizeTo" name=".resizeTo"></a>
2451 <div class="fixedFont">
2452 <span class="attributes"></span><b class="itemname">resizeTo</b>
2454 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
2461 <div class="short">Resizes the region to the specified size.</div>
2467 Resizes the region to the specified size. For vertical regions (west, east) this adjusts <br/>the width, for horizontal (north, south) the height.
2474 <dl class="detailList">
2475 <dt class="heading">Parameters:</dt>
2478 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2481 <dd>The new width or height</dd>
2499 <td class="msource">
2501 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2507 <tr class="method-row config-row-alt0 expandable notInherited">
2508 <td class="micon"><a class="exi" href="#expand"> </a></td>
2512 <a id="Roo.LayoutRegion-method-setCollapsedTitle" name=".setCollapsedTitle"></a>
2513 <div class="fixedFont">
2514 <span class="attributes"></span><b class="itemname">setCollapsedTitle</b>
2516 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>)
2523 <div class="short">Updates the title for collapsed north/south regions (used with {<b>link</b> <b>collapsedTitle</b>} config option)</div>
2529 Updates the title for collapsed north/south regions (used with {<b>link</b> <b>collapsedTitle</b>} config option)
2536 <dl class="detailList">
2537 <dt class="heading">Parameters:</dt>
2540 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
2543 <dd>(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, "&#160;")</dd>
2561 <td class="msource">
2569 <tr class="method-row config-row-alt1 expandable notInherited">
2570 <td class="micon"><a class="exi" href="#expand"> </a></td>
2574 <a id="Roo.LayoutRegion-method-show" name=".show"></a>
2575 <div class="fixedFont">
2576 <span class="attributes"></span><b class="itemname">show</b>
2585 <div class="short">Shows this region if it was previously hidden.</div>
2591 Shows this region if it was previously hidden.
2612 <td class="msource">
2620 <tr class="method-row config-row-alt0 expandable notInherited">
2621 <td class="micon"><a class="exi" href="#expand"> </a></td>
2625 <a id="Roo.LayoutRegion-method-showPanel" name=".showPanel"></a>
2626 <div class="fixedFont">
2627 <span class="attributes"></span><b class="itemname">showPanel</b>
2629 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panelId</i></B>)
2635 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
2644 <div class="short">Shows the specified panel.</div>
2650 Shows the specified panel.
2657 <dl class="detailList">
2658 <dt class="heading">Parameters:</dt>
2661 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panelId</b>
2664 <dd>The panel's index, id or the panel itself</dd>
2672 <dl class="detailList">
2673 <dt class="heading">Returns:</dt>
2675 <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>
2689 <td class="msource">
2697 <tr class="method-row config-row-alt1 expandable">
2698 <td class="micon"><a class="exi" href="#expand"> </a></td>
2702 <a id="Roo.util.Observable-method-un" name=".un"></a>
2703 <div class="fixedFont">
2704 <span class="attributes"></span><b class="itemname">un</b>
2706 (<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>)
2713 <div class="short">Removes a listener (shorthand for removeListener)</div>
2719 Removes a listener (shorthand for removeListener)
2726 <dl class="detailList">
2727 <dt class="heading">Parameters:</dt>
2730 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2733 <dd>The type of event to listen for</dd>
2736 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2739 <dd>The handler to remove</dd>
2742 <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>
2745 <dd>(optional) The scope (this object) for the handler</dd>
2763 <td class="msource">
2765 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2771 <tr class="method-row config-row-alt0 expandable notInherited">
2772 <td class="micon"><a class="exi" href="#expand"> </a></td>
2776 <a id="Roo.LayoutRegion-method-unhidePanel" name=".unhidePanel"></a>
2777 <div class="fixedFont">
2778 <span class="attributes"></span><b class="itemname">unhidePanel</b>
2780 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2787 <div class="short">Unhides the tab for a previously hidden panel.</div>
2793 Unhides the tab for a previously hidden panel.
2800 <dl class="detailList">
2801 <dt class="heading">Parameters:</dt>
2804 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2807 <dd>The panel's index, id or the panel itself</dd>
2825 <td class="msource">
2836 <!-- ============================== events summary / details ======================== -->
2839 <a id="Roo.LayoutRegion-events"></a>
2848 <table cellspacing="0" class="member-table">
2849 <caption>Events</caption>
2852 <th class="sig-header" colspan="2">Event</th>
2853 <th class="msource-header">Defined By</th>
2862 <tr class="method-row expandable config-row-alt0">
2863 <td class="micon"><a class="exi" href="#expand"> </a></td>
2866 <a id="Roo.BasicLayoutRegion-event-*beforeremove"></a>
2868 <div class="fixedFont">
2869 <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>)
2875 <div class="short">Fires before a panel is removed (or closed).
2881 Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
2887 <dl class="detailList">
2888 <dt class="heading">Parameters:</dt>
2891 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2897 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
2903 <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>
2906 <dd>The cancel event object</dd>
2924 <td class="msource">
2925 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2929 <tr class="method-row expandable config-row-alt1">
2930 <td class="micon"><a class="exi" href="#expand"> </a></td>
2933 <a id="Roo.BasicLayoutRegion-event-*collapsed"></a>
2935 <div class="fixedFont">
2936 <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>)
2942 <div class="short">Fires when this region is collapsed.
2948 Fires when this region is collapsed.
2954 <dl class="detailList">
2955 <dt class="heading">Parameters:</dt>
2958 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
2979 <td class="msource">
2980 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2984 <tr class="method-row expandable config-row-alt0">
2985 <td class="micon"><a class="exi" href="#expand"> </a></td>
2988 <a id="Roo.BasicLayoutRegion-event-*expanded"></a>
2990 <div class="fixedFont">
2991 <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>)
2997 <div class="short">Fires when this region is expanded.
3003 Fires when this region is expanded.
3009 <dl class="detailList">
3010 <dt class="heading">Parameters:</dt>
3013 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3034 <td class="msource">
3035 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3039 <tr class="method-row expandable config-row-alt1">
3040 <td class="micon"><a class="exi" href="#expand"> </a></td>
3043 <a id="Roo.BasicLayoutRegion-event-*invalidated"></a>
3045 <div class="fixedFont">
3046 <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>)
3052 <div class="short">Fires when the layout for this region is changed.
3058 Fires when the layout for this region is changed.
3064 <dl class="detailList">
3065 <dt class="heading">Parameters:</dt>
3068 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3089 <td class="msource">
3090 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3094 <tr class="method-row expandable config-row-alt0">
3095 <td class="micon"><a class="exi" href="#expand"> </a></td>
3098 <a id="Roo.BasicLayoutRegion-event-*panelactivated"></a>
3100 <div class="fixedFont">
3101 <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>)
3107 <div class="short">Fires when a panel is activated.
3113 Fires when a panel is activated.
3119 <dl class="detailList">
3120 <dt class="heading">Parameters:</dt>
3123 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3129 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3132 <dd>The activated panel</dd>
3150 <td class="msource">
3151 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3155 <tr class="method-row expandable config-row-alt1">
3156 <td class="micon"><a class="exi" href="#expand"> </a></td>
3159 <a id="Roo.BasicLayoutRegion-event-*paneladded"></a>
3161 <div class="fixedFont">
3162 <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>)
3168 <div class="short">Fires when a panel is added.
3174 Fires when a panel is added.
3180 <dl class="detailList">
3181 <dt class="heading">Parameters:</dt>
3184 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3190 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3211 <td class="msource">
3212 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3216 <tr class="method-row expandable config-row-alt0">
3217 <td class="micon"><a class="exi" href="#expand"> </a></td>
3220 <a id="Roo.BasicLayoutRegion-event-*panelremoved"></a>
3222 <div class="fixedFont">
3223 <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>)
3229 <div class="short">Fires when a panel is removed.
3235 Fires when a panel is removed.
3241 <dl class="detailList">
3242 <dt class="heading">Parameters:</dt>
3245 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3251 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3272 <td class="msource">
3273 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3277 <tr class="method-row expandable config-row-alt1">
3278 <td class="micon"><a class="exi" href="#expand"> </a></td>
3281 <a id="Roo.BasicLayoutRegion-event-*resized"></a>
3283 <div class="fixedFont">
3284 <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>)
3290 <div class="short">Fires when the user resizes this region.
3296 Fires when the user resizes this region.
3302 <dl class="detailList">
3303 <dt class="heading">Parameters:</dt>
3306 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3312 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
3315 <dd>The new size (width for east/west, height for north/south)</dd>
3333 <td class="msource">
3334 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3338 <tr class="method-row expandable config-row-alt0">
3339 <td class="micon"><a class="exi" href="#expand"> </a></td>
3342 <a id="Roo.BasicLayoutRegion-event-*slidehide"></a>
3344 <div class="fixedFont">
3345 <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>)
3351 <div class="short">Fires when this region slides out of view.
3357 Fires when this region slides out of view.
3363 <dl class="detailList">
3364 <dt class="heading">Parameters:</dt>
3367 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3388 <td class="msource">
3389 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3393 <tr class="method-row expandable config-row-alt1">
3394 <td class="micon"><a class="exi" href="#expand"> </a></td>
3397 <a id="Roo.BasicLayoutRegion-event-*slideshow"></a>
3399 <div class="fixedFont">
3400 <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>)
3406 <div class="short">Fires when this region is slid into view.
3412 Fires when this region is slid into view.
3418 <dl class="detailList">
3419 <dt class="heading">Parameters:</dt>
3422 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3443 <td class="msource">
3444 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3448 <tr class="method-row expandable config-row-alt0">
3449 <td class="micon"><a class="exi" href="#expand"> </a></td>
3452 <a id="Roo.BasicLayoutRegion-event-*visibilitychange"></a>
3454 <div class="fixedFont">
3455 <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>)
3461 <div class="short">Fires when this region is shown or hidden
3467 Fires when this region is shown or hidden
3473 <dl class="detailList">
3474 <dt class="heading">Parameters:</dt>
3477 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3483 <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>
3486 <dd>true or false</dd>
3504 <td class="msource">
3505 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3516 <!-- ============================== footer ================================= -->
3517 <div class="fineprint" style="clear:both">
3519 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:08:32 GMT+0800 (HKT)
3521 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>