Observable Resizable
Package: | Ext |
Defined In: | Resizable.js |
Class: | Resizable |
Extends: | Observable |
Applies drag handles to an element to make it resizable. The drag handles are inserted into the element and positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap the textarea in a div and set 'resizeChild' to true (or to the id of the element), or set wrap:true in your config and the element will be wrapped for you automatically.
Here is the list of valid resize handles:
Value Description ------ ------------------- 'n' north 's' south 'e' east 'w' west 'nw' northwest 'sw' southwest 'se' southeast 'ne' northeast 'all' all
Here's an example showing the creation of a typical Resizable:
var resizer = new Ext.Resizable('element-id', {
handles: 'all',
minWidth: 200,
minHeight: 100,
maxWidth: 500,
maxHeight: 400,
pinned: true
});
resizer.on('resize', myHandler);
To hide a particular handle, set its display to none in CSS, or through script:
resizer.east.setDisplayed(false);
Config Options | Defined By | |
---|---|---|
adjustments : Array/String String 'auto' or an array [width, height] with values to be added to the
resize operation's new size (defaults to [0,... String 'auto' or an array [width, height] with values to be added to the
resize operation's new size (defaults to [0, 0]) | Resizable | |
animate : Boolean True to animate the resize (not compatible with dynamic sizing, defaults to false) | Resizable | |
constrainTo : Mixed Constrain the resize to a particular element | Resizable | |
disableTrackOver : Boolean True to disable mouse tracking. This is only applied at config time. (defaults to false) | Resizable | |
draggable : Boolean Convenience to initialize drag drop (defaults to false) | Resizable | |
duration : Number Animation duration if animate = true (defaults to 0.35) | Resizable | |
dynamic : Boolean True to resize the element while dragging instead of using a proxy (defaults to false) | Resizable | |
easing : String Animation easing if animate = true (defaults to 'easingOutStrong') | Resizable | |
enabled : Boolean False to disable resizing (defaults to true) | Resizable | |
handleCls : String A css class to add to each handle. Defaults to ''. | Resizable | |
handles : String String consisting of the resize handles to display (defaults to undefined).
Specify either 'all' or any of 'n s e w n... String consisting of the resize handles to display (defaults to undefined).
Specify either 'all' or any of 'n s e w ne nw se sw'. | Resizable | |
height : Number The height of the element in pixels (defaults to null) | Resizable | |
heightIncrement : Number The increment to snap the height resize in pixels
(only applies if dynamic==true ). Defaults to 0. | Resizable | |
listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... 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 addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
is usually only done when extra value can be added. For example the DataView's
| Observable | |
maxHeight : Number The maximum height for the element (defaults to 10000) | Resizable | |
maxWidth : Number The maximum width for the element (defaults to 10000) | Resizable | |
minHeight : Number The minimum height for the element (defaults to 5) | Resizable | |
minWidth : Number The minimum width for the element (defaults to 5) | Resizable | |
minX : Number The minimum x for the element (defaults to 0) | Resizable | |
minY : Number The minimum x for the element (defaults to 0) | Resizable | |
multiDirectional : Boolean Deprecated. Deprecated style of adding multi-direction resize handles. | Resizable | |
pinned : Boolean True to ensure that the resize handles are always visible, false to display them only when the
user mouses over the r... 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) | Resizable | |
preserveRatio : Boolean True to preserve the original ratio between height
and width during resize (defaults to false) | Resizable | |
resizeChild : Boolean/String/Element True to resize the first child, or id/element to resize (defaults to false) | Resizable | |
resizeRegion : Ext.lib.Region Constrain the resize to a particular region | Resizable | |
transparent : Boolean True for transparent handles. This is only applied at config time. (defaults to false) | Resizable | |
width : Number The width of the element in pixels (defaults to null) | Resizable | |
widthIncrement : Number The increment to snap the width resize in pixels
(only applies if dynamic==true ). Defaults to 0. | Resizable | |
wrap : Boolean True to wrap an element with a div if needed (required for textareas and images, defaults to false)
in favor of the h... True to wrap an element with a div if needed (required for textareas and images, defaults to false)
in favor of the handles config option (defaults to false) | Resizable |
Property | Defined By | |
---|---|---|
enabled : Boolean Writable. False if resizing is disabled. | Resizable | |
proxy : Ext.Element. The proxy Element that is resized in place of the real Element during the resize operation.
This may be queried using... The proxy Element that is resized in place of the real Element during the resize operation.
This may be queried using Ext.Element.getBox to provide the new area to resize to.
Read only. | Resizable |
Method | Defined By | |
---|---|---|
Resizable( Mixed el , Object config )
Create a new resizable component Create a new resizable component Parameters:
| Resizable | |
addEvents( Object|String o , string Optional. )
:
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
destroy( [Boolean removeEl ] )
:
voidDestroys this resizable. If the element was wrapped and
removeEl is not true then the element remains. Destroys this resizable. If the element was wrapped and
removeEl is not true then the element remains. Parameters:
| Resizable | |
enableBubble( String/Array events )
:
voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example:
Parameters:
| Observable | |
fireEvent( String eventName , Object... args )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | |
getEl()
:
Ext.Element Returns the element this component is bound to. Returns the element this component is bound to. Parameters:
| Resizable | |
getResizeChild()
:
Ext.Element Returns the resizeChild element (or null). Returns the resizeChild element (or null). Parameters:
| Resizable | |
hasListener( String eventName )
:
BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
purgeListeners()
:
void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
:
voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
resizeElement()
:
void Performs resizing of the associated Element. This method is called internally by this
class, and should not be called... Performs resizing of the associated Element. This method is called internally by this class, and should not be called by user code. If a Resizable is being used to resize an Element which encapsulates a more complex UI component such as a Panel, this method may be overridden by specifying an implementation as a config option to provide appropriate behaviour at the end of the resize operation on mouseup, for example resizing the Panel, and relaying the Panel's content. The new area to be resized to is available by examining the state of the proxy Element. Example:
Parameters:
| Resizable | |
resizeTo( Number width , Number height )
:
voidPerform a manual resize and fires the 'resize' event. Perform a manual resize and fires the 'resize' event. Parameters:
| Resizable | |
resumeEvents()
:
void Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
beforeresize :
( Ext.Resizable this , Ext.EventObject e )
Fired before resize is allowed. Set enabled to false to cancel resize. Fired before resize is allowed. Set enabled to false to cancel resize. Listeners will be called with the following arguments:
| Resizable | |
resize :
( Ext.Resizable this , Number width , Number height , Ext.EventObject e )
Fired after a resize. Fired after a resize. Listeners will be called with the following arguments:
| Resizable |