For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

Sencha Documentation

Hierarchy

Ext.dd.DragDrop
Ext.dd.DDTarget

A DragDrop implementation that does not move, but can be a drop target. You would get the same result by simply omitting implementation for the event callbacks, but this way we reduce the processing cost of the event listener and the callbacks.

Defined By

Properties

 

The available property is false until the linked dom element is accessible.

The available property is false until the linked dom element is accessible.

 

Configuration attributes passed into the constructor

Configuration attributes passed into the constructor

 

Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).

Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).

 
The group defines a logical collection of DragDrop objects that are related. Instances only get events when interact...

The group defines a logical collection of DragDrop objects that are related. Instances only get events when interacting with other DragDrop object in the same group. This lets us define multiple groups using a single DragDrop subclass if we want. An object in the format {'group1':true, 'group2':true}

 
By default, drags can only be initiated if the mousedown occurs in the region the linked element is. This is done in...

By default, drags can only be initiated if the mousedown occurs in the region the linked element is. This is done in part to work around a bug in some browsers that mis-report the mousedown if the previous mouseup happened outside of the window. This property is set to true if outer handles are defined. @default false

 
The id of the element associated with this object. This is what we refer to as the "linked element" because the size...

The id of the element associated with this object. This is what we refer to as the "linked element" because the size and position of this element is used to determine when the drag and drop objects have interacted.

 
Set to false to enable a DragDrop object to fire drag events while dragging over its own Element. Defaults to true - ...

Set to false to enable a DragDrop object to fire drag events while dragging over its own Element. Defaults to true - DragDrop objects do not by default fire drag events to themselves.

 

An Array of CSS class names for elements to be considered in valid as drag handles.

An Array of CSS class names for elements to be considered in valid as drag handles.

 
An object who's property names identify the IDs of elements to be considered invalid as drag handles. A non-null prop...

An object who's property names identify the IDs of elements to be considered invalid as drag handles. A non-null property value identifies the ID as invalid. For example, to prevent dragging from being initiated on element ID "foo", use:

{
    foo: true
}
 
An object who's property names identify HTML tags to be considered invalid as drag handles. A non-null property value...

An object who's property names identify HTML tags to be considered invalid as drag handles. A non-null property value identifies the tag as invalid. Defaults to the following value which prevents drag operations from being initiated by <a> elements:

{
    A: "A"
}
 

By default, all instances can be a drop target. This can be disabled by setting isTarget to false.

By default, all instances can be a drop target. This can be disabled by setting isTarget to false.

 
Maintain offsets when we resetconstraints. Set to true when you want the position of the element relative to its par...

Maintain offsets when we resetconstraints. Set to true when you want the position of the element relative to its parent to stay the same when the page changes

 
When set to true, other DD objects in cooperating DDGroups do not receive notification events when this DD object is ...

When set to true, other DD objects in cooperating DDGroups do not receive notification events when this DD object is dragged over them. Defaults to false.

 
The padding configured for this drag and drop object for calculating the drop zone intersection with this object. An ...

The padding configured for this drag and drop object for calculating the drop zone intersection with this object. An array containing the 4 padding values: [top, right, bottom, left]

 
By default the drag and drop instance will only respond to the primary button click (left button for a right-handed m...

By default the drag and drop instance will only respond to the primary button click (left button for a right-handed mouse). Set to true to allow drag and drop to start with any mouse click that is propogated by the browser

 
Array of pixel locations the element will snap to if we specified a horizontal graduation/interval. This array is ge...

Array of pixel locations the element will snap to if we specified a horizontal graduation/interval. This array is generated automatically when you define a tick interval.

 
Array of pixel locations the element will snap to if we specified a vertical graduation/interval. This array is gene...

Array of pixel locations the element will snap to if we specified a vertical graduation/interval. This array is generated automatically when you define a tick interval.

Defined By

Methods

 
DDTarget( String id, String sGroup, object config) : void

 

Parameters

  • id : String

    the id of the element that is a drop target

  • sGroup : String

    the group of related DragDrop objects

  • config : object

    an object containing configurable attributes

                Valid properties for DDTarget in addition to those in
                DragDrop:
                   none
    

Returns

  • void   
 

Lets you specify a css class of elements that will not initiate a drag

Lets you specify a css class of elements that will not initiate a drag

Parameters

  • cssClass : string

    the class of the elements you wish to ignore

Returns

  • void   
 

Lets you to specify an element id for a child of a drag handle that should not initiate a drag

Lets you to specify an element id for a child of a drag handle that should not initiate a drag

Parameters

  • id : string

    the element id of the element you wish to ignore

Returns

  • void   
 
Allows you to specify a tag name that should not start a drag operation when clicked. This is designed to facilitate...

Allows you to specify a tag name that should not start a drag operation when clicked. This is designed to facilitate embedding links within a drag handle that do something other than start the drag.

Parameters

  • tagName : string

    the type of element to exclude

Returns

  • void   
 
Add this instance to a group of related drag/drop objects. All instances belong to at least one group, and can belon...

Add this instance to a group of related drag/drop objects. All instances belong to at least one group, and can belong to as many groups as needed.

Parameters

  • sGroup : Object

    {string} the name of the group

Returns

  • void   
 
Applies the configuration parameters that were passed into the constructor. This is supposed to happen at each level ...

Applies the configuration parameters that were passed into the constructor. This is supposed to happen at each level through the inheritance chain. So a DDProxy implentation will execute apply config on DDProxy, DD, and DragDrop in order to get all of the parameters that are available in each object.

Returns

  • void   
 
Clears any constraints applied to this instance. Also clears ticks since they can't exist independent of a constrain...

Clears any constraints applied to this instance. Also clears ticks since they can't exist independent of a constraint at this time.

Returns

  • void   
 

Clears any tick interval defined for this instance

Clears any tick interval defined for this instance

Returns

  • void   
 
constrainTo( Mixed constrainTo, [Object/Number pad], [Boolean inContent]) : void
Initializes the drag drop object's constraints to restrict movement to a certain element. Usage: var dd = new Ext....

Initializes the drag drop object's constraints to restrict movement to a certain element.

Usage:

 var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
                { dragElId: "existingProxyDiv" });
 dd.startDrag = function(){
     this.constrainTo("parent-id");
 };
 

Or you can initalize it using the Ext.core.Element object:

 Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
     startDrag : function(){
         this.constrainTo("parent-id");
     }
 });
 

Parameters

  • constrainTo : Mixed

    The element to constrain to.

  • pad : Object/Number

    (optional) Pad provides a way to specify "padding" of the constraints, and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or an object containing the sides to pad. For example: {right:10, bottom:10}

  • inContent : Boolean

    (optional) Constrain the draggable in the content box of the element (inside padding and borders)

Returns

  • void   
 

Fired when we are done dragging the object

Fired when we are done dragging the object

Parameters

  • e : Event

    the mouseup event

Returns

  • void   
 
Returns a reference to the actual element to drag. By default this is the same as the html element, but it can be as...

Returns a reference to the actual element to drag. By default this is the same as the html element, but it can be assigned to another element. An example of this can be found in Ext.dd.DDProxy

Returns

  • HTMLElement   

    the html element

 

Returns a reference to the linked element

Returns a reference to the linked element

Returns

  • HTMLElement   

    the html element

 
init( Object id, String sGroup, object config) : void

Sets up the DragDrop object. Must be called in the constructor of any Ext.dd.DragDrop subclass

Sets up the DragDrop object. Must be called in the constructor of any Ext.dd.DragDrop subclass

Parameters

  • id : Object

    the id of the linked element

  • sGroup : String

    the group of related items

  • config : object

    configuration attributes

Returns

  • void   
 
initTarget( Object id, String sGroup, object config) : void

Initializes Targeting functionality only... the object does not get a mousedown handler.

Initializes Targeting functionality only... the object does not get a mousedown handler.

Parameters

  • id : Object

    the id of the linked element

  • sGroup : String

    the group of related items

  • config : object

    configuration attributes

Returns

  • void   
 
Returns true if this instance is locked, or the drag drop mgr is locked (meaning that all drag/drop is disabled on th...

Returns true if this instance is locked, or the drag drop mgr is locked (meaning that all drag/drop is disabled on the page.)

Returns

  • boolean   

    true if this obj or all drag/drop is locked, else false

 

Checks the tag exclusion list to see if this click should be ignored

Checks the tag exclusion list to see if this click should be ignored

Parameters

  • node : HTMLElement

    the HTMLElement to evaluate

Returns

  • boolean   

    true if this is a valid tag type, false if not

 

Lock this instance

Lock this instance

Returns

  • void   
 

Override the onAvailable method to do what is needed after the initial position was determined.

Override the onAvailable method to do what is needed after the initial position was determined.

Returns

  • void   
 

Abstract method called during the onMouseMove event while dragging an object.

Abstract method called during the onMouseMove event while dragging an object.

Parameters

  • e : Event

    the mousemove event

Returns

  • void   
 
onDragDrop( Event e, String|DragDrop[] id) : void

Abstract method called when this item is dropped on another DragDrop obj

Abstract method called when this item is dropped on another DragDrop obj

Parameters

  • e : Event

    the mouseup event

  • id : String|DragDrop[]

    In POINT mode, the element id this was dropped on. In INTERSECT mode, an array of dd items this was dropped on.

Returns

  • void   
 
onDragEnter( Event e, String|DragDrop[] id) : void

Abstract method called when this element fist begins hovering over another DragDrop obj

Abstract method called when this element fist begins hovering over another DragDrop obj

Parameters

  • e : Event

    the mousemove event

  • id : String|DragDrop[]

    In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of one or more dragdrop items being hovered over.

Returns

  • void   
 
onDragOut( Event e, String|DragDrop[] id) : void

Abstract method called when we are no longer hovering over an element

Abstract method called when we are no longer hovering over an element

Parameters

  • e : Event

    the mousemove event

  • id : String|DragDrop[]

    In POINT mode, the element id this was hovering over. In INTERSECT mode, an array of dd items that the mouse is no longer over.

Returns

  • void   
 
onDragOver( Event e, String|DragDrop[] id) : void

Abstract method called when this element is hovering over another DragDrop obj

Abstract method called when this element is hovering over another DragDrop obj

Parameters

  • e : Event

    the mousemove event

  • id : String|DragDrop[]

    In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of dd items being hovered over.

Returns

  • void   
 

Abstract method called when this item is dropped on an area with no drop target

Abstract method called when this item is dropped on an area with no drop target

Parameters

  • e : Event

    the mouseup event

Returns

  • void   
 

Event handler that fires when a drag/drop obj gets a mousedown

Event handler that fires when a drag/drop obj gets a mousedown

Parameters

  • e : Event

    the mousedown event

Returns

  • void   
 

Event handler that fires when a drag/drop obj gets a mouseup

Event handler that fires when a drag/drop obj gets a mouseup

Parameters

  • e : Event

    the mouseup event

Returns

  • void   
 

Remove's this instance from the supplied interaction group

Remove's this instance from the supplied interaction group

Parameters

  • sGroup : string

    The group to drop

Returns

  • void   
 

Unsets an invalid css class

Unsets an invalid css class

Parameters

  • cssClass : string

    the class of the element(s) you wish to re-enable

Returns

  • void   
 

Unsets an invalid handle id

Unsets an invalid handle id

Parameters

  • id : string

    the id of the element to re-enable

Returns

  • void   
 

Unsets an excluded tag name set by addInvalidHandleType

Unsets an excluded tag name set by addInvalidHandleType

Parameters

  • tagName : string

    the type of element to unexclude

Returns

  • void   
 
resetConstraints( boolean maintainOffset) : void

resetConstraints must be called if you manually reposition a dd element.

resetConstraints must be called if you manually reposition a dd element.

Parameters

  • maintainOffset : boolean

Returns

  • void   
 

Allows you to specify that an element other than the linked element will be moved with the cursor during a drag

Allows you to specify that an element other than the linked element will be moved with the cursor during a drag

Parameters

  • id : Object

    {string} the id of the element that will be used to initiate the drag

Returns

  • void   
 
Allows you to specify a child of the linked element that should be used to initiate the drag operation. An example o...

Allows you to specify a child of the linked element that should be used to initiate the drag operation. An example of this would be if you have a content div with text and links. Clicking anywhere in the content area would normally start the drag operation. Use this method to specify that an element inside of the content div is the element that starts the drag operation.

Parameters

  • id : Object

    {string} the id of the element that will be used to initiate the drag.

Returns

  • void   
 
setInitPosition( int diffX, int diffY) : void

Stores the initial placement of the linked element.

Stores the initial placement of the linked element.

Parameters

  • diffX : int

    the X offset, default 0

  • diffY : int

    the Y offset, default 0

Returns

  • void   
 

Allows you to set an element outside of the linked element as a drag handle

Allows you to set an element outside of the linked element as a drag handle

Parameters

  • id : Object

    the id of the element that will be used to initiate the drag

Returns

  • void   
 
setPadding( int iTop, int iRight, int iBot, int iLeft) : void
Configures the padding for the target zone in px. Effectively expands (or reduces) the virtual object size for targe...

Configures the padding for the target zone in px. Effectively expands (or reduces) the virtual object size for targeting calculations. Supports css-style shorthand; if only one parameter is passed, all sides will have that padding, and if only two are passed, the top and bottom will have the first param, the left and right the second.

Parameters

  • iTop : int

    Top pad

  • iRight : int

    Right pad

  • iBot : int

    Bot pad

  • iLeft : int

    Left pad

Returns

  • void   
 
setXConstraint( int iLeft, int iRight, int iTickSize) : void
By default, the element can be dragged any place on the screen. Use this method to limit the horizontal travel of th...

By default, the element can be dragged any place on the screen. Use this method to limit the horizontal travel of the element. Pass in 0,0 for the parameters if you want to lock the drag to the y axis.

Parameters

  • iLeft : int

    the number of pixels the element can move to the left

  • iRight : int

    the number of pixels the element can move to the right

  • iTickSize : int

    optional parameter for specifying that the element should move iTickSize pixels at a time.

Returns

  • void   
 
setYConstraint( int iUp, int iDown, int iTickSize) : void
By default, the element can be dragged any place on the screen. Set this to limit the vertical travel of the element...

By default, the element can be dragged any place on the screen. Set this to limit the vertical travel of the element. Pass in 0,0 for the parameters if you want to lock the drag to the x axis.

Parameters

  • iUp : int

    the number of pixels the element can move up

  • iDown : int

    the number of pixels the element can move down

  • iTickSize : int

    optional parameter for specifying that the element should move iTickSize pixels at a time.

Returns

  • void   
 

Abstract method called after a drag/drop object is clicked and the drag or mousedown time thresholds have beeen met.

Abstract method called after a drag/drop object is clicked and the drag or mousedown time thresholds have beeen met.

Parameters

  • X : int

    click location

  • Y : int

    click location

Returns

  • void   
 

toString method

toString method

Returns

  • string   

    string representation of the dd obj

 

Unlock this instace

Unlock this instace

Returns

  • void   
 

Remove all drag and drop hooks for this element

Remove all drag and drop hooks for this element

Returns

  • void