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.SplitBar</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.SplitBar-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.SplitBar-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.SplitBar-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.SplitBar-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.SplitBar
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
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_SplitBar.js.html">Roo/SplitBar.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">SplitBar</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 Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized).<br/><br><br><br/>Usage:<br/><pre><code><br/>var split = new Roo.SplitBar("elementToDrag", "elementToSize",<br/> Roo.SplitBar.HORIZONTAL, Roo.SplitBar.LEFT);<br/>split.setAdapter(new Roo.SplitBar.AbsoluteLayoutAdapter("container"));<br/>split.minSize = 100;<br/>split.maxSize = 600;<br/>split.animate = true;<br/>split.on('moved', splitterMoved);<br/></code></pre>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.SplitBar';">[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.SplitBar.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.SplitBar-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.SplitBar-props"></a>
138 <table cellspacing="0" class="member-table">
139 <caption>Public Properties </caption>
141 <th class="sig-header" colspan="2">Property</th>
142 <th class="sig-header">Description</th>
143 <th class="msource-header">Defined By</th>
153 <tr class="property-row config-row-alt0 notInherited">
155 <a class="exi" href="#expand"> </a>
158 <a id="Roo.SplitBar-prop-BOTTOM" name=".BOTTOM"></a>
159 <div class="fixedFont">
160 <span class="attributes">Roo.SplitBar.</span><b class="itemname">BOTTOM</b> :
161 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
169 Placement constant - The resizing element is positioned under splitter element
177 Placement constant - The resizing element is positioned under splitter element
192 <tr class="property-row config-row-alt1 notInherited">
194 <a class="exi" href="#expand"> </a>
197 <a id="Roo.SplitBar-prop-HORIZONTAL" name=".HORIZONTAL"></a>
198 <div class="fixedFont">
199 <span class="attributes">Roo.SplitBar.</span><b class="itemname">HORIZONTAL</b> :
200 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
208 Orientation constant - Create a horizontal SplitBar
216 Orientation constant - Create a horizontal SplitBar
231 <tr class="property-row config-row-alt0 notInherited">
233 <a class="exi" href="#expand"> </a>
236 <a id="Roo.SplitBar-prop-LEFT" name=".LEFT"></a>
237 <div class="fixedFont">
238 <span class="attributes">Roo.SplitBar.</span><b class="itemname">LEFT</b> :
239 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
247 Placement constant - The resizing element is to the left of the splitter element
255 Placement constant - The resizing element is to the left of the splitter element
270 <tr class="property-row config-row-alt1 notInherited">
272 <a class="exi" href="#expand"> </a>
275 <a id="Roo.SplitBar-prop-RIGHT" name=".RIGHT"></a>
276 <div class="fixedFont">
277 <span class="attributes">Roo.SplitBar.</span><b class="itemname">RIGHT</b> :
278 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
286 Placement constant - The resizing element is to the right of the splitter element
294 Placement constant - The resizing element is to the right of the splitter element
309 <tr class="property-row config-row-alt0 notInherited">
311 <a class="exi" href="#expand"> </a>
314 <a id="Roo.SplitBar-prop-TOP" name=".TOP"></a>
315 <div class="fixedFont">
316 <span class="attributes">Roo.SplitBar.</span><b class="itemname">TOP</b> :
317 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
325 Placement constant - The resizing element is positioned above the splitter element
333 Placement constant - The resizing element is positioned above the splitter element
348 <tr class="property-row config-row-alt1 notInherited">
350 <a class="exi" href="#expand"> </a>
353 <a id="Roo.SplitBar-prop-VERTICAL" name=".VERTICAL"></a>
354 <div class="fixedFont">
355 <span class="attributes">Roo.SplitBar.</span><b class="itemname">VERTICAL</b> :
356 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
364 Orientation constant - Create a vertical SplitBar
372 Orientation constant - Create a vertical SplitBar
388 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
389 <tr class="property-row alt">
396 <!-- ============================== methods summary / details ======================== -->
399 <a id="Roo.SplitBar-methods"></a>
400 <!-- constructor?? -->
407 <!-- then dynamics first -->
414 <table cellspacing="0" class="member-table">
415 <caption>Public Methods</caption>
417 <th class="sig-header" colspan="2">Method</th>
418 <th class="msource-header">Defined By</th>
428 <tr class="method-row config-row-alt0 expandable notInherited">
429 <td class="micon"><a class="exi" href="#expand"> </a></td>
433 <a id="Roo-method-SplitBar" name=".SplitBar"></a>
434 <div class="fixedFont">
435 <span class="attributes">new <B>Roo.</B></span><b class="itemname">SplitBar</b>
437 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>dragElement</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>resizingElement</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>orientation</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>placement</i></B>)
445 <div class="short">Create a new Roo.SplitBar</div>
452 Create a new Roo.SplitBar
455 <dl class="detailList">
456 <dt class="heading">Parameters:</dt>
459 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>dragElement</b>
462 <dd>The element to be dragged and act as the SplitBar.</dd>
465 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>resizingElement</b>
468 <dd>The element to be resized based on where the SplitBar element is dragged</dd>
471 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>orientation</b>
474 <dd>(optional) Either Roo.SplitBar.HORIZONTAL or Roo.SplitBar.VERTICAL. (Defaults to HORIZONTAL)</dd>
477 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>placement</b>
480 <dd>(optional) Either Roo.SplitBar.LEFT or Roo.SplitBar.RIGHT for horizontal or <br/> Roo.SplitBar.TOP or Roo.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial<br/> position of the SplitBar).</dd>
504 <tr class="method-row config-row-alt1 expandable notInherited">
505 <td class="micon"><a class="exi" href="#expand"> </a></td>
509 <a id="Roo.SplitBar-method-destroy" name=".destroy"></a>
510 <div class="fixedFont">
511 <span class="attributes"></span><b class="itemname">destroy</b>
513 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeEl</i></B>)
520 <div class="short">Destroy this splitbar.</div>
526 Destroy this splitbar.
533 <dl class="detailList">
534 <dt class="heading">Parameters:</dt>
537 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>removeEl</b>
540 <dd>True to remove the element</dd>
566 <tr class="method-row config-row-alt0 expandable notInherited">
567 <td class="micon"><a class="exi" href="#expand"> </a></td>
571 <a id="Roo.SplitBar-method-getAdapter" name=".getAdapter"></a>
572 <div class="fixedFont">
573 <span class="attributes"></span><b class="itemname">getAdapter</b>
590 <div class="short">Get the adapter this SplitBar uses</div>
596 Get the adapter this SplitBar uses
607 <dl class="detailList">
608 <dt class="heading">Returns:</dt>
610 <dd> The adapter object</dd>
632 <tr class="method-row config-row-alt1 expandable notInherited">
633 <td class="micon"><a class="exi" href="#expand"> </a></td>
637 <a id="Roo.SplitBar-method-getMaximumSize" name=".getMaximumSize"></a>
638 <div class="fixedFont">
639 <span class="attributes"></span><b class="itemname">getMaximumSize</b>
647 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
656 <div class="short">Gets the maximum size for the resizing element</div>
662 Gets the maximum size for the resizing element
673 <dl class="detailList">
674 <dt class="heading">Returns:</dt>
676 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The maximum size</dd>
698 <tr class="method-row config-row-alt0 expandable notInherited">
699 <td class="micon"><a class="exi" href="#expand"> </a></td>
703 <a id="Roo.SplitBar-method-getMinimumSize" name=".getMinimumSize"></a>
704 <div class="fixedFont">
705 <span class="attributes"></span><b class="itemname">getMinimumSize</b>
713 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
722 <div class="short">Gets the minimum size for the resizing element</div>
728 Gets the minimum size for the resizing element
739 <dl class="detailList">
740 <dt class="heading">Returns:</dt>
742 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> The minimum size</dd>
764 <tr class="method-row config-row-alt1 expandable notInherited">
765 <td class="micon"><a class="exi" href="#expand"> </a></td>
769 <a id="Roo.SplitBar-method-setAdapter" name=".setAdapter"></a>
770 <div class="fixedFont">
771 <span class="attributes"></span><b class="itemname">setAdapter</b>
773 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>adapter</i></B>)
780 <div class="short">Set the adapter this SplitBar uses</div>
786 Set the adapter this SplitBar uses
793 <dl class="detailList">
794 <dt class="heading">Parameters:</dt>
797 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>adapter</b>
800 <dd>A SplitBar adapter object</dd>
826 <tr class="method-row config-row-alt0 expandable notInherited">
827 <td class="micon"><a class="exi" href="#expand"> </a></td>
831 <a id="Roo.SplitBar-method-setCurrentSize" name=".setCurrentSize"></a>
832 <div class="fixedFont">
833 <span class="attributes"></span><b class="itemname">setCurrentSize</b>
835 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>size</i></B>)
842 <div class="short">Sets the initialize size for the resizing element</div>
848 Sets the initialize size for the resizing element
855 <dl class="detailList">
856 <dt class="heading">Parameters:</dt>
859 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>size</b>
862 <dd>The initial size</dd>
888 <tr class="method-row config-row-alt1 expandable notInherited">
889 <td class="micon"><a class="exi" href="#expand"> </a></td>
893 <a id="Roo.SplitBar-method-setMaximumSize" name=".setMaximumSize"></a>
894 <div class="fixedFont">
895 <span class="attributes"></span><b class="itemname">setMaximumSize</b>
897 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>maxSize</i></B>)
904 <div class="short">Sets the maximum size for the resizing element</div>
910 Sets the maximum size for the resizing element
917 <dl class="detailList">
918 <dt class="heading">Parameters:</dt>
921 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>maxSize</b>
924 <dd>The maximum size</dd>
950 <tr class="method-row config-row-alt0 expandable notInherited">
951 <td class="micon"><a class="exi" href="#expand"> </a></td>
955 <a id="Roo.SplitBar-method-setMinimumSize" name=".setMinimumSize"></a>
956 <div class="fixedFont">
957 <span class="attributes"></span><b class="itemname">setMinimumSize</b>
959 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>minSize</i></B>)
966 <div class="short">Sets the minimum size for the resizing element</div>
972 Sets the minimum size for the resizing element
979 <dl class="detailList">
980 <dt class="heading">Parameters:</dt>
983 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>minSize</b>
986 <dd>The minimum size</dd>
1004 <td class="msource">
1015 <!-- ============================== events summary / details ======================== -->
1018 <a id="Roo.SplitBar-events"></a>
1027 <table cellspacing="0" class="member-table">
1028 <caption>Events</caption>
1031 <th class="sig-header" colspan="2">Event</th>
1032 <th class="msource-header">Defined By</th>
1041 <tr class="method-row expandable config-row-alt0 notInherited">
1042 <td class="micon"><a class="exi" href="#expand"> </a></td>
1045 <a id="Roo.SplitBar-event-*beforeresize"></a>
1047 <div class="fixedFont">
1048 <b class="itemname">beforeresize</b> (<a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a> <B><i>this</i></B>)
1054 <div class="short">Fires before the splitter is dragged
1060 Fires before the splitter is dragged
1066 <dl class="detailList">
1067 <dt class="heading">Parameters:</dt>
1070 <span class="fixedFont"><a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a></span> <b>this</b>
1091 <td class="msource">
1096 <tr class="method-row expandable config-row-alt1 notInherited">
1097 <td class="micon"><a class="exi" href="#expand"> </a></td>
1100 <a id="Roo.SplitBar-event-*moved"></a>
1102 <div class="fixedFont">
1103 <b class="itemname">moved</b> (<a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
1109 <div class="short">Fires when the splitter is moved
1115 Fires when the splitter is moved
1121 <dl class="detailList">
1122 <dt class="heading">Parameters:</dt>
1125 <span class="fixedFont"><a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a></span> <b>this</b>
1131 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
1134 <dd>the new width or height</dd>
1152 <td class="msource">
1157 <tr class="method-row expandable config-row-alt0 notInherited">
1158 <td class="micon"><a class="exi" href="#expand"> </a></td>
1161 <a id="Roo.SplitBar-event-*resize"></a>
1163 <div class="fixedFont">
1164 <b class="itemname">resize</b> (<a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
1170 <div class="short">Fires when the splitter is moved (alias for {<b>link</b> <b>event</b>-moved})
1176 Fires when the splitter is moved (alias for {<b>link</b> <b>event</b>-moved})
1182 <dl class="detailList">
1183 <dt class="heading">Parameters:</dt>
1186 <span class="fixedFont"><a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a></span> <b>this</b>
1192 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
1195 <dd>the new width or height</dd>
1213 <td class="msource">
1225 <!-- ============================== footer ================================= -->
1226 <div class="fineprint" style="clear:both">
1228 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:05:45 GMT+0800 (HKT)
1230 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>