Properties

Methods

Events

Config Options

Direct Link

Observable
  Draggable

Class Ext.util.Draggable

Package:	Ext.util
Defined In:	Draggable.js
Class:	Draggable
Subclasses:	Scroller
Extends:	Observable

A core util class to bring Draggable behavior to any DOM element, acts as a base class for Scroller and Sortable

Config Options

Config Options		Defined By
	cancelSelector : String A simple CSS selector that represents elements within the draggable that should NOT initiate a drag.	Draggable
	constrain : Element/Mixed Can be either a DOM element, an instance of Ext.Element, 'parent' or null for no constrain	Draggable
	delay : Number How many milliseconds a user must hold the draggable before starting a drag operation. Defaults to 0 or immediate.	Draggable
	direction : String Possible values: 'vertical', 'horizontal', or 'both' Defaults to 'both'	Draggable
	disabled : Boolean Whether or not the draggable behavior is disabled on instantiation Defaults to false	Draggable
	eventTarget : Ext.Element/Element/String The element to actually bind touch events to, the only string accepted is 'parent' for convenience. Defaults to this ... The element to actually bind touch events to, the only string accepted is 'parent' for convenience. Defaults to this class' element itself	Draggable
	group : String Draggable and Droppable objects can participate in a group which are capable of interacting. Defaults to 'base'	Draggable
	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 `click` event passing the node clicked on. To access DOM events directly from a a child element of a Component, we need to specify this explicitly: `new Ext.Panel({ width: 400, height: 200, dockedItems: [{ xtype: 'toolbar' }], listeners: { click: { element: 'el', //bind to the underlying el property on the panel fn: function(){ console.log('click el'); } }, dblclick: { element: 'body', //bind to the underlying body property on the panel fn: function(){ console.log('dblclick body'); } } } });`	Observable
	revert : Boolean Whether or not the element or it's proxy will be reverted back (with animation) when it's not dropped and held by a D... Whether or not the element or it's proxy will be reverted back (with animation) when it's not dropped and held by a Droppable	Draggable
	useCssTransform : Boolean Whether or not to translate the element using CSS Transform (much faster) instead of left and top properties, default... Whether or not to translate the element using CSS Transform (much faster) instead of left and top properties, defaults to true	Draggable

Public Properties

Property		Defined By
	animationDuration : Number How long animations for this draggable take by default when using setOffset with animate being true. This defaults to... How long animations for this draggable take by default when using setOffset with animate being true. This defaults to 300.	Draggable
	dragging : Boolean Read-only Property representing whether or not the Draggable is currently dragging or not.	Draggable
	horizontal : Boolean Read-only value representing whether the Draggable can be moved horizontally. This is automatically calculated by Dra... Read-only value representing whether the Draggable can be moved horizontally. This is automatically calculated by Draggable by the direction configuration.	Draggable
	offsetBoundary : Ext.util.Region Read-only Property representing the region that the Draggable is constrained to.	Draggable
	threshold : Number The amount of pixels you have to move before the drag operation starts. Defaults to 0	Draggable
	vertical : Boolean Read-only value representing whether the Draggable can be moved vertically. This is automatically calculated by Dragg... Read-only value representing whether the Draggable can be moved vertically. This is automatically calculated by Draggable by the direction configuration.	Draggable

Public Methods

Method		Defined By
	Draggable( `Mixed el`, `Object config` ) Parameters: `el` : Mixed The element you want to make draggable. `config` : Object The configuration object for this Draggable. Returns: void	Draggable
	addEvents( `Object\|String o`, `string Optional.` ) : void Adds 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: `o` : Object\|String Either an object with event names as properties with a value of `true` or the first event name string if multiple event names are being passed as separate parameters. `Optional.` : string Event name if multiple event names are being passed as separate parameters. Usage: `this.addEvents('storeloaded', 'storecleared');` Returns: void	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object. Appends an event handler to this object. Parameters: `eventName` : String The name of the event to listen for. `handler` : Function The method the event invokes. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. properties. This may contain any of the following properties: scope : Object The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer : Number Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. target : Observable Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable. element : String The element reference on the component to bind the event to. This is used to bind DOM events to underlying elements on Components. - This option is only valid for listeners bound to Components Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. `myPanel.on('hide', this.onClick, this, { single: true, delay: 100 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. Returns: void	Observable
	addManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope`, `Object opt` ) : void Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed... Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. Parameters: `item` : Observable\|Element The item to which to add a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. `opt` : Object Optional. If the `ename` parameter was an event name, this is the addListener options. Returns: void	Observable
	clearListeners() : void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters: None. Returns: void	Observable
	clearManagedListeners() : void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters: None. Returns: void	Observable
	destroy() : void Destroys this Draggable instance. Destroys this Draggable instance. Parameters: None. Returns: void	Draggable
	disable() : Ext.util.Draggable Disable the Draggable. Disable the Draggable. Parameters: None. Returns: `Ext.util.Draggable` this This Draggable instance	Draggable
	enable() : Ext.util.Draggable Enable the Draggable. Enable the Draggable. Parameters: None. Returns: `Ext.util.Draggable` this This Draggable instance	Draggable
	enableBubble( `String/Array events` ) : void Enables 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.getBubbleTarget()` if present. There is no implementation in the Observable base class. 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: Ext.override(Ext.form.Field, { // Add functionality to Field's initComponent to enable the change event to bubble initComponent : Ext.createSequence(Ext.form.Field.prototype.initComponent, function() { this.enableBubble('change'); }), // We know that we want Field's events to bubble directly to the FormPanel. getBubbleTarget : function() { if (!this.formPanel) { this.formPanel = this.findParentByType('form'); } return this.formPanel; } }); var myForm = new Ext.formPanel({ title: 'User Details', items: [{ ... }], listeners: { change: function() { // Title goes red if form has been modified. myForm.header.setStyle('color', 'red'); } } }); Parameters: `events` : String/Array The event name to bubble, or an Array of event names. Returns: void	Observable
	fireEvent( `String eventName`, `Object... args` ) : Boolean Fires 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: `eventName` : String The name of the event to fire. `args` : Object... Variable number of parameters are passed to handlers. Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true.	Observable
	getOffset() : Ext.util.Offset Returns the current offset relative to the original location of this Draggable. Returns the current offset relative to the original location of this Draggable. Parameters: None. Returns: `Ext.util.Offset` offset An Ext.util.Offset instance containing the offset.	Draggable
	getProxyEl() : void Returns the element thats is being visually dragged. Returns the element thats is being visually dragged. Parameters: None. Returns: void	Draggable
	hasListener( `String eventName` ) : Boolean Checks 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: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false	Observable
	isDragging() : Boolean Method to determine whether this Draggable is currently dragging. Method to determine whether this Draggable is currently dragging. Parameters: None. Returns: `Boolean`	Draggable
	isHorizontal() : Boolean Method to determine whether this Draggable can be dragged on the x-axis Method to determine whether this Draggable can be dragged on the x-axis Parameters: None. Returns: `Boolean`	Draggable
	isVertical() : Boolean Method to determine whether this Draggable can be dragged on the y-axis Method to determine whether this Draggable can be dragged on the y-axis Parameters: None. Returns: `Boolean`	Draggable
	moveTo( `Number x`, `Number y` ) : Ext.util.Draggable Use this to move the draggable to a coordinate on the screen. Use this to move the draggable to a coordinate on the screen. Parameters: `x` : Number the vertical coordinate in pixels `y` : Number the horizontal coordinate in pixels Returns: `Ext.util.Draggable` this This Draggable instance	Draggable
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. Returns: void	Observable
	relayEvents( `Object o`, `Array events` ) : void Relays 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: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: void	Observable
	removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler. Removes an event handler. Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable
	removeManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope` ) : void Removes listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters: `item` : Observable\|Element The item from which to remove a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. Returns: void	Observable
	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: None. Returns: void	Observable
	setEnabled( `Boolean enabled` ) : Ext.util.Draggable Combined method to disable or enable the Draggable. This method is called by the enable and disable methods. Combined method to disable or enable the Draggable. This method is called by the enable and disable methods. Parameters: `enabled` : Boolean True to enable, false to disable. Defaults to false. Returns: `Ext.util.Draggable` this This Draggable instance	Draggable
	setOffset( `Ext.util.Offset/Object offset`, `Boolean/Number animate` ) : Ext.util.Draggable Sets the offset of this Draggable relatively to its original offset. Sets the offset of this Draggable relatively to its original offset. Parameters: `offset` : Ext.util.Offset/Object An object or Ext.util.Offset instance containing the x and y coordinates. `animate` : Boolean/Number Whether or not to animate the setting of the offset. True to use the default animationDuration, a number to specify the duration for this operation. Returns: `Ext.util.Draggable` this This Draggable instance	Draggable
	setUseCssTransform( `Boolean useCssTransform` ) : Ext.util.Draggable Change the Draggable to use css transforms instead of style offsets or the other way around. Change the Draggable to use css transforms instead of style offsets or the other way around. Parameters: `useCssTransform` : Boolean True to use css transforms instead of style offsets. Returns: `Ext.util.Draggable` this This Draggable instance	Draggable
	suspendEvents( `Boolean queueSuspended` ) : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: `queueSuspended` : Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events; Returns: void	Observable
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable

Public Events

Event		Defined By
	offsetchange : ( `Ext.Draggable this`, `Ext.util.Offset offset` ) Listeners will be called with the following arguments: `this` : Ext.Draggable `offset` : Ext.util.Offset	Draggable