Clear Up
SharpKit Reference

DragZone Class

This class provides a container DD instance that allows dragging of multiple child source nodes.

This class does not move the drag target nodes, but a proxy element which may contain any DOM structure you wish. The DOM element to show in the proxy is provided by either a provided implementation of getDragData, or by registered draggables registered with Ext.dd.Registry

If you wish to provide draggability for an arbitrary number of DOM nodes, each of which represent some application object (For example nodes in a DataView) then use of this class is the most efficient way to "activate" those nodes.

By default, this class requires that draggable child nodes are registered with Ext.dd.Registry. However a simpler way to allow a DragZone to manage any number of draggable elements is to configure the DragZone with an implementation of the getDragData method which interrogates the passed mouse event to see if it has taken place within an element, or class of elements. This is easily done by using the event's getTarget method to identify a node based on a Ext.DomQuery selector. For example, to make the nodes of a DataView draggable, use the following technique. Knowledge of the use of the DataView is required:

  
myDataView.on('render', function(v) {
            myDataView.dragZone = new Ext.dd.DragZone(v.getEl(), {
            //      On receipt of a mousedown event, see if it is within a DataView node.
            //      Return a drag data object if so.
            getDragData: function(e) {
            //          Use the DataView's own itemSelector (a mandatory property) to
            //          test if the mousedown is within one of the DataView's nodes.
            var sourceEl = e.getTarget(v.itemSelector, 10);
            //          If the mousedown is within a DataView node, clone the node to produce
            //          a ddel element for use by the drag proxy. Also add application data
            //          to the returned data object.
            if (sourceEl) {
            d = sourceEl.cloneNode(true);
            d.id = Ext.id();
            return {
            ddel: d,
            sourceEl: sourceEl,
            repairXY: Ext.fly(sourceEl).getXY(),
            sourceStore: v.store,
            draggedRecord: v.getRecord(sourceEl)
            }
            }
            },
            //      Provide coordinates for the proxy to slide back to on failed drag.
            //      This is the original XY coordinates of the draggable element captured
            //      in the getDragData method.
            getRepairXY: function() {
            return this.dragData.repairXY;
            }
            });
            });
            

See the DropZone documentation for details about building a DropZone which cooperates with this DragZone.

Namespace: Ext.dd

Methods

Name Description
afterRepair() Called after a repair of an invalid drop. By default, highlights this.dragData.ddel

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

getRepairXY(object) Called before a repair of an invalid drop to get the XY to animate to. By default returns the XY of this.dragData.ddel

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

onInitDrag(JsNumber, JsNumber) Called once drag threshold has been reached to initialize the proxy element. By default, it clones the this.dragData.ddel

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Fields

Name Description
containerScroll True to register this container with the Scrollmanager for auto scrolling during drag operations.

Properties

Name Description
dragData This property contains the data representing the dragged object. This data is set up by the implementation of the getDragData method. It must contain a ddel property, but can contain any other data according to the application's needs.
© Copyright 2005-2011 SharpKit. All rights reserved.