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>
143 <div class="long">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>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.Resizable-cfg-animate" name=".animate"></a>
162 <div class="fixedFont">
163 <b class="itemname">animate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
169 <div class="short">True to animate the resize (not compatible with dynamic sizing, defaults to false)</div>
173 <div class="long">True to animate the resize (not compatible with dynamic sizing, defaults to false)</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.Resizable-cfg-constrainTo" name=".constrainTo"></a>
192 <div class="fixedFont">
193 <b class="itemname">constrainTo</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
199 <div class="short">Constrain the resize to a particular element</div>
203 <div class="long">Constrain the resize to a particular element</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.Resizable-cfg-disableTrackOver" name=".disableTrackOver"></a>
222 <div class="fixedFont">
223 <b class="itemname">disableTrackOver</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
229 <div class="short">True to disable mouse tracking.</div>
233 <div class="long">True to disable mouse tracking. This is only applied at config time. (defaults to false)</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.Resizable-cfg-draggable" name=".draggable"></a>
252 <div class="fixedFont">
253 <b class="itemname">draggable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
259 <div class="short">Convenience to initialize drag drop (defaults to false)</div>
263 <div class="long">Convenience to initialize drag drop (defaults to false)</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.Resizable-cfg-duration" name=".duration"></a>
282 <div class="fixedFont">
283 <b class="itemname">duration</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
289 <div class="short">Animation duration if animate = true (defaults to .35)</div>
293 <div class="long">Animation duration if animate = true (defaults to .35)</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.Resizable-cfg-dynamic" name=".dynamic"></a>
312 <div class="fixedFont">
313 <b class="itemname">dynamic</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
319 <div class="short">True to resize the element while dragging instead of using a proxy (defaults to false)</div>
323 <div class="long">True to resize the element while dragging instead of using a proxy (defaults to false)</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.Resizable-cfg-easing" name=".easing"></a>
342 <div class="fixedFont">
343 <b class="itemname">easing</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
349 <div class="short">Animation easing if animate = true (defaults to 'easingOutStrong')</div>
353 <div class="long">Animation easing if animate = true (defaults to 'easingOutStrong')</div>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.Resizable-cfg-enabled" name=".enabled"></a>
372 <div class="fixedFont">
373 <b class="itemname">enabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
379 <div class="short">False to disable resizing (defaults to true)</div>
383 <div class="long">False to disable resizing (defaults to true)</div>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.Resizable-cfg-handles" name=".handles"></a>
402 <div class="fixedFont">
403 <b class="itemname">handles</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
409 <div class="short">String consisting of the resize handles to display (defaults to undefined)</div>
413 <div class="long">String consisting of the resize handles to display (defaults to undefined)</div>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.Resizable-cfg-height" name=".height"></a>
432 <div class="fixedFont">
433 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
439 <div class="short">The height of the element in pixels (defaults to null)</div>
443 <div class="long">The height of the element in pixels (defaults to null)</div>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.Resizable-cfg-heightIncrement" name=".heightIncrement"></a>
462 <div class="fixedFont">
463 <b class="itemname">heightIncrement</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
469 <div class="short">The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)</div>
473 <div class="long">The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)</div>
487 <tr class="config-row expandable config-row-alt0">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
492 <div class="fixedFont">
493 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
499 <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>
503 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
511 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
517 <tr class="config-row expandable config-row-alt1 notInherited">
518 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.Resizable-cfg-maxHeight" name=".maxHeight"></a>
522 <div class="fixedFont">
523 <b class="itemname">maxHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
529 <div class="short">The maximum height for the element (defaults to 10000)</div>
533 <div class="long">The maximum height for the element (defaults to 10000)</div>
547 <tr class="config-row expandable config-row-alt0 notInherited">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.Resizable-cfg-maxWidth" name=".maxWidth"></a>
552 <div class="fixedFont">
553 <b class="itemname">maxWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
559 <div class="short">The maximum width for the element (defaults to 10000)</div>
563 <div class="long">The maximum width for the element (defaults to 10000)</div>
577 <tr class="config-row expandable config-row-alt1 notInherited">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.Resizable-cfg-minHeight" name=".minHeight"></a>
582 <div class="fixedFont">
583 <b class="itemname">minHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
589 <div class="short">The minimum height for the element (defaults to 5)</div>
593 <div class="long">The minimum height for the element (defaults to 5)</div>
607 <tr class="config-row expandable config-row-alt0 notInherited">
608 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.Resizable-cfg-minWidth" name=".minWidth"></a>
612 <div class="fixedFont">
613 <b class="itemname">minWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
619 <div class="short">The minimum width for the element (defaults to 5)</div>
623 <div class="long">The minimum width for the element (defaults to 5)</div>
637 <tr class="config-row expandable config-row-alt1 notInherited">
638 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.Resizable-cfg-minX" name=".minX"></a>
642 <div class="fixedFont">
643 <b class="itemname">minX</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
649 <div class="short">The minimum allowed page X for the element (only used for west resizing, defaults to 0)</div>
653 <div class="long">The minimum allowed page X for the element (only used for west resizing, defaults to 0)</div>
667 <tr class="config-row expandable config-row-alt0 notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.Resizable-cfg-minY" name=".minY"></a>
672 <div class="fixedFont">
673 <b class="itemname">minY</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
679 <div class="short">The minimum allowed page Y for the element (only used for north resizing, defaults to 0)</div>
683 <div class="long">The minimum allowed page Y for the element (only used for north resizing, defaults to 0)</div>
697 <tr class="config-row expandable config-row-alt1 notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
701 <a id="Roo.Resizable-cfg-multiDirectional" name=".multiDirectional"></a>
702 <div class="fixedFont">
703 <b class="itemname">multiDirectional</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
709 <div class="short"><b>Deprecated</b>.</div>
713 <div class="long"><b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated<br/>in favor of the handles config option (defaults to false)</div>
727 <tr class="config-row expandable config-row-alt0 notInherited">
728 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.Resizable-cfg-pinned" name=".pinned"></a>
732 <div class="fixedFont">
733 <b class="itemname">pinned</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
739 <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>
743 <div class="long">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)</div>
757 <tr class="config-row expandable config-row-alt1 notInherited">
758 <td class="micon"><a class="exi" href="#expand"> </a></td>
761 <a id="Roo.Resizable-cfg-preserveRatio" name=".preserveRatio"></a>
762 <div class="fixedFont">
763 <b class="itemname">preserveRatio</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
769 <div class="short">True to preserve the original ratio between height and width during resize (defaults to false)</div>
773 <div class="long">True to preserve the original ratio between height and width during resize (defaults to false)</div>
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-resizeChild" name=".resizeChild"></a>
792 <div class="fixedFont">
793 <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
799 <div class="short">True to resize the first child, or id/element to resize (defaults to false)</div>
803 <div class="long">True to resize the first child, or id/element to resize (defaults to false)</div>
817 <tr class="config-row expandable config-row-alt1 notInherited">
818 <td class="micon"><a class="exi" href="#expand"> </a></td>
821 <a id="Roo.Resizable-cfg-resizeRegion" name=".resizeRegion"></a>
822 <div class="fixedFont">
823 <b class="itemname">resizeRegion</b> : Roo.lib.Region
829 <div class="short">Constrain the resize to a particular region</div>
833 <div class="long">Constrain the resize to a particular region</div>
847 <tr class="config-row expandable config-row-alt0 notInherited">
848 <td class="micon"><a class="exi" href="#expand"> </a></td>
851 <a id="Roo.Resizable-cfg-transparent" name=".transparent"></a>
852 <div class="fixedFont">
853 <b class="itemname">transparent</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
859 <div class="short">True for transparent handles.</div>
863 <div class="long">True for transparent handles. This is only applied at config time. (defaults to false)</div>
877 <tr class="config-row expandable config-row-alt1 notInherited">
878 <td class="micon"><a class="exi" href="#expand"> </a></td>
881 <a id="Roo.Resizable-cfg-width" name=".width"></a>
882 <div class="fixedFont">
883 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
889 <div class="short">The width of the element in pixels (defaults to null)</div>
893 <div class="long">The width of the element in pixels (defaults to null)</div>
907 <tr class="config-row expandable config-row-alt0 notInherited">
908 <td class="micon"><a class="exi" href="#expand"> </a></td>
911 <a id="Roo.Resizable-cfg-widthIncrement" name=".widthIncrement"></a>
912 <div class="fixedFont">
913 <b class="itemname">widthIncrement</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
919 <div class="short">The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)</div>
923 <div class="long">The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)</div>
937 <tr class="config-row expandable config-row-alt1 notInherited">
938 <td class="micon"><a class="exi" href="#expand"> </a></td>
941 <a id="Roo.Resizable-cfg-wrap" name=".wrap"></a>
942 <div class="fixedFont">
943 <b class="itemname">wrap</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
949 <div class="short">True to wrap an element with a div if needed (required for textareas and images, defaults to false)</div>
953 <div class="long">True to wrap an element with a div if needed (required for textareas and images, defaults to false)</div>
977 <!-- ============================== public properties ==================== -->
981 <a id="Roo.Resizable-props"></a>
987 <table cellspacing="0" class="member-table">
988 <caption class="Empty">Public Properties - Has None</caption>
994 <!-- ============================== methods summary / details ======================== -->
997 <a id="Roo.Resizable-methods"></a>
998 <!-- constructor?? -->
1005 <!-- then dynamics first -->
1012 <table cellspacing="0" class="member-table">
1013 <caption>Public Methods</caption>
1015 <th class="sig-header" colspan="2">Method</th>
1016 <th class="msource-header">Defined By</th>
1026 <tr class="method-row config-row-alt0 expandable notInherited">
1027 <td class="micon"><a class="exi" href="#expand"> </a></td>
1031 <a id="Roo-method-Resizable" name=".Resizable"></a>
1032 <div class="fixedFont">
1033 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Resizable</b>
1035 (<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>)
1043 <div class="short">Create a new Roo.Resizable</div>
1050 Create a new Roo.Resizable
1053 <dl class="detailList">
1054 <dt class="heading">Parameters:</dt>
1057 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
1060 <dd>The id or element to resize</dd>
1063 <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>
1066 <dd>configuration options</dd>
1084 <td class="msource">
1090 <tr class="method-row config-row-alt1 expandable">
1091 <td class="micon"><a class="exi" href="#expand"> </a></td>
1095 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1096 <div class="fixedFont">
1097 <span class="attributes"></span><b class="itemname">addEvents</b>
1099 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1106 <div class="short">Used to define events on this Observable</div>
1112 Used to define events on this Observable
1119 <dl class="detailList">
1120 <dt class="heading">Parameters:</dt>
1123 <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>
1126 <dd>The object with the events defined</dd>
1144 <td class="msource">
1146 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1152 <tr class="method-row config-row-alt0 expandable">
1153 <td class="micon"><a class="exi" href="#expand"> </a></td>
1157 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1158 <div class="fixedFont">
1159 <span class="attributes"></span><b class="itemname">addListener</b>
1161 (<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>)
1168 <div class="short">Appends an event handler to this component</div>
1174 Appends an event handler to this component
1181 <dl class="detailList">
1182 <dt class="heading">Parameters:</dt>
1185 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1188 <dd>The type of event to listen for</dd>
1191 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1194 <dd>The method the event invokes</dd>
1197 <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>
1200 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1203 <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>
1206 <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>
1224 <td class="msource">
1226 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1232 <tr class="method-row config-row-alt1 expandable notInherited">
1233 <td class="micon"><a class="exi" href="#expand"> </a></td>
1237 <a id="Roo.Resizable-method-destroy" name=".destroy"></a>
1238 <div class="fixedFont">
1239 <span class="attributes"></span><b class="itemname">destroy</b>
1241 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeEl</i></B>)
1248 <div class="short">Destroys this resizable.</div>
1254 Destroys this resizable. If the element was wrapped and<br/>removeEl is not true then the element remains.
1261 <dl class="detailList">
1262 <dt class="heading">Parameters:</dt>
1265 <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>
1268 <dd>(optional) true to remove the element from the DOM</dd>
1286 <td class="msource">
1294 <tr class="method-row config-row-alt0 expandable">
1295 <td class="micon"><a class="exi" href="#expand"> </a></td>
1299 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1300 <div class="fixedFont">
1301 <span class="attributes"></span><b class="itemname">fireEvent</b>
1303 (<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>)
1309 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1318 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1324 Fires the specified event with the passed parameters (minus the event name).
1331 <dl class="detailList">
1332 <dt class="heading">Parameters:</dt>
1335 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1341 <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>
1344 <dd>Variable number of parameters are passed to handlers</dd>
1352 <dl class="detailList">
1353 <dt class="heading">Returns:</dt>
1355 <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>
1369 <td class="msource">
1371 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1377 <tr class="method-row config-row-alt1 expandable notInherited">
1378 <td class="micon"><a class="exi" href="#expand"> </a></td>
1382 <a id="Roo.Resizable-method-getEl" name=".getEl"></a>
1383 <div class="fixedFont">
1384 <span class="attributes"></span><b class="itemname">getEl</b>
1392 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1401 <div class="short">Returns the element this component is bound to.</div>
1407 Returns the element this component is bound to.
1418 <dl class="detailList">
1419 <dt class="heading">Returns:</dt>
1421 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1435 <td class="msource">
1443 <tr class="method-row config-row-alt0 expandable notInherited">
1444 <td class="micon"><a class="exi" href="#expand"> </a></td>
1448 <a id="Roo.Resizable-method-getResizeChild" name=".getResizeChild"></a>
1449 <div class="fixedFont">
1450 <span class="attributes"></span><b class="itemname">getResizeChild</b>
1458 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1467 <div class="short">Returns the resizeChild element (or null).</div>
1473 Returns the resizeChild element (or null).
1484 <dl class="detailList">
1485 <dt class="heading">Returns:</dt>
1487 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1501 <td class="msource">
1509 <tr class="method-row config-row-alt1 expandable">
1510 <td class="micon"><a class="exi" href="#expand"> </a></td>
1514 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1515 <div class="fixedFont">
1516 <span class="attributes"></span><b class="itemname">hasListener</b>
1518 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1524 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1533 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1539 Checks to see if this object has any listeners for a specified event
1546 <dl class="detailList">
1547 <dt class="heading">Parameters:</dt>
1550 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1553 <dd>The name of the event to check for</dd>
1561 <dl class="detailList">
1562 <dt class="heading">Returns:</dt>
1564 <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>
1578 <td class="msource">
1580 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1586 <tr class="method-row config-row-alt0 expandable">
1587 <td class="micon"><a class="exi" href="#expand"> </a></td>
1591 <a id="Roo.util.Observable-method-on" name=".on"></a>
1592 <div class="fixedFont">
1593 <span class="attributes"></span><b class="itemname">on</b>
1595 (<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>)
1602 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1608 Appends an event handler to this element (shorthand for addListener)
1615 <dl class="detailList">
1616 <dt class="heading">Parameters:</dt>
1619 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1622 <dd>The type of event to listen for</dd>
1625 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1628 <dd>The method the event invokes</dd>
1631 <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>
1634 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1637 <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>
1658 <td class="msource">
1660 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1666 <tr class="method-row config-row-alt1 expandable">
1667 <td class="micon"><a class="exi" href="#expand"> </a></td>
1671 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1672 <div class="fixedFont">
1673 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1682 <div class="short">Removes all listeners for this object</div>
1688 Removes all listeners for this object
1709 <td class="msource">
1711 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1717 <tr class="method-row config-row-alt0 expandable">
1718 <td class="micon"><a class="exi" href="#expand"> </a></td>
1722 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1723 <div class="fixedFont">
1724 <span class="attributes"></span><b class="itemname">removeListener</b>
1726 (<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>)
1733 <div class="short">Removes a listener</div>
1746 <dl class="detailList">
1747 <dt class="heading">Parameters:</dt>
1750 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1753 <dd>The type of event to listen for</dd>
1756 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1759 <dd>The handler to remove</dd>
1762 <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>
1765 <dd>(optional) The scope (this object) for the handler</dd>
1783 <td class="msource">
1785 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1791 <tr class="method-row config-row-alt1 expandable notInherited">
1792 <td class="micon"><a class="exi" href="#expand"> </a></td>
1796 <a id="Roo.Resizable-method-resizeTo" name=".resizeTo"></a>
1797 <div class="fixedFont">
1798 <span class="attributes"></span><b class="itemname">resizeTo</b>
1800 (<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>)
1807 <div class="short">Perform a manual resize</div>
1813 Perform a manual resize
1820 <dl class="detailList">
1821 <dt class="heading">Parameters:</dt>
1824 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
1830 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
1851 <td class="msource">
1859 <tr class="method-row config-row-alt0 expandable">
1860 <td class="micon"><a class="exi" href="#expand"> </a></td>
1864 <a id="Roo.util.Observable-method-un" name=".un"></a>
1865 <div class="fixedFont">
1866 <span class="attributes"></span><b class="itemname">un</b>
1868 (<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>)
1875 <div class="short">Removes a listener (shorthand for removeListener)</div>
1881 Removes a listener (shorthand for removeListener)
1888 <dl class="detailList">
1889 <dt class="heading">Parameters:</dt>
1892 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1895 <dd>The type of event to listen for</dd>
1898 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1901 <dd>The handler to remove</dd>
1904 <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>
1907 <dd>(optional) The scope (this object) for the handler</dd>
1925 <td class="msource">
1927 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1936 <!-- ============================== events summary / details ======================== -->
1939 <a id="Roo.Resizable-events"></a>
1948 <table cellspacing="0" class="member-table">
1949 <caption>Events</caption>
1952 <th class="sig-header" colspan="2">Event</th>
1953 <th class="msource-header">Defined By</th>
1962 <tr class="method-row expandable config-row-alt0 notInherited">
1963 <td class="micon"><a class="exi" href="#expand"> </a></td>
1966 <a id="Roo.Resizable-event-*beforeresize"></a>
1968 <div class="fixedFont">
1969 <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>)
1975 <div class="short">Fired before resize is allowed.
1981 Fired before resize is allowed. Set enabled to false to cancel resize.
1987 <dl class="detailList">
1988 <dt class="heading">Parameters:</dt>
1991 <span class="fixedFont"><a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a></span> <b>this</b>
1997 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2000 <dd>The mousedown event</dd>
2018 <td class="msource">
2023 <tr class="method-row expandable config-row-alt1 notInherited">
2024 <td class="micon"><a class="exi" href="#expand"> </a></td>
2027 <a id="Roo.Resizable-event-*resize"></a>
2029 <div class="fixedFont">
2030 <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>)
2036 <div class="short">Fired after a resize.
2042 Fired after a resize.
2048 <dl class="detailList">
2049 <dt class="heading">Parameters:</dt>
2052 <span class="fixedFont"><a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a></span> <b>this</b>
2058 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2061 <dd>The new width</dd>
2064 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2067 <dd>The new height</dd>
2070 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2073 <dd>The mouseup event</dd>
2091 <td class="msource">
2103 <!-- ============================== footer ================================= -->
2104 <div class="fineprint" style="clear:both">
2106 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Feb 10 2011 17:59:20 GMT+0800 (HKT)
2108 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>