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>
152 True to always display tabs even when there is only 1 panel (defaults to false)
168 <tr class="config-row expandable config-row-alt1 notInherited">
169 <td class="micon"><a class="exi" href="#expand"> </a></td>
172 <a id="Roo.LayoutRegion-cfg-animate" name=".animate"></a>
173 <div class="fixedFont">
174 <b class="itemname">animate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
180 <div class="short">True to animate expand/collapse (defaults to false)</div>
185 True to animate expand/collapse (defaults to false)
201 <tr class="config-row expandable config-row-alt0 notInherited">
202 <td class="micon"><a class="exi" href="#expand"> </a></td>
205 <a id="Roo.LayoutRegion-cfg-autoHide" name=".autoHide"></a>
206 <div class="fixedFont">
207 <b class="itemname">autoHide</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
213 <div class="short">False to disable auto hiding when the mouse leaves the "floated" region (defaults to true)</div>
218 False to disable auto hiding when the mouse leaves the "floated" region (defaults to true)
234 <tr class="config-row expandable config-row-alt1 notInherited">
235 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo.LayoutRegion-cfg-autoScroll" name=".autoScroll"></a>
239 <div class="fixedFont">
240 <b class="itemname">autoScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
246 <div class="short">True to enable overflow scrolling (defaults to false)</div>
251 True to enable overflow scrolling (defaults to false)
267 <tr class="config-row expandable config-row-alt0 notInherited">
268 <td class="micon"><a class="exi" href="#expand"> </a></td>
271 <a id="Roo.LayoutRegion-cfg-closeOnTab" name=".closeOnTab"></a>
272 <div class="fixedFont">
273 <b class="itemname">closeOnTab</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
279 <div class="short">True to place the close icon on the tabs instead of the region titlebar (defaults to false)</div>
284 True to place the close icon on the tabs instead of the region titlebar (defaults to false)
300 <tr class="config-row expandable config-row-alt1 notInherited">
301 <td class="micon"><a class="exi" href="#expand"> </a></td>
304 <a id="Roo.LayoutRegion-cfg-cmargins" name=".cmargins"></a>
305 <div class="fixedFont">
306 <b class="itemname">cmargins</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
312 <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>
317 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})
333 <tr class="config-row expandable config-row-alt0 notInherited">
334 <td class="micon"><a class="exi" href="#expand"> </a></td>
337 <a id="Roo.LayoutRegion-cfg-collapsed" name=".collapsed"></a>
338 <div class="fixedFont">
339 <b class="itemname">collapsed</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
345 <div class="short">True to set the initial display to collapsed (defaults to false)</div>
350 True to set the initial display to collapsed (defaults to false)
366 <tr class="config-row expandable config-row-alt1 notInherited">
367 <td class="micon"><a class="exi" href="#expand"> </a></td>
370 <a id="Roo.LayoutRegion-cfg-collapsedTitle" name=".collapsedTitle"></a>
371 <div class="fixedFont">
372 <b class="itemname">collapsedTitle</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
378 <div class="short">Optional string message to display in the collapsed block of a north or south region</div>
383 Optional string message to display in the collapsed block of a north or south region
399 <tr class="config-row expandable config-row-alt0 notInherited">
400 <td class="micon"><a class="exi" href="#expand"> </a></td>
403 <a id="Roo.LayoutRegion-cfg-collapsible" name=".collapsible"></a>
404 <div class="fixedFont">
405 <b class="itemname">collapsible</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
411 <div class="short">False to disable collapsing (defaults to true)</div>
416 False to disable collapsing (defaults to true)
432 <tr class="config-row expandable config-row-alt1 notInherited">
433 <td class="micon"><a class="exi" href="#expand"> </a></td>
436 <a id="Roo.LayoutRegion-cfg-disableTabTips" name=".disableTabTips"></a>
437 <div class="fixedFont">
438 <b class="itemname">disableTabTips</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
444 <div class="short">True to disable tab tooltips</div>
449 True to disable tab tooltips
465 <tr class="config-row expandable config-row-alt0 notInherited">
466 <td class="micon"><a class="exi" href="#expand"> </a></td>
469 <a id="Roo.LayoutRegion-cfg-floatable" name=".floatable"></a>
470 <div class="fixedFont">
471 <b class="itemname">floatable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
477 <div class="short">False to disable floating (defaults to true)</div>
482 False to disable floating (defaults to true)
498 <tr class="config-row expandable config-row-alt1 notInherited">
499 <td class="micon"><a class="exi" href="#expand"> </a></td>
502 <a id="Roo.LayoutRegion-cfg-height" name=".height"></a>
503 <div class="fixedFont">
504 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
510 <div class="short">For North/South panels</div>
515 For North/South panels
531 <tr class="config-row expandable config-row-alt0 notInherited">
532 <td class="micon"><a class="exi" href="#expand"> </a></td>
535 <a id="Roo.LayoutRegion-cfg-hidden" name=".hidden"></a>
536 <div class="fixedFont">
537 <b class="itemname">hidden</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
543 <div class="short">True to start the region hidden (defaults to false)</div>
548 True to start the region hidden (defaults to false)
564 <tr class="config-row expandable config-row-alt1 notInherited">
565 <td class="micon"><a class="exi" href="#expand"> </a></td>
568 <a id="Roo.LayoutRegion-cfg-hideTabs" name=".hideTabs"></a>
569 <div class="fixedFont">
570 <b class="itemname">hideTabs</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
576 <div class="short">True to hide the tab strip (defaults to false)</div>
581 True to hide the tab strip (defaults to false)
597 <tr class="config-row expandable config-row-alt0 notInherited">
598 <td class="micon"><a class="exi" href="#expand"> </a></td>
601 <a id="Roo.LayoutRegion-cfg-hideWhenEmpty" name=".hideWhenEmpty"></a>
602 <div class="fixedFont">
603 <b class="itemname">hideWhenEmpty</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
609 <div class="short">True to hide the region when it has no panels</div>
614 True to hide the region when it has no panels
630 <tr class="config-row expandable config-row-alt1">
631 <td class="micon"><a class="exi" href="#expand"> </a></td>
634 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
635 <div class="fixedFont">
636 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
642 <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>
647 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>
657 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
663 <tr class="config-row expandable config-row-alt0 notInherited">
664 <td class="micon"><a class="exi" href="#expand"> </a></td>
667 <a id="Roo.LayoutRegion-cfg-margins" name=".margins"></a>
668 <div class="fixedFont">
669 <b class="itemname">margins</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
675 <div class="short">Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})</div>
680 Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})
696 <tr class="config-row expandable config-row-alt1 notInherited">
697 <td class="micon"><a class="exi" href="#expand"> </a></td>
700 <a id="Roo.LayoutRegion-cfg-minTabWidth" name=".minTabWidth"></a>
701 <div class="fixedFont">
702 <b class="itemname">minTabWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
708 <div class="short">The minimum tab width (defaults to 40)</div>
713 The minimum tab width (defaults to 40)
729 <tr class="config-row expandable config-row-alt0 notInherited">
730 <td class="micon"><a class="exi" href="#expand"> </a></td>
733 <a id="Roo.LayoutRegion-cfg-preferredTabWidth" name=".preferredTabWidth"></a>
734 <div class="fixedFont">
735 <b class="itemname">preferredTabWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
741 <div class="short">The preferred tab width (defaults to 150)</div>
746 The preferred tab width (defaults to 150)
762 <tr class="config-row expandable config-row-alt1 notInherited">
763 <td class="micon"><a class="exi" href="#expand"> </a></td>
766 <a id="Roo.LayoutRegion-cfg-preservePanels" name=".preservePanels"></a>
767 <div class="fixedFont">
768 <b class="itemname">preservePanels</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
774 <div class="short">True to preserve removed panels so they can be readded later (defaults to false)</div>
779 True to preserve removed panels so they can be readded later (defaults to false)
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-resizeTabs" name=".resizeTabs"></a>
800 <div class="fixedFont">
801 <b class="itemname">resizeTabs</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
807 <div class="short">True to enable automatic tab resizing.</div>
812 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)
828 <tr class="config-row expandable config-row-alt1 notInherited">
829 <td class="micon"><a class="exi" href="#expand"> </a></td>
832 <a id="Roo.LayoutRegion-cfg-showPin" name=".showPin"></a>
833 <div class="fixedFont">
834 <b class="itemname">showPin</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
840 <div class="short">True to show a pin button</div>
845 True to show a pin button
861 <tr class="config-row expandable config-row-alt0 notInherited">
862 <td class="micon"><a class="exi" href="#expand"> </a></td>
865 <a id="Roo.LayoutRegion-cfg-split" name=".split"></a>
866 <div class="fixedFont">
867 <b class="itemname">split</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
873 <div class="short">To show the splitter</div>
894 <tr class="config-row expandable config-row-alt1 notInherited">
895 <td class="micon"><a class="exi" href="#expand"> </a></td>
898 <a id="Roo.LayoutRegion-cfg-tabPosition" name=".tabPosition"></a>
899 <div class="fixedFont">
900 <b class="itemname">tabPosition</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
906 <div class="short">"top" or "bottom" (defaults to "bottom")</div>
911 "top" or "bottom" (defaults to "bottom")
912 <BR/>Possible Values: top, bottom
927 <tr class="config-row expandable config-row-alt0 notInherited">
928 <td class="micon"><a class="exi" href="#expand"> </a></td>
931 <a id="Roo.LayoutRegion-cfg-title" name=".title"></a>
932 <div class="fixedFont">
933 <b class="itemname">title</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
939 <div class="short">The title for the region (overrides panel titles)</div>
944 The title for the region (overrides panel titles)
960 <tr class="config-row expandable config-row-alt1 notInherited">
961 <td class="micon"><a class="exi" href="#expand"> </a></td>
964 <a id="Roo.LayoutRegion-cfg-titlebar" name=".titlebar"></a>
965 <div class="fixedFont">
966 <b class="itemname">titlebar</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
972 <div class="short">True to display a title bar (defaults to true)</div>
977 True to display a title bar (defaults to true)
993 <tr class="config-row expandable config-row-alt0 notInherited">
994 <td class="micon"><a class="exi" href="#expand"> </a></td>
997 <a id="Roo.LayoutRegion-cfg-toolbar" name=".toolbar"></a>
998 <div class="fixedFont">
999 <b class="itemname">toolbar</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1005 <div class="short">xtype configuration for a toolbar - shows on right of tabbar</div>
1010 xtype configuration for a toolbar - shows on right of tabbar
1018 <td class="msource">
1026 <tr class="config-row expandable config-row-alt1 notInherited">
1027 <td class="micon"><a class="exi" href="#expand"> </a></td>
1030 <a id="Roo.LayoutRegion-cfg-width" name=".width"></a>
1031 <div class="fixedFont">
1032 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1038 <div class="short">For East/West panels</div>
1043 For East/West panels
1051 <td class="msource">
1069 <!-- ============================== public properties ==================== -->
1073 <a id="Roo.LayoutRegion-props"></a>
1079 <table cellspacing="0" class="member-table">
1080 <caption class="Empty">Public Properties - Has None</caption>
1086 <!-- ============================== methods summary / details ======================== -->
1089 <a id="Roo.LayoutRegion-methods"></a>
1090 <!-- constructor?? -->
1097 <!-- then dynamics first -->
1104 <table cellspacing="0" class="member-table">
1105 <caption>Public Methods</caption>
1107 <th class="sig-header" colspan="2">Method</th>
1108 <th class="msource-header">Defined By</th>
1118 <tr class="method-row config-row-alt0 notInherited">
1119 <td class="micon"><a class="exi" href="#expand"> </a></td>
1123 <a id="Roo-method-LayoutRegion" name=".LayoutRegion"></a>
1124 <div class="fixedFont">
1125 <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutRegion</b>
1135 <div class="short">Create a new Roo.LayoutRegion</div>
1142 Create a new Roo.LayoutRegion
1159 <td class="msource">
1165 <tr class="method-row config-row-alt1 expandable notInherited">
1166 <td class="micon"><a class="exi" href="#expand"> </a></td>
1170 <a id="Roo.LayoutRegion-method-add" name=".add"></a>
1171 <div class="fixedFont">
1172 <span class="attributes"></span><b class="itemname">add</b>
1174 (ContentPanel... <B><i>panel</i></B>)
1180 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1189 <div class="short">Adds the passed ContentPanel(s) to this region.</div>
1195 Adds the passed ContentPanel(s) to this region.
1202 <dl class="detailList">
1203 <dt class="heading">Parameters:</dt>
1206 <span class="fixedFont">ContentPanel...</span> <b>panel</b>
1209 <dd>The ContentPanel(s) to add (you can pass more than one)</dd>
1217 <dl class="detailList">
1218 <dt class="heading">Returns:</dt>
1220 <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>
1234 <td class="msource">
1242 <tr class="method-row config-row-alt0 expandable">
1243 <td class="micon"><a class="exi" href="#expand"> </a></td>
1247 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1248 <div class="fixedFont">
1249 <span class="attributes"></span><b class="itemname">addEvents</b>
1251 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1258 <div class="short">Used to define events on this Observable</div>
1264 Used to define events on this Observable
1271 <dl class="detailList">
1272 <dt class="heading">Parameters:</dt>
1275 <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>
1278 <dd>The object with the events defined</dd>
1296 <td class="msource">
1298 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1304 <tr class="method-row config-row-alt1 expandable">
1305 <td class="micon"><a class="exi" href="#expand"> </a></td>
1309 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1310 <div class="fixedFont">
1311 <span class="attributes"></span><b class="itemname">addListener</b>
1313 (<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>)
1320 <div class="short">Appends an event handler to this component</div>
1326 Appends an event handler to this component
1333 <dl class="detailList">
1334 <dt class="heading">Parameters:</dt>
1337 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1340 <dd>The type of event to listen for</dd>
1343 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1346 <dd>The method the event invokes</dd>
1349 <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>
1352 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1355 <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>
1358 <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>
1376 <td class="msource">
1378 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1384 <tr class="method-row config-row-alt0 expandable notInherited">
1385 <td class="micon"><a class="exi" href="#expand"> </a></td>
1389 <a id="Roo.LayoutRegion-method-collapse" name=".collapse"></a>
1390 <div class="fixedFont">
1391 <span class="attributes"></span><b class="itemname">collapse</b>
1393 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>skipAnim</i></B>)
1400 <div class="short">Collapses this region.</div>
1406 Collapses this region.
1413 <dl class="detailList">
1414 <dt class="heading">Parameters:</dt>
1417 <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>
1420 <dd>(optional) true to collapse the element without animation (if animate is true)</dd>
1438 <td class="msource">
1446 <tr class="method-row config-row-alt1 expandable notInherited">
1447 <td class="micon"><a class="exi" href="#expand"> </a></td>
1451 <a id="Roo.LayoutRegion-method-expand" name=".expand"></a>
1452 <div class="fixedFont">
1453 <span class="attributes"></span><b class="itemname">expand</b>
1455 (<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>)
1462 <div class="short">Expands this region if it was previously collapsed.</div>
1468 Expands this region if it was previously collapsed.
1475 <dl class="detailList">
1476 <dt class="heading">Parameters:</dt>
1479 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1482 <dd>The event that triggered the expand (or null if calling manually)</dd>
1485 <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>
1488 <dd>(optional) true to expand the element without animation (if animate is true)</dd>
1506 <td class="msource">
1514 <tr class="method-row config-row-alt0 expandable">
1515 <td class="micon"><a class="exi" href="#expand"> </a></td>
1519 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1520 <div class="fixedFont">
1521 <span class="attributes"></span><b class="itemname">fireEvent</b>
1523 (<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>)
1529 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1538 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1544 Fires the specified event with the passed parameters (minus the event name).
1551 <dl class="detailList">
1552 <dt class="heading">Parameters:</dt>
1555 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1561 <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>
1564 <dd>Variable number of parameters are passed to handlers</dd>
1572 <dl class="detailList">
1573 <dt class="heading">Returns:</dt>
1575 <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>
1589 <td class="msource">
1591 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1597 <tr class="method-row config-row-alt1 expandable notInherited">
1598 <td class="micon"><a class="exi" href="#expand"> </a></td>
1602 <a id="Roo.LayoutRegion-method-getActivePanel" name=".getActivePanel"></a>
1603 <div class="fixedFont">
1604 <span class="attributes"></span><b class="itemname">getActivePanel</b>
1612 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1621 <div class="short">Get the active panel for this region.</div>
1627 Get the active panel for this region.
1638 <dl class="detailList">
1639 <dt class="heading">Returns:</dt>
1641 <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>
1655 <td class="msource">
1663 <tr class="method-row config-row-alt0 expandable notInherited">
1664 <td class="micon"><a class="exi" href="#expand"> </a></td>
1668 <a id="Roo.LayoutRegion-method-getEl" name=".getEl"></a>
1669 <div class="fixedFont">
1670 <span class="attributes"></span><b class="itemname">getEl</b>
1678 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1687 <div class="short">Returns the container element for this region.</div>
1693 Returns the container element for this region.
1704 <dl class="detailList">
1705 <dt class="heading">Returns:</dt>
1707 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1721 <td class="msource">
1729 <tr class="method-row config-row-alt1 expandable">
1730 <td class="micon"><a class="exi" href="#expand"> </a></td>
1734 <a id="Roo.BasicLayoutRegion-method-getPanel" name=".getPanel"></a>
1735 <div class="fixedFont">
1736 <span class="attributes"></span><b class="itemname">getPanel</b>
1738 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
1744 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1753 <div class="short">Returns the panel specified or null if it's not in this region.</div>
1759 Returns the panel specified or null if it's not in this region.
1766 <dl class="detailList">
1767 <dt class="heading">Parameters:</dt>
1770 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
1773 <dd>The panels index, id or the panel itself</dd>
1781 <dl class="detailList">
1782 <dt class="heading">Returns:</dt>
1784 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> </dd>
1798 <td class="msource">
1800 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1806 <tr class="method-row config-row-alt0 expandable">
1807 <td class="micon"><a class="exi" href="#expand"> </a></td>
1811 <a id="Roo.BasicLayoutRegion-method-getPosition" name=".getPosition"></a>
1812 <div class="fixedFont">
1813 <span class="attributes"></span><b class="itemname">getPosition</b>
1821 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1830 <div class="short">Returns this regions position (north/south/east/west/center).</div>
1836 Returns this regions position (north/south/east/west/center).
1847 <dl class="detailList">
1848 <dt class="heading">Returns:</dt>
1850 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1864 <td class="msource">
1866 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
1872 <tr class="method-row config-row-alt1 expandable notInherited">
1873 <td class="micon"><a class="exi" href="#expand"> </a></td>
1877 <a id="Roo.LayoutRegion-method-getTabs" name=".getTabs"></a>
1878 <div class="fixedFont">
1879 <span class="attributes"></span><b class="itemname">getTabs</b>
1887 <a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a>
1896 <div class="short">Returns the TabPanel component used by this region</div>
1902 Returns the TabPanel component used by this region
1913 <dl class="detailList">
1914 <dt class="heading">Returns:</dt>
1916 <dd><span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> </dd>
1930 <td class="msource">
1938 <tr class="method-row config-row-alt0 expandable">
1939 <td class="micon"><a class="exi" href="#expand"> </a></td>
1943 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1944 <div class="fixedFont">
1945 <span class="attributes"></span><b class="itemname">hasListener</b>
1947 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1953 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1962 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1968 Checks to see if this object has any listeners for a specified event
1975 <dl class="detailList">
1976 <dt class="heading">Parameters:</dt>
1979 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1982 <dd>The name of the event to check for</dd>
1990 <dl class="detailList">
1991 <dt class="heading">Returns:</dt>
1993 <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>
2007 <td class="msource">
2009 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2015 <tr class="method-row config-row-alt1 expandable">
2016 <td class="micon"><a class="exi" href="#expand"> </a></td>
2020 <a id="Roo.BasicLayoutRegion-method-hasPanel" name=".hasPanel"></a>
2021 <div class="fixedFont">
2022 <span class="attributes"></span><b class="itemname">hasPanel</b>
2024 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2030 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2039 <div class="short">Returns true if the panel is in this region.</div>
2045 Returns true if the panel is in this region.
2052 <dl class="detailList">
2053 <dt class="heading">Parameters:</dt>
2056 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2059 <dd>The panels index, id or the panel itself</dd>
2067 <dl class="detailList">
2068 <dt class="heading">Returns:</dt>
2070 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2084 <td class="msource">
2086 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2092 <tr class="method-row config-row-alt0 expandable notInherited">
2093 <td class="micon"><a class="exi" href="#expand"> </a></td>
2097 <a id="Roo.LayoutRegion-method-hide" name=".hide"></a>
2098 <div class="fixedFont">
2099 <span class="attributes"></span><b class="itemname">hide</b>
2108 <div class="short">Hides this region.</div>
2135 <td class="msource">
2143 <tr class="method-row config-row-alt1 expandable notInherited">
2144 <td class="micon"><a class="exi" href="#expand"> </a></td>
2148 <a id="Roo.LayoutRegion-method-hidePanel" name=".hidePanel"></a>
2149 <div class="fixedFont">
2150 <span class="attributes"></span><b class="itemname">hidePanel</b>
2152 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2159 <div class="short">Hides the tab for the specified panel.</div>
2165 Hides the tab for the specified panel.
2172 <dl class="detailList">
2173 <dt class="heading">Parameters:</dt>
2176 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2179 <dd>The panel's index, id or the panel itself</dd>
2197 <td class="msource">
2205 <tr class="method-row config-row-alt0 expandable notInherited">
2206 <td class="micon"><a class="exi" href="#expand"> </a></td>
2210 <a id="Roo.LayoutRegion-method-isVisible" name=".isVisible"></a>
2211 <div class="fixedFont">
2212 <span class="attributes"></span><b class="itemname">isVisible</b>
2220 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2229 <div class="short">Returns true if this region is currently visible.</div>
2235 Returns true if this region is currently visible.
2246 <dl class="detailList">
2247 <dt class="heading">Returns:</dt>
2249 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
2263 <td class="msource">
2271 <tr class="method-row config-row-alt1 expandable">
2272 <td class="micon"><a class="exi" href="#expand"> </a></td>
2276 <a id="Roo.util.Observable-method-on" name=".on"></a>
2277 <div class="fixedFont">
2278 <span class="attributes"></span><b class="itemname">on</b>
2280 (<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>)
2287 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2293 Appends an event handler to this element (shorthand for addListener)
2300 <dl class="detailList">
2301 <dt class="heading">Parameters:</dt>
2304 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2307 <dd>The type of event to listen for</dd>
2310 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2313 <dd>The method the event invokes</dd>
2316 <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>
2319 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2322 <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>
2343 <td class="msource">
2345 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2351 <tr class="method-row config-row-alt0 expandable">
2352 <td class="micon"><a class="exi" href="#expand"> </a></td>
2356 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2357 <div class="fixedFont">
2358 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2367 <div class="short">Removes all listeners for this object</div>
2373 Removes all listeners for this object
2394 <td class="msource">
2396 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2402 <tr class="method-row config-row-alt1 expandable notInherited">
2403 <td class="micon"><a class="exi" href="#expand"> </a></td>
2407 <a id="Roo.LayoutRegion-method-remove" name=".remove"></a>
2408 <div class="fixedFont">
2409 <span class="attributes"></span><b class="itemname">remove</b>
2411 (<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>)
2417 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
2426 <div class="short">Removes the specified panel.</div>
2432 Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.
2439 <dl class="detailList">
2440 <dt class="heading">Parameters:</dt>
2443 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2446 <dd>The panel's index, id or the panel itself</dd>
2449 <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>
2452 <dd>Overrides the config preservePanel option</dd>
2460 <dl class="detailList">
2461 <dt class="heading">Returns:</dt>
2463 <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>
2477 <td class="msource">
2485 <tr class="method-row config-row-alt0 expandable">
2486 <td class="micon"><a class="exi" href="#expand"> </a></td>
2490 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2491 <div class="fixedFont">
2492 <span class="attributes"></span><b class="itemname">removeListener</b>
2494 (<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>)
2501 <div class="short">Removes a listener</div>
2514 <dl class="detailList">
2515 <dt class="heading">Parameters:</dt>
2518 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2521 <dd>The type of event to listen for</dd>
2524 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2527 <dd>The handler to remove</dd>
2530 <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>
2533 <dd>(optional) The scope (this object) for the handler</dd>
2551 <td class="msource">
2553 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2559 <tr class="method-row config-row-alt1 expandable">
2560 <td class="micon"><a class="exi" href="#expand"> </a></td>
2564 <a id="Roo.BasicLayoutRegion-method-resizeTo" name=".resizeTo"></a>
2565 <div class="fixedFont">
2566 <span class="attributes"></span><b class="itemname">resizeTo</b>
2568 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
2575 <div class="short">Resizes the region to the specified size.</div>
2581 Resizes the region to the specified size. For vertical regions (west, east) this adjusts <br/>the width, for horizontal (north, south) the height.
2588 <dl class="detailList">
2589 <dt class="heading">Parameters:</dt>
2592 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2595 <dd>The new width or height</dd>
2613 <td class="msource">
2615 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
2621 <tr class="method-row config-row-alt0 expandable notInherited">
2622 <td class="micon"><a class="exi" href="#expand"> </a></td>
2626 <a id="Roo.LayoutRegion-method-setCollapsedTitle" name=".setCollapsedTitle"></a>
2627 <div class="fixedFont">
2628 <span class="attributes"></span><b class="itemname">setCollapsedTitle</b>
2630 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>)
2637 <div class="short">Updates the title for collapsed north/south regions (used with {<b>link</b> <b>collapsedTitle</b>} config option)</div>
2643 Updates the title for collapsed north/south regions (used with {<b>link</b> <b>collapsedTitle</b>} config option)
2650 <dl class="detailList">
2651 <dt class="heading">Parameters:</dt>
2654 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
2657 <dd>(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, "&#160;")</dd>
2675 <td class="msource">
2683 <tr class="method-row config-row-alt1 expandable notInherited">
2684 <td class="micon"><a class="exi" href="#expand"> </a></td>
2688 <a id="Roo.LayoutRegion-method-show" name=".show"></a>
2689 <div class="fixedFont">
2690 <span class="attributes"></span><b class="itemname">show</b>
2699 <div class="short">Shows this region if it was previously hidden.</div>
2705 Shows this region if it was previously hidden.
2726 <td class="msource">
2734 <tr class="method-row config-row-alt0 expandable notInherited">
2735 <td class="micon"><a class="exi" href="#expand"> </a></td>
2739 <a id="Roo.LayoutRegion-method-showPanel" name=".showPanel"></a>
2740 <div class="fixedFont">
2741 <span class="attributes"></span><b class="itemname">showPanel</b>
2743 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panelId</i></B>)
2749 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
2758 <div class="short">Shows the specified panel.</div>
2764 Shows the specified panel.
2771 <dl class="detailList">
2772 <dt class="heading">Parameters:</dt>
2775 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panelId</b>
2778 <dd>The panel's index, id or the panel itself</dd>
2786 <dl class="detailList">
2787 <dt class="heading">Returns:</dt>
2789 <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>
2803 <td class="msource">
2811 <tr class="method-row config-row-alt1 expandable">
2812 <td class="micon"><a class="exi" href="#expand"> </a></td>
2816 <a id="Roo.util.Observable-method-un" name=".un"></a>
2817 <div class="fixedFont">
2818 <span class="attributes"></span><b class="itemname">un</b>
2820 (<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>)
2827 <div class="short">Removes a listener (shorthand for removeListener)</div>
2833 Removes a listener (shorthand for removeListener)
2840 <dl class="detailList">
2841 <dt class="heading">Parameters:</dt>
2844 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2847 <dd>The type of event to listen for</dd>
2850 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2853 <dd>The handler to remove</dd>
2856 <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>
2859 <dd>(optional) The scope (this object) for the handler</dd>
2877 <td class="msource">
2879 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2885 <tr class="method-row config-row-alt0 expandable notInherited">
2886 <td class="micon"><a class="exi" href="#expand"> </a></td>
2890 <a id="Roo.LayoutRegion-method-unhidePanel" name=".unhidePanel"></a>
2891 <div class="fixedFont">
2892 <span class="attributes"></span><b class="itemname">unhidePanel</b>
2894 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel <B><i>panel</i></B>)
2901 <div class="short">Unhides the tab for a previously hidden panel.</div>
2907 Unhides the tab for a previously hidden panel.
2914 <dl class="detailList">
2915 <dt class="heading">Parameters:</dt>
2918 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/String/ContentPanel</span> <b>panel</b>
2921 <dd>The panel's index, id or the panel itself</dd>
2939 <td class="msource">
2950 <!-- ============================== events summary / details ======================== -->
2953 <a id="Roo.LayoutRegion-events"></a>
2962 <table cellspacing="0" class="member-table">
2963 <caption>Events</caption>
2966 <th class="sig-header" colspan="2">Event</th>
2967 <th class="msource-header">Defined By</th>
2976 <tr class="method-row expandable config-row-alt0">
2977 <td class="micon"><a class="exi" href="#expand"> </a></td>
2980 <a id="Roo.BasicLayoutRegion-event-*beforeremove"></a>
2982 <div class="fixedFont">
2983 <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>)
2989 <div class="short">Fires before a panel is removed (or closed).
2995 Fires before a panel is removed (or closed). To cancel the removal set "e.cancel = true" on the event argument.
3001 <dl class="detailList">
3002 <dt class="heading">Parameters:</dt>
3005 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3011 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3017 <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>
3020 <dd>The cancel event object</dd>
3038 <td class="msource">
3039 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3043 <tr class="method-row expandable config-row-alt1">
3044 <td class="micon"><a class="exi" href="#expand"> </a></td>
3047 <a id="Roo.BasicLayoutRegion-event-*collapsed"></a>
3049 <div class="fixedFont">
3050 <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>)
3056 <div class="short">Fires when this region is collapsed.
3062 Fires when this region is collapsed.
3068 <dl class="detailList">
3069 <dt class="heading">Parameters:</dt>
3072 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3093 <td class="msource">
3094 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3098 <tr class="method-row expandable config-row-alt0">
3099 <td class="micon"><a class="exi" href="#expand"> </a></td>
3102 <a id="Roo.BasicLayoutRegion-event-*expanded"></a>
3104 <div class="fixedFont">
3105 <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>)
3111 <div class="short">Fires when this region is expanded.
3117 Fires when this region is expanded.
3123 <dl class="detailList">
3124 <dt class="heading">Parameters:</dt>
3127 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3148 <td class="msource">
3149 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3153 <tr class="method-row expandable config-row-alt1">
3154 <td class="micon"><a class="exi" href="#expand"> </a></td>
3157 <a id="Roo.BasicLayoutRegion-event-*invalidated"></a>
3159 <div class="fixedFont">
3160 <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>)
3166 <div class="short">Fires when the layout for this region is changed.
3172 Fires when the layout for this region is changed.
3178 <dl class="detailList">
3179 <dt class="heading">Parameters:</dt>
3182 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3203 <td class="msource">
3204 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3208 <tr class="method-row expandable config-row-alt0">
3209 <td class="micon"><a class="exi" href="#expand"> </a></td>
3212 <a id="Roo.BasicLayoutRegion-event-*panelactivated"></a>
3214 <div class="fixedFont">
3215 <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>)
3221 <div class="short">Fires when a panel is activated.
3227 Fires when a panel is activated.
3233 <dl class="detailList">
3234 <dt class="heading">Parameters:</dt>
3237 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3243 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3246 <dd>The activated panel</dd>
3264 <td class="msource">
3265 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3269 <tr class="method-row expandable config-row-alt1">
3270 <td class="micon"><a class="exi" href="#expand"> </a></td>
3273 <a id="Roo.BasicLayoutRegion-event-*paneladded"></a>
3275 <div class="fixedFont">
3276 <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>)
3282 <div class="short">Fires when a panel is added.
3288 Fires when a panel is added.
3294 <dl class="detailList">
3295 <dt class="heading">Parameters:</dt>
3298 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3304 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3325 <td class="msource">
3326 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3330 <tr class="method-row expandable config-row-alt0">
3331 <td class="micon"><a class="exi" href="#expand"> </a></td>
3334 <a id="Roo.BasicLayoutRegion-event-*panelremoved"></a>
3336 <div class="fixedFont">
3337 <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>)
3343 <div class="short">Fires when a panel is removed.
3349 Fires when a panel is removed.
3355 <dl class="detailList">
3356 <dt class="heading">Parameters:</dt>
3359 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3365 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>panel</b>
3386 <td class="msource">
3387 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3391 <tr class="method-row expandable config-row-alt1">
3392 <td class="micon"><a class="exi" href="#expand"> </a></td>
3395 <a id="Roo.BasicLayoutRegion-event-*resized"></a>
3397 <div class="fixedFont">
3398 <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>)
3404 <div class="short">Fires when the user resizes this region.
3410 Fires when the user resizes this region.
3416 <dl class="detailList">
3417 <dt class="heading">Parameters:</dt>
3420 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3426 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
3429 <dd>The new size (width for east/west, height for north/south)</dd>
3447 <td class="msource">
3448 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3452 <tr class="method-row expandable config-row-alt0">
3453 <td class="micon"><a class="exi" href="#expand"> </a></td>
3456 <a id="Roo.BasicLayoutRegion-event-*slidehide"></a>
3458 <div class="fixedFont">
3459 <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>)
3465 <div class="short">Fires when this region slides out of view.
3471 Fires when this region slides out of view.
3477 <dl class="detailList">
3478 <dt class="heading">Parameters:</dt>
3481 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3502 <td class="msource">
3503 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3507 <tr class="method-row expandable config-row-alt1">
3508 <td class="micon"><a class="exi" href="#expand"> </a></td>
3511 <a id="Roo.BasicLayoutRegion-event-*slideshow"></a>
3513 <div class="fixedFont">
3514 <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>)
3520 <div class="short">Fires when this region is slid into view.
3526 Fires when this region is slid into view.
3532 <dl class="detailList">
3533 <dt class="heading">Parameters:</dt>
3536 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3557 <td class="msource">
3558 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3562 <tr class="method-row expandable config-row-alt0">
3563 <td class="micon"><a class="exi" href="#expand"> </a></td>
3566 <a id="Roo.BasicLayoutRegion-event-*visibilitychange"></a>
3568 <div class="fixedFont">
3569 <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>)
3575 <div class="short">Fires when this region is shown or hidden
3581 Fires when this region is shown or hidden
3587 <dl class="detailList">
3588 <dt class="heading">Parameters:</dt>
3591 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>this</b>
3597 <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>
3600 <dd>true or false</dd>
3618 <td class="msource">
3619 <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>
3630 <!-- ============================== footer ================================= -->
3631 <div class="fineprint" style="clear:both">
3633 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Mar 22 2016 11:14:08 GMT+0800 (HKT)
3635 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>