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

## Sencha Documentation

# Ext.grid.plugin.DragDrop

####

    HierarchyExt.AbstractPluginExt.grid.plugin.DragDrop

This plugin provides drag and/or drop functionality for a GridView.

It creates a specialized instance of DragZone which knows how to drag out of a GridView and loads the data object which is passed to a cooperating DragZone's methods with the following properties:

- copy : Boolean
  The value of the GridView's `copy` property, or `true` if the GridView was configured with `allowCopy: true` and the control key was pressed when the drag operation was begun.
- view : GridView
  The source GridView from which the drag originated.
- ddel : HtmlElement
  The drag proxy element which moves with the mouse
- item : HtmlElement
  The GridView node upon which the mousedown event was registered.
- records : Array
  An Array of Models representing the selected data being dragged from the source GridView.

It also creates a specialized instance of Ext.dd.DropZone which cooperates with other DropZones which are members of the same ddGroup which processes such data objects.

Adding this plugin to a view means that two new events may be fired from the client GridView, `beforedrop` and `drop`

Defined By

### Config Options

#### Other Configs

Ext.grid.plugin.DragDrop
view source
ddGroup : String
A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone ...

A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone used by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').

Ext.grid.plugin.DragDrop
view source
dragGroup : String
The ddGroup to which the DragZone will belong. This defines which other DropZones the DragZone will interact with. ...

The ddGroup to which the DragZone will belong.

This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones which are members of the same ddGroup.

Ext.grid.plugin.DragDrop
view source
dropGroup : String
The ddGroup to which the DropZone will belong. This defines which other DragZones the DropZone will interact with. ...

The ddGroup to which the DropZone will belong.

This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones which are members of the same ddGroup.

Ext.grid.plugin.DragDrop
view source
enableDrag : Boolean

Defaults to `true`

Set to `false` to disallow dragging items from the View

Defaults to `true`

Set to `false` to disallow dragging items from the View

Ext.grid.plugin.DragDrop
view source
enableDrop : Boolean

Defaults to `true`

Set to `false` to disallow the View from accepting drop gestures

Defaults to `true`

Set to `false` to disallow the View from accepting drop gestures

Defined By

### Properties

Ext.AbstractPlugin
view source
destroy : Object
The destroy method is invoked by the owning Component at the time the Component is being destroyed. Use this method t...

The destroy method is invoked by the owning Component at the time the Component is being destroyed. Use this method to clean up an resources.

Ext.AbstractPlugin
view source
init : Object

The init method is invoked after initComponent has been run for the component which we are injecting the plugin into.

The init method is invoked after initComponent has been run for the component which we are injecting the plugin into.

Defined By

### Methods

Ext.AbstractPlugin
view source
disable : void

Disable the plugin and set the disabled flag to true.

Disable the plugin and set the disabled flag to true.

### Returns

- void

Ext.AbstractPlugin
view source
enable : void

Enable the plugin and set the disabled flag to false.

Enable the plugin and set the disabled flag to false.

### Returns

- void

Defined By

### Events

Ext.grid.plugin.DragDrop
view source
beforedrop( HtmlElement node, Object data, Ext.data.Model overModel, String dropPosition, Function dropFunction)
This event is fired through the GridView. Add listeners to the GridView object Fired when a drop gesture has been t...

This event is fired through the GridView. Add listeners to the GridView object

Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.

### Parameters

- node : HtmlElement

  The GridView node if any over which the mouse was positioned.

  Returning `false` to this event signals that the drop gesture was invalid, and if the drag proxy will animate back to the point from which the drag began.

  Returning `0` To this event signals that the data transfer operation should not take place, but that the gesture was valid, and that the repair operation should not take place.

  Any other return value continues with the data transfer operation.

- data : Object

  The data object gathered at mousedown time by the cooperating DragZone's getDragData method it contains the following properties:

  - copy : Boolean
    The value of the GridView's `copy` property, or `true` if the GridView was configured with `allowCopy: true` and the control key was pressed when the drag operation was begun
  - view : GridView
    The source GridView from which the drag originated.
  - ddel : HtmlElement
    The drag proxy element which moves with the mouse
  - item : HtmlElement
    The GridView node upon which the mousedown event was registered.
  - records : Array
    An Array of Models representing the selected data being dragged from the source GridView.
- overModel : Ext.data.Model

  The Model over which the drop gesture took place.

- dropPosition : String

  `"before"` or `"after"` depending on whether the mouse is above or below the midline of the node.

- dropFunction : Function

  A function to call to complete the data transfer operation and either move or copy Model instances from the source View's Store to the destination View's Store.

  This is useful when you want to perform some kind of asynchronous processing before confirming the drop, such as an confirm call, or an Ajax request.

  Return `0` from this event handler, and call the `dropFunction` at any time to perform the data transfer.

Ext.grid.plugin.DragDrop
view source
drop( HtmlElement node, Object data, Ext.data.Model overModel, String dropPosition)
This event is fired through the GridView. Add listeners to the GridView object Fired when a drop operation has been c...

This event is fired through the GridView. Add listeners to the GridView object Fired when a drop operation has been completed and the data has been moved or copied.

### Parameters

- node : HtmlElement

  The GridView node if any over which the mouse was positioned.

- data : Object

  The data object gathered at mousedown time by the cooperating DragZone's getDragData method it contains the following properties:

  - copy : Boolean
    The value of the GridView's `copy` property, or `true` if the GridView was configured with `allowCopy: true` and the control key was pressed when the drag operation was begun
  - view : GridView
    The source GridView from which the drag originated.
  - ddel : HtmlElement
    The drag proxy element which moves with the mouse
  - item : HtmlElement
    The GridView node upon which the mousedown event was registered.
  - records : Array
    An Array of Models representing the selected data being dragged from the source GridView.
- overModel : Ext.data.Model

  The Model over which the drop gesture took place.

- dropPosition : String

  `"before"` or `"after"` depending on whether the mouse is above or below the midline of the node.