source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.Resizable.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 43.5 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.Resizable-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.Resizable-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.Resizable-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                            <a class="inner-link" href="#Ext.Resizable-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                        <a class="bookmark" href="../docs/?class=Ext.Resizable"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8        </div>
9                <div class="inheritance res-block">
10<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11  <img src="resources/elbow-end.gif"/>Resizable</pre></div>
12                <h1>Class Ext.Resizable</h1>
13        <table cellspacing="0">
14            <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
15            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Resizable.js" target="_blank">Resizable.js</a></td></tr>
16            <tr><td class="label">Class:</td><td class="hd-info">Resizable</td></tr>
17                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
18                    </table>
19        <div class="description">
20            *
21<p>Applies drag handles to an element to make it resizable. The drag handles are inserted into the element
22and positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap
23the 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
24the element will be wrapped for you automatically.</p>
25<p>Here is the list of valid resize handles:</p>
26<pre>Value   Description
27------  -------------------
28 'n'     north
29 's'     south
30 'e'     east
31 'w'     west
32 'nw'    northwest
33 'sw'    southwest
34 'se'    southeast
35 'ne'    northeast
36 'all'   all</pre>
37<p>Here's an example showing the creation of a typical Resizable:</p>
38<pre><code>var resizer = <b>new</b> Ext.Resizable(<em>"element-id"</em>, {
39    handles: <em>'all'</em>,
40    minWidth: 200,
41    minHeight: 100,
42    maxWidth: 500,
43    maxHeight: 400,
44    pinned: true
45});
46resizer.on(<em>"resize"</em>, myHandler);</code></pre>
47<p>To hide a particular handle, set its display to none in CSS, or through script:<br>
48resizer.east.setDisplayed(false);</p>        </div>
49       
50        <div class="hr"></div>
51                <a id="Ext.Resizable-configs"></a>
52        <h2>Config Options</h2>
53        <table cellspacing="0" class="member-table">
54            <tr>
55                <th class="sig-header" colspan="2">Config Options</th>
56                <th class="msource-header">Defined By</th>
57            </tr>
58                <tr class="config-row expandable">
59        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
60        <td class="sig">
61        <a id="Ext.Resizable-adjustments"></a>
62            <b>adjustments</b> : Array/String            <div class="mdesc">
63                        <div class="short">String "auto" or an array [width, height] with values to be added to the resize operation's new size (defaults to [0,...</div>
64            <div class="long">
65                String "auto" or an array [width, height] with values to be <b>added</b> to the resize operation's new size (defaults to [0, 0])            </div>
66                        </div>
67        </td>
68        <td class="msource">Resizable</td>
69    </tr>
70        <tr class="config-row alt">
71        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
72        <td class="sig">
73        <a id="Ext.Resizable-animate"></a>
74            <b>animate</b> : Boolean            <div class="mdesc">
75                            True to animate the resize (not compatible with dynamic sizing, defaults to false)                        </div>
76        </td>
77        <td class="msource">Resizable</td>
78    </tr>
79        <tr class="config-row">
80        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
81        <td class="sig">
82        <a id="Ext.Resizable-constrainTo"></a>
83            <b>constrainTo</b> : Mixed            <div class="mdesc">
84                            Constrain the resize to a particular element                        </div>
85        </td>
86        <td class="msource">Resizable</td>
87    </tr>
88        <tr class="config-row alt">
89        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
90        <td class="sig">
91        <a id="Ext.Resizable-disableTrackOver"></a>
92            <b>disableTrackOver</b> : Boolean            <div class="mdesc">
93                            True to disable mouse tracking. This is only applied at config time. (defaults to false)                        </div>
94        </td>
95        <td class="msource">Resizable</td>
96    </tr>
97        <tr class="config-row">
98        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
99        <td class="sig">
100        <a id="Ext.Resizable-draggable"></a>
101            <b>draggable</b> : Boolean            <div class="mdesc">
102                            Convenience to initialize drag drop (defaults to false)                        </div>
103        </td>
104        <td class="msource">Resizable</td>
105    </tr>
106        <tr class="config-row alt">
107        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
108        <td class="sig">
109        <a id="Ext.Resizable-duration"></a>
110            <b>duration</b> : Number            <div class="mdesc">
111                            Animation duration if animate = true (defaults to .35)                        </div>
112        </td>
113        <td class="msource">Resizable</td>
114    </tr>
115        <tr class="config-row">
116        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
117        <td class="sig">
118        <a id="Ext.Resizable-dynamic"></a>
119            <b>dynamic</b> : Boolean            <div class="mdesc">
120                            True to resize the element while dragging instead of using a proxy (defaults to false)                        </div>
121        </td>
122        <td class="msource">Resizable</td>
123    </tr>
124        <tr class="config-row alt">
125        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
126        <td class="sig">
127        <a id="Ext.Resizable-easing"></a>
128            <b>easing</b> : String            <div class="mdesc">
129                            Animation easing if animate = true (defaults to 'easingOutStrong')                        </div>
130        </td>
131        <td class="msource">Resizable</td>
132    </tr>
133        <tr class="config-row">
134        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
135        <td class="sig">
136        <a id="Ext.Resizable-enabled"></a>
137            <b>enabled</b> : Boolean            <div class="mdesc">
138                            False to disable resizing (defaults to true)                        </div>
139        </td>
140        <td class="msource">Resizable</td>
141    </tr>
142        <tr class="config-row alt">
143        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
144        <td class="sig">
145        <a id="Ext.Resizable-handles"></a>
146            <b>handles</b> : String            <div class="mdesc">
147                            String consisting of the resize handles to display (defaults to undefined)                        </div>
148        </td>
149        <td class="msource">Resizable</td>
150    </tr>
151        <tr class="config-row">
152        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
153        <td class="sig">
154        <a id="Ext.Resizable-height"></a>
155            <b>height</b> : Number            <div class="mdesc">
156                            The height of the element in pixels (defaults to null)                        </div>
157        </td>
158        <td class="msource">Resizable</td>
159    </tr>
160        <tr class="config-row alt">
161        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
162        <td class="sig">
163        <a id="Ext.Resizable-heightIncrement"></a>
164            <b>heightIncrement</b> : Number            <div class="mdesc">
165                            The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)                        </div>
166        </td>
167        <td class="msource">Resizable</td>
168    </tr>
169        <tr class="config-row inherited expandable">
170        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
171        <td class="sig">
172        <a id="Ext.Resizable-listeners"></a>
173            <b>listeners</b> : Object            <div class="mdesc">
174                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
175            <div class="long">
176                (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>
177                        </div>
178        </td>
179        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
180    </tr>
181        <tr class="config-row alt">
182        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
183        <td class="sig">
184        <a id="Ext.Resizable-maxHeight"></a>
185            <b>maxHeight</b> : Number            <div class="mdesc">
186                            The maximum height for the element (defaults to 10000)                        </div>
187        </td>
188        <td class="msource">Resizable</td>
189    </tr>
190        <tr class="config-row">
191        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
192        <td class="sig">
193        <a id="Ext.Resizable-maxWidth"></a>
194            <b>maxWidth</b> : Number            <div class="mdesc">
195                            The maximum width for the element (defaults to 10000)                        </div>
196        </td>
197        <td class="msource">Resizable</td>
198    </tr>
199        <tr class="config-row alt">
200        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
201        <td class="sig">
202        <a id="Ext.Resizable-minHeight"></a>
203            <b>minHeight</b> : Number            <div class="mdesc">
204                            The minimum height for the element (defaults to 5)                        </div>
205        </td>
206        <td class="msource">Resizable</td>
207    </tr>
208        <tr class="config-row">
209        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
210        <td class="sig">
211        <a id="Ext.Resizable-minWidth"></a>
212            <b>minWidth</b> : Number            <div class="mdesc">
213                            The minimum width for the element (defaults to 5)                        </div>
214        </td>
215        <td class="msource">Resizable</td>
216    </tr>
217        <tr class="config-row alt">
218        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
219        <td class="sig">
220        <a id="Ext.Resizable-minX"></a>
221            <b>minX</b> : Number            <div class="mdesc">
222                            The minimum allowed page X for the element (only used for west resizing, defaults to 0)                        </div>
223        </td>
224        <td class="msource">Resizable</td>
225    </tr>
226        <tr class="config-row">
227        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
228        <td class="sig">
229        <a id="Ext.Resizable-minY"></a>
230            <b>minY</b> : Number            <div class="mdesc">
231                            The minimum allowed page Y for the element (only used for north resizing, defaults to 0)                        </div>
232        </td>
233        <td class="msource">Resizable</td>
234    </tr>
235        <tr class="config-row alt expandable">
236        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
237        <td class="sig">
238        <a id="Ext.Resizable-multiDirectional"></a>
239            <b>multiDirectional</b> : Boolean            <div class="mdesc">
240                        <div class="short">Deprecated. The old style of adding multi-direction resize handles, deprecated in favor of the handles config option ...</div>
241            <div class="long">
242                <b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated in favor of the handles config option (defaults to false)            </div>
243                        </div>
244        </td>
245        <td class="msource">Resizable</td>
246    </tr>
247        <tr class="config-row expandable">
248        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
249        <td class="sig">
250        <a id="Ext.Resizable-pinned"></a>
251            <b>pinned</b> : Boolean            <div class="mdesc">
252                        <div class="short">True to ensure that the resize handles are always visible, false to display them only when the user mouses over the r...</div>
253            <div class="long">
254                True to ensure that the resize handles are always visible, false to display them only when the user mouses over the resizable borders. This is only applied at config time. (defaults to false)            </div>
255                        </div>
256        </td>
257        <td class="msource">Resizable</td>
258    </tr>
259        <tr class="config-row alt">
260        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
261        <td class="sig">
262        <a id="Ext.Resizable-preserveRatio"></a>
263            <b>preserveRatio</b> : Boolean            <div class="mdesc">
264                            True to preserve the original ratio between height and width during resize (defaults to false)                        </div>
265        </td>
266        <td class="msource">Resizable</td>
267    </tr>
268        <tr class="config-row">
269        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
270        <td class="sig">
271        <a id="Ext.Resizable-resizeChild"></a>
272            <b>resizeChild</b> : Boolean/String/Element            <div class="mdesc">
273                            True to resize the first child, or id/element to resize (defaults to false)                        </div>
274        </td>
275        <td class="msource">Resizable</td>
276    </tr>
277        <tr class="config-row alt">
278        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
279        <td class="sig">
280        <a id="Ext.Resizable-resizeRegion"></a>
281            <b>resizeRegion</b> : Ext.lib.Region            <div class="mdesc">
282                            Constrain the resize to a particular region                        </div>
283        </td>
284        <td class="msource">Resizable</td>
285    </tr>
286        <tr class="config-row">
287        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
288        <td class="sig">
289        <a id="Ext.Resizable-transparent"></a>
290            <b>transparent</b> : Boolean            <div class="mdesc">
291                            True for transparent handles. This is only applied at config time. (defaults to false)                        </div>
292        </td>
293        <td class="msource">Resizable</td>
294    </tr>
295        <tr class="config-row alt">
296        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
297        <td class="sig">
298        <a id="Ext.Resizable-width"></a>
299            <b>width</b> : Number            <div class="mdesc">
300                            The width of the element in pixels (defaults to null)                        </div>
301        </td>
302        <td class="msource">Resizable</td>
303    </tr>
304        <tr class="config-row">
305        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
306        <td class="sig">
307        <a id="Ext.Resizable-widthIncrement"></a>
308            <b>widthIncrement</b> : Number            <div class="mdesc">
309                            The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)                        </div>
310        </td>
311        <td class="msource">Resizable</td>
312    </tr>
313        <tr class="config-row alt">
314        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
315        <td class="sig">
316        <a id="Ext.Resizable-wrap"></a>
317            <b>wrap</b> : Boolean            <div class="mdesc">
318                            True to wrap an element with a div if needed (required for textareas and images, defaults to false)                        </div>
319        </td>
320        <td class="msource">Resizable</td>
321    </tr>
322            </table>
323                <a id="Ext.Resizable-props"></a>
324        <h2>Public Properties</h2>
325                <table cellspacing="0" class="member-table">
326            <tr>
327                <th class="sig-header" colspan="2">Property</th>
328                <th class="msource-header">Defined By</th>
329            </tr>
330                <tr class="property-row expandable">
331        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
332        <td class="sig">
333        <a id="Ext.Resizable-proxy"></a>
334            <b>proxy</b> : Ext.Element.            <div class="mdesc">
335                        <div class="short">The proxy Element that is resized in place of the real Element during the resize operation.
336This may be queried using...</div>
337            <div class="long">
338                The proxy Element that is resized in place of the real Element during the resize operation.
339This may be queried using <a ext:cls="Ext.Element" ext:member="getBox" href="output/Ext.Element.html#getBox">Ext.Element.getBox</a> to provide the new area to resize to.
340Read only.            </div>
341                        </div>
342        </td>
343        <td class="msource">Resizable</td>
344    </tr>
345            </table>
346                <a id="Ext.Resizable-methods"></a>
347        <h2>Public Methods</h2>
348                <table cellspacing="0" class="member-table">
349            <tr>
350                <th class="sig-header" colspan="2">Method</th>
351                <th class="msource-header">Defined By</th>
352            </tr>
353                <tr class="method-row expandable">
354        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
355        <td class="sig">
356        <a id="Ext.Resizable-Resizable"></a>
357            <b>Resizable</b>(&nbsp;<code>Mixed el</code>, <code>Object config</code>&nbsp;)            <div class="mdesc">
358                        <div class="short">Create a new resizable component</div>
359            <div class="long">
360                Create a new resizable component    <div class="mdetail-params">
361        <strong>Parameters:</strong>
362        <ul><li><code>el</code> : Mixed<div class="sub-desc">The id or element to resize</div></li><li><code>config</code> : Object<div class="sub-desc">configuration options</div></li>        </ul>
363        <strong>Returns:</strong>
364        <ul>
365            <li><code></code></li>
366        </ul>
367    </div>
368                </div>
369                        </div>
370        </td>
371        <td class="msource">Resizable</td>
372    </tr>
373        <tr class="method-row inherited alt expandable">
374        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
375        <td class="sig">
376        <a id="Ext.Resizable-addEvents"></a>
377            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
378                        <div class="short">Used to define events on this Observable</div>
379            <div class="long">
380                Used to define events on this Observable    <div class="mdetail-params">
381        <strong>Parameters:</strong>
382        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
383        <strong>Returns:</strong>
384        <ul>
385            <li><code>void</code></li>
386        </ul>
387    </div>
388                </div>
389                        </div>
390        </td>
391        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
392    </tr>
393        <tr class="method-row inherited expandable">
394        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
395        <td class="sig">
396        <a id="Ext.Resizable-addListener"></a>
397            <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
398                        <div class="short">Appends an event handler to this component</div>
399            <div class="long">
400                Appends an event handler to this component    <div class="mdetail-params">
401        <strong>Parameters:</strong>
402        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
403function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
404properties. This may contain any of the following properties:<ul>
405<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
406<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
407<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
408<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
409by the specified number of milliseconds. If the event fires again within that time, the original
410handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
411</ul><br>
412<p>
413<b>Combining Options</b><br>
414Using the options argument, it is possible to combine different types of listeners:<br>
415<br>
416A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
417<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
418    single: true,
419    delay: 100,
420    forumId: 4
421});</code></pre>
422<p>
423<b>Attaching multiple handlers in 1 call</b><br>
424The method also allows for a single argument to be passed which is a config object containing properties
425which specify multiple handlers.
426<p>
427<pre><code>foo.on({
428    <em>'click'</em> : {
429        fn: <b>this</b>.onClick,
430        scope: <b>this</b>,
431        delay: 100
432    },
433    <em>'mouseover'</em> : {
434        fn: <b>this</b>.onMouseOver,
435        scope: <b>this</b>
436    },
437    <em>'mouseout'</em> : {
438        fn: <b>this</b>.onMouseOut,
439        scope: <b>this</b>
440    }
441});</code></pre>
442<p>
443Or a shorthand syntax:<br>
444<pre><code>foo.on({
445    <em>'click'</em> : <b>this</b>.onClick,
446    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
447    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
448     scope: <b>this</b>
449});</code></pre></div></li>        </ul>
450        <strong>Returns:</strong>
451        <ul>
452            <li><code>void</code></li>
453        </ul>
454    </div>
455                </div>
456                        </div>
457        </td>
458        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
459    </tr>
460        <tr class="method-row alt expandable">
461        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
462        <td class="sig">
463        <a id="Ext.Resizable-destroy"></a>
464            <b>destroy</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean removeEl</code>]</span>&nbsp;) : void            <div class="mdesc">
465                        <div class="short">Destroys this resizable. If the element was wrapped and
466removeEl is not true then the element remains.</div>
467            <div class="long">
468                Destroys this resizable. If the element was wrapped and
469removeEl is not true then the element remains.    <div class="mdetail-params">
470        <strong>Parameters:</strong>
471        <ul><li><code>removeEl</code> : Boolean<div class="sub-desc">(optional) true to remove the element from the DOM</div></li>        </ul>
472        <strong>Returns:</strong>
473        <ul>
474            <li><code>void</code></li>
475        </ul>
476    </div>
477                </div>
478                        </div>
479        </td>
480        <td class="msource">Resizable</td>
481    </tr>
482        <tr class="method-row inherited expandable">
483        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
484        <td class="sig">
485        <a id="Ext.Resizable-fireEvent"></a>
486            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
487                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
488            <div class="long">
489                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
490        <strong>Parameters:</strong>
491        <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>
492        <strong>Returns:</strong>
493        <ul>
494            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
495        </ul>
496    </div>
497                </div>
498                        </div>
499        </td>
500        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
501    </tr>
502        <tr class="method-row alt expandable">
503        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
504        <td class="sig">
505        <a id="Ext.Resizable-getEl"></a>
506            <b>getEl</b>() : Ext.Element            <div class="mdesc">
507                        <div class="short">Returns the element this component is bound to.</div>
508            <div class="long">
509                Returns the element this component is bound to.    <div class="mdetail-params">
510        <strong>Parameters:</strong>
511        <ul><li>None.</li>        </ul>
512        <strong>Returns:</strong>
513        <ul>
514            <li><code>Ext.Element</code></li>
515        </ul>
516    </div>
517                </div>
518                        </div>
519        </td>
520        <td class="msource">Resizable</td>
521    </tr>
522        <tr class="method-row expandable">
523        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
524        <td class="sig">
525        <a id="Ext.Resizable-getResizeChild"></a>
526            <b>getResizeChild</b>() : Ext.Element            <div class="mdesc">
527                        <div class="short">Returns the resizeChild element (or null).</div>
528            <div class="long">
529                Returns the resizeChild element (or null).    <div class="mdetail-params">
530        <strong>Parameters:</strong>
531        <ul><li>None.</li>        </ul>
532        <strong>Returns:</strong>
533        <ul>
534            <li><code>Ext.Element</code></li>
535        </ul>
536    </div>
537                </div>
538                        </div>
539        </td>
540        <td class="msource">Resizable</td>
541    </tr>
542        <tr class="method-row inherited alt expandable">
543        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
544        <td class="sig">
545        <a id="Ext.Resizable-hasListener"></a>
546            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
547                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
548            <div class="long">
549                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
550        <strong>Parameters:</strong>
551        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
552        <strong>Returns:</strong>
553        <ul>
554            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
555        </ul>
556    </div>
557                </div>
558                        </div>
559        </td>
560        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
561    </tr>
562        <tr class="method-row inherited expandable">
563        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
564        <td class="sig">
565        <a id="Ext.Resizable-on"></a>
566            <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">
567                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
568            <div class="long">
569                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
570        <strong>Parameters:</strong>
571        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
572function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
573        <strong>Returns:</strong>
574        <ul>
575            <li><code>void</code></li>
576        </ul>
577    </div>
578                </div>
579                        </div>
580        </td>
581        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
582    </tr>
583        <tr class="method-row inherited alt expandable">
584        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
585        <td class="sig">
586        <a id="Ext.Resizable-purgeListeners"></a>
587            <b>purgeListeners</b>() : void            <div class="mdesc">
588                        <div class="short">Removes all listeners for this object</div>
589            <div class="long">
590                Removes all listeners for this object    <div class="mdetail-params">
591        <strong>Parameters:</strong>
592        <ul><li>None.</li>        </ul>
593        <strong>Returns:</strong>
594        <ul>
595            <li><code>void</code></li>
596        </ul>
597    </div>
598                </div>
599                        </div>
600        </td>
601        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
602    </tr>
603        <tr class="method-row inherited expandable">
604        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
605        <td class="sig">
606        <a id="Ext.Resizable-relayEvents"></a>
607            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
608                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
609            <div class="long">
610                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
611        <strong>Parameters:</strong>
612        <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>
613        <strong>Returns:</strong>
614        <ul>
615            <li><code>void</code></li>
616        </ul>
617    </div>
618                </div>
619                        </div>
620        </td>
621        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
622    </tr>
623        <tr class="method-row inherited alt expandable">
624        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
625        <td class="sig">
626        <a id="Ext.Resizable-removeListener"></a>
627            <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
628                        <div class="short">Removes a listener</div>
629            <div class="long">
630                Removes a listener    <div class="mdetail-params">
631        <strong>Parameters:</strong>
632        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
633        <strong>Returns:</strong>
634        <ul>
635            <li><code>void</code></li>
636        </ul>
637    </div>
638                </div>
639                        </div>
640        </td>
641        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
642    </tr>
643        <tr class="method-row expandable">
644        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
645        <td class="sig">
646        <a id="Ext.Resizable-resizeElement"></a>
647            <b>resizeElement</b>() : void            <div class="mdesc">
648                        <div class="short">Performs resizing of the associated Element. This method is called internally by this
649class, and should not be called...</div>
650            <div class="long">
651                <p>Performs resizing of the associated Element. This method is called internally by this
652class, and should not be called by user code.</p>
653<p>If a Resizable is being used to resize an Element which encapsulates a more complex UI
654component such as a Panel, this method may be overridden by specifying an implementation
655as a config option to provide appropriate behaviour at the end of the resize operation on
656mouseup, for example resizing the Panel, and relaying the Panel's content.</p>
657<p>The new area to be resized to is available by examining the state of the <a ext:cls="Ext.Resizable" ext:member="proxy" href="output/Ext.Resizable.html#proxy">proxy</a>
658Element. Example:
659<pre><code>new Ext.Panel({
660    title: <em>'Resize me'</em>,
661    x: 100,
662    y: 100,
663    renderTo: Ext.getBody(),
664    floating: true,
665    frame: true,
666    width: 400,
667    height: 200,
668    listeners: {
669        render: <b>function</b>(p) {
670            <b>new</b> Ext.Resizable(p.getEl(), {
671                handles: <em>'all'</em>,
672                pinned: true,
673                transparent: true,
674                resizeElement: <b>function</b>() {
675                    <b>var</b> box = <b>this</b>.proxy.getBox();
676                    p.updateBox(box);
677                    <b>if</b> (p.layout) {
678                        p.doLayout();
679                    }
680                    <b>return</b> box;
681                }
682           });
683       }
684    }
685}).show();</code></pre>    <div class="mdetail-params">
686        <strong>Parameters:</strong>
687        <ul><li>None.</li>        </ul>
688        <strong>Returns:</strong>
689        <ul>
690            <li><code>void</code></li>
691        </ul>
692    </div>
693                </div>
694                        </div>
695        </td>
696        <td class="msource">Resizable</td>
697    </tr>
698        <tr class="method-row alt expandable">
699        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
700        <td class="sig">
701        <a id="Ext.Resizable-resizeTo"></a>
702            <b>resizeTo</b>(&nbsp;<code>Number width</code>, <code>Number height</code>&nbsp;) : void            <div class="mdesc">
703                        <div class="short">
704Perform a manual resize</div>
705            <div class="long">
706               
707Perform a manual resize    <div class="mdetail-params">
708        <strong>Parameters:</strong>
709        <ul><li><code>width</code> : Number<div class="sub-desc"></div></li><li><code>height</code> : Number<div class="sub-desc"></div></li>        </ul>
710        <strong>Returns:</strong>
711        <ul>
712            <li><code>void</code></li>
713        </ul>
714    </div>
715                </div>
716                        </div>
717        </td>
718        <td class="msource">Resizable</td>
719    </tr>
720        <tr class="method-row inherited expandable">
721        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
722        <td class="sig">
723        <a id="Ext.Resizable-resumeEvents"></a>
724            <b>resumeEvents</b>() : void            <div class="mdesc">
725                        <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
726            <div class="long">
727                Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">
728        <strong>Parameters:</strong>
729        <ul><li>None.</li>        </ul>
730        <strong>Returns:</strong>
731        <ul>
732            <li><code>void</code></li>
733        </ul>
734    </div>
735                </div>
736                        </div>
737        </td>
738        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
739    </tr>
740        <tr class="method-row inherited alt expandable">
741        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
742        <td class="sig">
743        <a id="Ext.Resizable-suspendEvents"></a>
744            <b>suspendEvents</b>() : void            <div class="mdesc">
745                        <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
746            <div class="long">
747                Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">
748        <strong>Parameters:</strong>
749        <ul><li>None.</li>        </ul>
750        <strong>Returns:</strong>
751        <ul>
752            <li><code>void</code></li>
753        </ul>
754    </div>
755                </div>
756                        </div>
757        </td>
758        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
759    </tr>
760        <tr class="method-row inherited expandable">
761        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
762        <td class="sig">
763        <a id="Ext.Resizable-un"></a>
764            <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
765                        <div class="short">Removes a listener (shorthand for removeListener)</div>
766            <div class="long">
767                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
768        <strong>Parameters:</strong>
769        <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>
770        <strong>Returns:</strong>
771        <ul>
772            <li><code>void</code></li>
773        </ul>
774    </div>
775                </div>
776                        </div>
777        </td>
778        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
779    </tr>
780            </table>
781                <a id="Ext.Resizable-events"></a>
782        <h2>Public Events</h2>
783                <table cellspacing="0" class="member-table">
784            <tr>
785                <th class="sig-header" colspan="2">Event</th>
786                <th class="msource-header">Defined By</th>
787            </tr>
788                <tr class="event-row expandable">
789        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
790        <td class="sig">
791        <a id="Ext.Resizable-beforeresize"></a>
792            <b>beforeresize</b> : (&nbsp;<code>Ext.Resizable this</code>, <code>Ext.EventObject e</code>&nbsp;)            <div class="mdesc">
793                        <div class="short">
794Fired before resize is allowed. Set enabled to false to cancel resize.</div>
795            <div class="long">
796               
797Fired before resize is allowed. Set enabled to false to cancel resize.    <div class="mdetail-params">
798        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
799        <ul><li><code>this</code> : Ext.Resizable<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The mousedown event</div></li>        </ul>
800    </div>
801                </div>
802                        </div>
803        </td>
804        <td class="msource">Resizable</td>
805    </tr>
806        <tr class="event-row alt expandable">
807        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
808        <td class="sig">
809        <a id="Ext.Resizable-resize"></a>
810            <b>resize</b> : (&nbsp;<code>Ext.Resizable this</code>, <code>Number width</code>, <code>Number height</code>, <code>Ext.EventObject e</code>&nbsp;)            <div class="mdesc">
811                        <div class="short">
812Fired after a resize.</div>
813            <div class="long">
814               
815Fired after a resize.    <div class="mdetail-params">
816        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
817        <ul><li><code>this</code> : Ext.Resizable<div class="sub-desc"></div></li><li><code>width</code> : Number<div class="sub-desc">The new width</div></li><li><code>height</code> : Number<div class="sub-desc">The new height</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The mouseup event</div></li>        </ul>
818    </div>
819                </div>
820                        </div>
821        </td>
822        <td class="msource">Resizable</td>
823    </tr>
824            </table>
825       
826        </div>
Note: See TracBrowser for help on using the repository browser.