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.Resizable</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.Resizable-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Resizable-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Resizable-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Resizable-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.Resizable
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_Resizable.js.html">Roo/Resizable.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Resizable</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 <p>Applies drag handles to an element to make it resizable. The drag handles are inserted into the element<br/>and positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap<br/>the textarea in a div and set "resizeChild" to true (or to the id of the element), <b>or</b> set wrap:true in your config and<br/>the element will be wrapped for you automatically.</p><br/><p>Here is the list of valid resize handles:</p><br/><pre><br/>Value Description<br/>------ -------------------<br/> 'n' north<br/> 's' south<br/> 'e' east<br/> 'w' west<br/> 'nw' northwest<br/> 'sw' southwest<br/> 'se' southeast<br/> 'ne' northeast<br/> 'hd' horizontal drag<br/> 'all' all<br/></pre><br/><p>Here's an example showing the creation of a typical Resizable:</p><br/><pre><code><br/>var resizer = new Roo.Resizable("element-id", {<br/> handles: 'all',<br/> minWidth: 200,<br/> minHeight: 100,<br/> maxWidth: 500,<br/> maxHeight: 400,<br/> pinned: true<br/>});<br/>resizer.on("resize", myHandler);<br/></code></pre><br/><p>To hide a particular handle, set its display to none in CSS, or through script:<br><br/>resizer.east.setDisplayed(false);</p>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Resizable';">[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.Resizable.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.Resizable-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.Resizable-cfg-adjustments" name=".adjustments"></a>
132 <div class="fixedFont">
133 <b class="itemname">adjustments</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/String
139 <div class="short">String "auto" or an array [width, height] with values to be <b>added</b> to the<br/>resize operation's new size (defaults to [0, 0])</div>
144 String "auto" or an array [width, height] with values to be <b>added</b> to the<br/>resize operation's new size (defaults to [0, 0])
160 <tr class="config-row expandable config-row-alt1 notInherited">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.Resizable-cfg-animate" name=".animate"></a>
165 <div class="fixedFont">
166 <b class="itemname">animate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
172 <div class="short">True to animate the resize (not compatible with dynamic sizing, defaults to false)</div>
177 True to animate the resize (not compatible with dynamic sizing, defaults to false)
193 <tr class="config-row expandable config-row-alt0 notInherited">
194 <td class="micon"><a class="exi" href="#expand"> </a></td>
197 <a id="Roo.Resizable-cfg-constrainTo" name=".constrainTo"></a>
198 <div class="fixedFont">
199 <b class="itemname">constrainTo</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
205 <div class="short">Constrain the resize to a particular element</div>
210 Constrain the resize to a particular element
226 <tr class="config-row expandable config-row-alt1 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
230 <a id="Roo.Resizable-cfg-disableTrackOver" name=".disableTrackOver"></a>
231 <div class="fixedFont">
232 <b class="itemname">disableTrackOver</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
238 <div class="short">True to disable mouse tracking.</div>
243 True to disable mouse tracking. This is only applied at config time. (defaults to false)
259 <tr class="config-row expandable config-row-alt0 notInherited">
260 <td class="micon"><a class="exi" href="#expand"> </a></td>
263 <a id="Roo.Resizable-cfg-draggable" name=".draggable"></a>
264 <div class="fixedFont">
265 <b class="itemname">draggable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
271 <div class="short">Convenience to initialize drag drop (defaults to false)</div>
276 Convenience to initialize drag drop (defaults to false)
292 <tr class="config-row expandable config-row-alt1 notInherited">
293 <td class="micon"><a class="exi" href="#expand"> </a></td>
296 <a id="Roo.Resizable-cfg-duration" name=".duration"></a>
297 <div class="fixedFont">
298 <b class="itemname">duration</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
304 <div class="short">Animation duration if animate = true (defaults to .35)</div>
309 Animation duration if animate = true (defaults to .35)
325 <tr class="config-row expandable config-row-alt0 notInherited">
326 <td class="micon"><a class="exi" href="#expand"> </a></td>
329 <a id="Roo.Resizable-cfg-dynamic" name=".dynamic"></a>
330 <div class="fixedFont">
331 <b class="itemname">dynamic</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
337 <div class="short">True to resize the element while dragging instead of using a proxy (defaults to false)</div>
342 True to resize the element while dragging instead of using a proxy (defaults to false)
358 <tr class="config-row expandable config-row-alt1 notInherited">
359 <td class="micon"><a class="exi" href="#expand"> </a></td>
362 <a id="Roo.Resizable-cfg-easing" name=".easing"></a>
363 <div class="fixedFont">
364 <b class="itemname">easing</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
370 <div class="short">Animation easing if animate = true (defaults to 'easingOutStrong')</div>
375 Animation easing if animate = true (defaults to 'easingOutStrong')
391 <tr class="config-row expandable config-row-alt0 notInherited">
392 <td class="micon"><a class="exi" href="#expand"> </a></td>
395 <a id="Roo.Resizable-cfg-enabled" name=".enabled"></a>
396 <div class="fixedFont">
397 <b class="itemname">enabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
403 <div class="short">False to disable resizing (defaults to true)</div>
408 False to disable resizing (defaults to true)
424 <tr class="config-row expandable config-row-alt1 notInherited">
425 <td class="micon"><a class="exi" href="#expand"> </a></td>
428 <a id="Roo.Resizable-cfg-handles" name=".handles"></a>
429 <div class="fixedFont">
430 <b class="itemname">handles</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
436 <div class="short">String consisting of the resize handles to display (defaults to undefined)</div>
441 String consisting of the resize handles to display (defaults to undefined)
457 <tr class="config-row expandable config-row-alt0 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.Resizable-cfg-height" name=".height"></a>
462 <div class="fixedFont">
463 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
469 <div class="short">The height of the element in pixels (defaults to null)</div>
474 The height of the element in pixels (defaults to null)
490 <tr class="config-row expandable config-row-alt1 notInherited">
491 <td class="micon"><a class="exi" href="#expand"> </a></td>
494 <a id="Roo.Resizable-cfg-heightIncrement" name=".heightIncrement"></a>
495 <div class="fixedFont">
496 <b class="itemname">heightIncrement</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
502 <div class="short">The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)</div>
507 The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)
523 <tr class="config-row expandable config-row-alt0">
524 <td class="micon"><a class="exi" href="#expand"> </a></td>
527 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
528 <div class="fixedFont">
529 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
535 <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>
540 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>
550 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
556 <tr class="config-row expandable config-row-alt1 notInherited">
557 <td class="micon"><a class="exi" href="#expand"> </a></td>
560 <a id="Roo.Resizable-cfg-maxHeight" name=".maxHeight"></a>
561 <div class="fixedFont">
562 <b class="itemname">maxHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
568 <div class="short">The maximum height for the element (defaults to 10000)</div>
573 The maximum height for the element (defaults to 10000)
589 <tr class="config-row expandable config-row-alt0 notInherited">
590 <td class="micon"><a class="exi" href="#expand"> </a></td>
593 <a id="Roo.Resizable-cfg-maxWidth" name=".maxWidth"></a>
594 <div class="fixedFont">
595 <b class="itemname">maxWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
601 <div class="short">The maximum width for the element (defaults to 10000)</div>
606 The maximum width for the element (defaults to 10000)
622 <tr class="config-row expandable config-row-alt1 notInherited">
623 <td class="micon"><a class="exi" href="#expand"> </a></td>
626 <a id="Roo.Resizable-cfg-minHeight" name=".minHeight"></a>
627 <div class="fixedFont">
628 <b class="itemname">minHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
634 <div class="short">The minimum height for the element (defaults to 5)</div>
639 The minimum height for the element (defaults to 5)
655 <tr class="config-row expandable config-row-alt0 notInherited">
656 <td class="micon"><a class="exi" href="#expand"> </a></td>
659 <a id="Roo.Resizable-cfg-minWidth" name=".minWidth"></a>
660 <div class="fixedFont">
661 <b class="itemname">minWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
667 <div class="short">The minimum width for the element (defaults to 5)</div>
672 The minimum width for the element (defaults to 5)
688 <tr class="config-row expandable config-row-alt1 notInherited">
689 <td class="micon"><a class="exi" href="#expand"> </a></td>
692 <a id="Roo.Resizable-cfg-minX" name=".minX"></a>
693 <div class="fixedFont">
694 <b class="itemname">minX</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
700 <div class="short">The minimum allowed page X for the element (only used for west resizing, defaults to 0)</div>
705 The minimum allowed page X for the element (only used for west resizing, defaults to 0)
721 <tr class="config-row expandable config-row-alt0 notInherited">
722 <td class="micon"><a class="exi" href="#expand"> </a></td>
725 <a id="Roo.Resizable-cfg-minY" name=".minY"></a>
726 <div class="fixedFont">
727 <b class="itemname">minY</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
733 <div class="short">The minimum allowed page Y for the element (only used for north resizing, defaults to 0)</div>
738 The minimum allowed page Y for the element (only used for north resizing, defaults to 0)
754 <tr class="config-row expandable config-row-alt1 notInherited">
755 <td class="micon"><a class="exi" href="#expand"> </a></td>
758 <a id="Roo.Resizable-cfg-multiDirectional" name=".multiDirectional"></a>
759 <div class="fixedFont">
760 <b class="itemname">multiDirectional</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
766 <div class="short"><b>Deprecated</b>.</div>
771 <b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated<br/>in favor of the handles config option (defaults to false)
787 <tr class="config-row expandable config-row-alt0 notInherited">
788 <td class="micon"><a class="exi" href="#expand"> </a></td>
791 <a id="Roo.Resizable-cfg-pinned" name=".pinned"></a>
792 <div class="fixedFont">
793 <b class="itemname">pinned</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
799 <div class="short">True to ensure that the resize handles are always visible, false to display them only when the<br/>user mouses over the resizable borders.</div>
804 True to ensure that the resize handles are always visible, false to display them only when the<br/>user mouses over the resizable borders. This is only applied at config time. (defaults to false)
820 <tr class="config-row expandable config-row-alt1 notInherited">
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
824 <a id="Roo.Resizable-cfg-preserveRatio" name=".preserveRatio"></a>
825 <div class="fixedFont">
826 <b class="itemname">preserveRatio</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
832 <div class="short">True to preserve the original ratio between height and width during resize (defaults to false)</div>
837 True to preserve the original ratio between height and width during resize (defaults to false)
853 <tr class="config-row expandable config-row-alt0 notInherited">
854 <td class="micon"><a class="exi" href="#expand"> </a></td>
857 <a id="Roo.Resizable-cfg-resizeChild" name=".resizeChild"></a>
858 <div class="fixedFont">
859 <b class="itemname">resizeChild</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String/Element
865 <div class="short">True to resize the first child, or id/element to resize (defaults to false)</div>
870 True to resize the first child, or id/element to resize (defaults to false)
886 <tr class="config-row expandable config-row-alt1 notInherited">
887 <td class="micon"><a class="exi" href="#expand"> </a></td>
890 <a id="Roo.Resizable-cfg-resizeRegion" name=".resizeRegion"></a>
891 <div class="fixedFont">
892 <b class="itemname">resizeRegion</b> : Roo.lib.Region
898 <div class="short">Constrain the resize to a particular region</div>
903 Constrain the resize to a particular region
919 <tr class="config-row expandable config-row-alt0 notInherited">
920 <td class="micon"><a class="exi" href="#expand"> </a></td>
923 <a id="Roo.Resizable-cfg-transparent" name=".transparent"></a>
924 <div class="fixedFont">
925 <b class="itemname">transparent</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
931 <div class="short">True for transparent handles.</div>
936 True for transparent handles. This is only applied at config time. (defaults to false)
952 <tr class="config-row expandable config-row-alt1 notInherited">
953 <td class="micon"><a class="exi" href="#expand"> </a></td>
956 <a id="Roo.Resizable-cfg-width" name=".width"></a>
957 <div class="fixedFont">
958 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
964 <div class="short">The width of the element in pixels (defaults to null)</div>
969 The width of the element in pixels (defaults to null)
985 <tr class="config-row expandable config-row-alt0 notInherited">
986 <td class="micon"><a class="exi" href="#expand"> </a></td>
989 <a id="Roo.Resizable-cfg-widthIncrement" name=".widthIncrement"></a>
990 <div class="fixedFont">
991 <b class="itemname">widthIncrement</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
997 <div class="short">The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)</div>
1002 The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)
1010 <td class="msource">
1018 <tr class="config-row expandable config-row-alt1 notInherited">
1019 <td class="micon"><a class="exi" href="#expand"> </a></td>
1022 <a id="Roo.Resizable-cfg-wrap" name=".wrap"></a>
1023 <div class="fixedFont">
1024 <b class="itemname">wrap</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1030 <div class="short">True to wrap an element with a div if needed (required for textareas and images, defaults to false)</div>
1035 True to wrap an element with a div if needed (required for textareas and images, defaults to false)
1043 <td class="msource">
1061 <!-- ============================== public properties ==================== -->
1065 <a id="Roo.Resizable-props"></a>
1071 <table cellspacing="0" class="member-table">
1072 <caption class="Empty">Public Properties - Has None</caption>
1078 <!-- ============================== methods summary / details ======================== -->
1081 <a id="Roo.Resizable-methods"></a>
1082 <!-- constructor?? -->
1089 <!-- then dynamics first -->
1096 <table cellspacing="0" class="member-table">
1097 <caption>Public Methods</caption>
1099 <th class="sig-header" colspan="2">Method</th>
1100 <th class="msource-header">Defined By</th>
1110 <tr class="method-row config-row-alt0 expandable notInherited">
1111 <td class="micon"><a class="exi" href="#expand"> </a></td>
1115 <a id="Roo-method-Resizable" name=".Resizable"></a>
1116 <div class="fixedFont">
1117 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Resizable</b>
1119 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1127 <div class="short">Create a new Roo.Resizable</div>
1134 Create a new Roo.Resizable
1137 <dl class="detailList">
1138 <dt class="heading">Parameters:</dt>
1141 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
1144 <dd>The id or element to resize</dd>
1147 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
1150 <dd>configuration options</dd>
1168 <td class="msource">
1174 <tr class="method-row config-row-alt1 expandable">
1175 <td class="micon"><a class="exi" href="#expand"> </a></td>
1179 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1180 <div class="fixedFont">
1181 <span class="attributes"></span><b class="itemname">addEvents</b>
1183 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1190 <div class="short">Used to define events on this Observable</div>
1196 Used to define events on this Observable
1203 <dl class="detailList">
1204 <dt class="heading">Parameters:</dt>
1207 <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>
1210 <dd>The object with the events defined</dd>
1228 <td class="msource">
1230 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1236 <tr class="method-row config-row-alt0 expandable">
1237 <td class="micon"><a class="exi" href="#expand"> </a></td>
1241 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1242 <div class="fixedFont">
1243 <span class="attributes"></span><b class="itemname">addListener</b>
1245 (<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>)
1252 <div class="short">Appends an event handler to this component</div>
1258 Appends an event handler to this component
1265 <dl class="detailList">
1266 <dt class="heading">Parameters:</dt>
1269 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1272 <dd>The type of event to listen for</dd>
1275 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1278 <dd>The method the event invokes</dd>
1281 <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>
1284 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1287 <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>
1290 <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>
1308 <td class="msource">
1310 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1316 <tr class="method-row config-row-alt1 expandable notInherited">
1317 <td class="micon"><a class="exi" href="#expand"> </a></td>
1321 <a id="Roo.Resizable-method-destroy" name=".destroy"></a>
1322 <div class="fixedFont">
1323 <span class="attributes"></span><b class="itemname">destroy</b>
1325 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeEl</i></B>)
1332 <div class="short">Destroys this resizable.</div>
1338 Destroys this resizable. If the element was wrapped and<br/>removeEl is not true then the element remains.
1345 <dl class="detailList">
1346 <dt class="heading">Parameters:</dt>
1349 <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>
1352 <dd>(optional) true to remove the element from the DOM</dd>
1370 <td class="msource">
1378 <tr class="method-row config-row-alt0 expandable">
1379 <td class="micon"><a class="exi" href="#expand"> </a></td>
1383 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1384 <div class="fixedFont">
1385 <span class="attributes"></span><b class="itemname">fireEvent</b>
1387 (<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>)
1393 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1402 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1408 Fires the specified event with the passed parameters (minus the event name).
1415 <dl class="detailList">
1416 <dt class="heading">Parameters:</dt>
1419 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1425 <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>
1428 <dd>Variable number of parameters are passed to handlers</dd>
1436 <dl class="detailList">
1437 <dt class="heading">Returns:</dt>
1439 <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>
1453 <td class="msource">
1455 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1461 <tr class="method-row config-row-alt1 expandable notInherited">
1462 <td class="micon"><a class="exi" href="#expand"> </a></td>
1466 <a id="Roo.Resizable-method-getEl" name=".getEl"></a>
1467 <div class="fixedFont">
1468 <span class="attributes"></span><b class="itemname">getEl</b>
1476 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1485 <div class="short">Returns the element this component is bound to.</div>
1491 Returns the element this component is bound to.
1502 <dl class="detailList">
1503 <dt class="heading">Returns:</dt>
1505 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1519 <td class="msource">
1527 <tr class="method-row config-row-alt0 expandable notInherited">
1528 <td class="micon"><a class="exi" href="#expand"> </a></td>
1532 <a id="Roo.Resizable-method-getResizeChild" name=".getResizeChild"></a>
1533 <div class="fixedFont">
1534 <span class="attributes"></span><b class="itemname">getResizeChild</b>
1542 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1551 <div class="short">Returns the resizeChild element (or null).</div>
1557 Returns the resizeChild element (or null).
1568 <dl class="detailList">
1569 <dt class="heading">Returns:</dt>
1571 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1585 <td class="msource">
1593 <tr class="method-row config-row-alt1 expandable">
1594 <td class="micon"><a class="exi" href="#expand"> </a></td>
1598 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1599 <div class="fixedFont">
1600 <span class="attributes"></span><b class="itemname">hasListener</b>
1602 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1608 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1617 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1623 Checks to see if this object has any listeners for a specified event
1630 <dl class="detailList">
1631 <dt class="heading">Parameters:</dt>
1634 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1637 <dd>The name of the event to check for</dd>
1645 <dl class="detailList">
1646 <dt class="heading">Returns:</dt>
1648 <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>
1662 <td class="msource">
1664 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1670 <tr class="method-row config-row-alt0 expandable">
1671 <td class="micon"><a class="exi" href="#expand"> </a></td>
1675 <a id="Roo.util.Observable-method-on" name=".on"></a>
1676 <div class="fixedFont">
1677 <span class="attributes"></span><b class="itemname">on</b>
1679 (<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>)
1686 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1692 Appends an event handler to this element (shorthand for addListener)
1699 <dl class="detailList">
1700 <dt class="heading">Parameters:</dt>
1703 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1706 <dd>The type of event to listen for</dd>
1709 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1712 <dd>The method the event invokes</dd>
1715 <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>
1718 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1721 <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>
1742 <td class="msource">
1744 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1750 <tr class="method-row config-row-alt1 expandable">
1751 <td class="micon"><a class="exi" href="#expand"> </a></td>
1755 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1756 <div class="fixedFont">
1757 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1766 <div class="short">Removes all listeners for this object</div>
1772 Removes all listeners for this object
1793 <td class="msource">
1795 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1801 <tr class="method-row config-row-alt0 expandable">
1802 <td class="micon"><a class="exi" href="#expand"> </a></td>
1806 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1807 <div class="fixedFont">
1808 <span class="attributes"></span><b class="itemname">removeListener</b>
1810 (<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>)
1817 <div class="short">Removes a listener</div>
1830 <dl class="detailList">
1831 <dt class="heading">Parameters:</dt>
1834 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1837 <dd>The type of event to listen for</dd>
1840 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1843 <dd>The handler to remove</dd>
1846 <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>
1849 <dd>(optional) The scope (this object) for the handler</dd>
1867 <td class="msource">
1869 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1875 <tr class="method-row config-row-alt1 expandable notInherited">
1876 <td class="micon"><a class="exi" href="#expand"> </a></td>
1880 <a id="Roo.Resizable-method-resizeTo" name=".resizeTo"></a>
1881 <div class="fixedFont">
1882 <span class="attributes"></span><b class="itemname">resizeTo</b>
1884 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
1891 <div class="short">Perform a manual resize</div>
1897 Perform a manual resize
1904 <dl class="detailList">
1905 <dt class="heading">Parameters:</dt>
1908 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
1914 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
1935 <td class="msource">
1943 <tr class="method-row config-row-alt0 expandable">
1944 <td class="micon"><a class="exi" href="#expand"> </a></td>
1948 <a id="Roo.util.Observable-method-un" name=".un"></a>
1949 <div class="fixedFont">
1950 <span class="attributes"></span><b class="itemname">un</b>
1952 (<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>)
1959 <div class="short">Removes a listener (shorthand for removeListener)</div>
1965 Removes a listener (shorthand for removeListener)
1972 <dl class="detailList">
1973 <dt class="heading">Parameters:</dt>
1976 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1979 <dd>The type of event to listen for</dd>
1982 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1985 <dd>The handler to remove</dd>
1988 <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>
1991 <dd>(optional) The scope (this object) for the handler</dd>
2009 <td class="msource">
2011 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2020 <!-- ============================== events summary / details ======================== -->
2023 <a id="Roo.Resizable-events"></a>
2032 <table cellspacing="0" class="member-table">
2033 <caption>Events</caption>
2036 <th class="sig-header" colspan="2">Event</th>
2037 <th class="msource-header">Defined By</th>
2046 <tr class="method-row expandable config-row-alt0 notInherited">
2047 <td class="micon"><a class="exi" href="#expand"> </a></td>
2050 <a id="Roo.Resizable-event-*beforeresize"></a>
2052 <div class="fixedFont">
2053 <b class="itemname">beforeresize</b> (<a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a> <B><i>this</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2059 <div class="short">Fired before resize is allowed.
2065 Fired before resize is allowed. Set enabled to false to cancel resize.
2071 <dl class="detailList">
2072 <dt class="heading">Parameters:</dt>
2075 <span class="fixedFont"><a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a></span> <b>this</b>
2081 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2084 <dd>The mousedown event</dd>
2102 <td class="msource">
2107 <tr class="method-row expandable config-row-alt1 notInherited">
2108 <td class="micon"><a class="exi" href="#expand"> </a></td>
2111 <a id="Roo.Resizable-event-*resize"></a>
2113 <div class="fixedFont">
2114 <b class="itemname">resize</b> (<a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2120 <div class="short">Fired after a resize.
2126 Fired after a resize.
2132 <dl class="detailList">
2133 <dt class="heading">Parameters:</dt>
2136 <span class="fixedFont"><a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a></span> <b>this</b>
2142 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2145 <dd>The new width</dd>
2148 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2151 <dd>The new height</dd>
2154 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2157 <dd>The mouseup event</dd>
2175 <td class="msource">
2180 <tr class="method-row expandable config-row-alt0 notInherited">
2181 <td class="micon"><a class="exi" href="#expand"> </a></td>
2184 <a id="Roo.Resizable-event-*resizing"></a>
2186 <div class="fixedFont">
2187 <b class="itemname">resizing</b> (<a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>w</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>h</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2193 <div class="short">Fired a resizing.
2205 <dl class="detailList">
2206 <dt class="heading">Parameters:</dt>
2209 <span class="fixedFont"><a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a></span> <b>this</b>
2215 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2218 <dd>The new x position</dd>
2221 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2224 <dd>The new y position</dd>
2227 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>w</b>
2230 <dd>The new w width</dd>
2233 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>h</b>
2236 <dd>The new h hight</dd>
2239 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2242 <dd>The mouseup event</dd>
2260 <td class="msource">
2272 <!-- ============================== footer ================================= -->
2273 <div class="fineprint" style="clear:both">
2275 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu May 10 2018 15:50:15 GMT+0800 (HKT)
2277 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>