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.LayoutManager</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.LayoutManager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.LayoutManager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.LayoutManager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.LayoutManager-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.LayoutManager
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.LayoutManager
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_LayoutManager.js.html">Roo/LayoutManager.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">LayoutManager</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Base class for layout managers.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.LayoutManager';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.LayoutManager.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.LayoutManager-configs"></a>
111 <table cellspacing="0" class="member-table">
112 <caption class="Empty">Config Options - Has None</caption>
126 <!-- ============================== public properties ==================== -->
130 <a id="Roo.LayoutManager-props"></a>
136 <table cellspacing="0" class="member-table">
137 <caption class="Empty">Public Properties - Has None</caption>
143 <!-- ============================== methods summary / details ======================== -->
146 <a id="Roo.LayoutManager-methods"></a>
147 <!-- constructor?? -->
154 <!-- then dynamics first -->
161 <table cellspacing="0" class="member-table">
162 <caption>Public Methods</caption>
164 <th class="sig-header" colspan="2">Method</th>
165 <th class="msource-header">Defined By</th>
175 <tr class="method-row config-row-alt0 notInherited">
176 <td class="micon"><a class="exi" href="#expand"> </a></td>
180 <a id="Roo-method-LayoutManager" name=".LayoutManager"></a>
181 <div class="fixedFont">
182 <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutManager</b>
192 <div class="short">Create a new Roo.LayoutManager</div>
199 Create a new Roo.LayoutManager
222 <tr class="method-row config-row-alt1 expandable notInherited">
223 <td class="micon"><a class="exi" href="#expand"> </a></td>
227 <a id="Roo.LayoutManager-method-beginUpdate" name=".beginUpdate"></a>
228 <div class="fixedFont">
229 <span class="attributes"></span><b class="itemname">beginUpdate</b>
238 <div class="short">Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls</div>
244 Suspend the LayoutManager from doing auto-layouts while<br/>making multiple add or remove calls
273 <tr class="method-row config-row-alt0 expandable notInherited">
274 <td class="micon"><a class="exi" href="#expand"> </a></td>
278 <a id="Roo.LayoutManager-method-endUpdate" name=".endUpdate"></a>
279 <div class="fixedFont">
280 <span class="attributes"></span><b class="itemname">endUpdate</b>
282 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>noLayout</i></B>)
289 <div class="short">Restore auto-layouts and optionally disable the manager from performing a layout</div>
295 Restore auto-layouts and optionally disable the manager from performing a layout
302 <dl class="detailList">
303 <dt class="heading">Parameters:</dt>
306 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>noLayout</b>
309 <dd>true to disable a layout update</dd>
335 <tr class="method-row config-row-alt1 expandable notInherited">
336 <td class="micon"><a class="exi" href="#expand"> </a></td>
340 <a id="Roo.LayoutManager-method-getEl" name=".getEl"></a>
341 <div class="fixedFont">
342 <span class="attributes"></span><b class="itemname">getEl</b>
350 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
359 <div class="short">Returns the Element this layout is bound to.</div>
365 Returns the Element this layout is bound to.
376 <dl class="detailList">
377 <dt class="heading">Returns:</dt>
379 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
401 <tr class="method-row config-row-alt0 expandable notInherited">
402 <td class="micon"><a class="exi" href="#expand"> </a></td>
406 <a id="Roo.LayoutManager-method-getRegion" name=".getRegion"></a>
407 <div class="fixedFont">
408 <span class="attributes"></span><b class="itemname">getRegion</b>
410 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>target</i></B>)
416 <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>
425 <div class="short">Returns the specified region.</div>
431 Returns the specified region.
438 <dl class="detailList">
439 <dt class="heading">Parameters:</dt>
442 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>target</b>
445 <dd>The region key ('center', 'north', 'south', 'east' or 'west')</dd>
453 <dl class="detailList">
454 <dt class="heading">Returns:</dt>
456 <dd><span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> </dd>
478 <tr class="method-row config-row-alt1 expandable notInherited">
479 <td class="micon"><a class="exi" href="#expand"> </a></td>
483 <a id="Roo.LayoutManager-method-getViewSize" name=".getViewSize"></a>
484 <div class="fixedFont">
485 <span class="attributes"></span><b class="itemname">getViewSize</b>
493 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
502 <div class="short">Returns the size of the current view.</div>
508 Returns the size of the current view. This method normalizes document.body and element embedded layouts and<br/>performs box-model adjustments.
519 <dl class="detailList">
520 <dt class="heading">Returns:</dt>
522 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> The size as an object {width: (the width), height: (the height)}</dd>
544 <tr class="method-row config-row-alt0 expandable notInherited">
545 <td class="micon"><a class="exi" href="#expand"> </a></td>
549 <a id="Roo.LayoutManager-method-isUpdating" name=".isUpdating"></a>
550 <div class="fixedFont">
551 <span class="attributes"></span><b class="itemname">isUpdating</b>
559 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
568 <div class="short">Returns true if this layout is currently being updated</div>
574 Returns true if this layout is currently being updated
585 <dl class="detailList">
586 <dt class="heading">Returns:</dt>
588 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
613 <!-- ============================== events summary / details ======================== -->
616 <a id="Roo.LayoutManager-events"></a>
625 <table cellspacing="0" class="member-table">
626 <caption>Events</caption>
629 <th class="sig-header" colspan="2">Event</th>
630 <th class="msource-header">Defined By</th>
639 <tr class="method-row expandable config-row-alt0 notInherited">
640 <td class="micon"><a class="exi" href="#expand"> </a></td>
643 <a id="Roo.LayoutManager-event-*layout"></a>
645 <div class="fixedFont">
646 <b class="itemname">layout</b> (<a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a> <B><i>this</i></B>)
652 <div class="short">Fires when a layout is performed.
658 Fires when a layout is performed.
664 <dl class="detailList">
665 <dt class="heading">Parameters:</dt>
668 <span class="fixedFont"><a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a></span> <b>this</b>
694 <tr class="method-row expandable config-row-alt1 notInherited">
695 <td class="micon"><a class="exi" href="#expand"> </a></td>
698 <a id="Roo.LayoutManager-event-*regioncollapsed"></a>
700 <div class="fixedFont">
701 <b class="itemname">regioncollapsed</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>)
707 <div class="short">Fires when a region is collapsed.
713 Fires when a region is collapsed.
719 <dl class="detailList">
720 <dt class="heading">Parameters:</dt>
723 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
726 <dd>The collapsed region</dd>
749 <tr class="method-row expandable config-row-alt0 notInherited">
750 <td class="micon"><a class="exi" href="#expand"> </a></td>
753 <a id="Roo.LayoutManager-event-*regionexpanded"></a>
755 <div class="fixedFont">
756 <b class="itemname">regionexpanded</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>)
762 <div class="short">Fires when a region is expanded.
768 Fires when a region is expanded.
774 <dl class="detailList">
775 <dt class="heading">Parameters:</dt>
778 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
781 <dd>The expanded region</dd>
804 <tr class="method-row expandable config-row-alt1 notInherited">
805 <td class="micon"><a class="exi" href="#expand"> </a></td>
808 <a id="Roo.LayoutManager-event-*regionresized"></a>
810 <div class="fixedFont">
811 <b class="itemname">regionresized</b> (<a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a> <B><i>region</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
817 <div class="short">Fires when the user resizes a region.
823 Fires when the user resizes a region.
829 <dl class="detailList">
830 <dt class="heading">Parameters:</dt>
833 <span class="fixedFont"><a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a></span> <b>region</b>
836 <dd>The resized region</dd>
839 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
842 <dd>The new size (width for east/west, height for north/south)</dd>
872 <!-- ============================== footer ================================= -->
873 <div class="fineprint" style="clear:both">
875 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:05:44 GMT+0800 (HKT)
877 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>