Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / src / dd / DragZone.js
diff --git a/src/dd/DragZone.js b/src/dd/DragZone.js
new file mode 100644 (file)
index 0000000..055d268
--- /dev/null
@@ -0,0 +1,133 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+/**\r
+ * @class Ext.dd.DragZone\r
+ * @extends Ext.dd.DragSource\r
+ * <p>This class provides a container DD instance that allows dragging of multiple child source nodes.</p>\r
+ * <p>This class does not move the drag target nodes, but a proxy element which may contain\r
+ * any DOM structure you wish. The DOM element to show in the proxy is provided by either a\r
+ * provided implementation of {@link #getDragData}, or by registered draggables registered with {@link Ext.dd.Registry}</p>\r
+ * <p>If you wish to provide draggability for an arbitrary number of DOM nodes, each of which represent some\r
+ * application object (For example nodes in a {@link Ext.DataView DataView}) then use of this class\r
+ * is the most efficient way to "activate" those nodes.</p>\r
+ * <p>By default, this class requires that draggable child nodes are registered with {@link Ext.dd.Registry}.\r
+ * However a simpler way to allow a DragZone to manage any number of draggable elements is to configure\r
+ * the DragZone with  an implementation of the {@link #getDragData} method which interrogates the passed\r
+ * mouse event to see if it has taken place within an element, or class of elements. This is easily done\r
+ * by using the event's {@link Ext.EventObject#getTarget getTarget} method to identify a node based on a\r
+ * {@link Ext.DomQuery} selector. For example, to make the nodes of a DataView draggable, use the following\r
+ * technique. Knowledge of the use of the DataView is required:</p><pre><code>\r
+myDataView.on('render', function() {\r
+    myDataView.dragZone = new Ext.dd.DragZone(myDataView.getEl(), {\r
+\r
+//      On receipt of a mousedown event, see if it is within a DataView node.\r
+//      Return a drag data object if so.\r
+        getDragData: function(e) {\r
+\r
+//          Use the DataView's own itemSelector (a mandatory property) to\r
+//          test if the mousedown is within one of the DataView's nodes.\r
+            var sourceEl = e.getTarget(myDataView.itemSelector, 10);\r
+\r
+//          If the mousedown is within a DataView node, clone the node to produce\r
+//          a ddel element for use by the drag proxy. Also add application data\r
+//          to the returned data object.\r
+            if (sourceEl) {\r
+                d = sourceEl.cloneNode(true);\r
+                d.id = Ext.id();\r
+                return {\r
+                    ddel: d,\r
+                    sourceEl: sourceEl,\r
+                    repairXY: Ext.fly(sourceEl).getXY(),\r
+                    sourceStore: myDataView.store,\r
+                    draggedRecord: v.getRecord(sourceEl)\r
+                }\r
+            }\r
+        },\r
+\r
+//      Provide coordinates for the proxy to slide back to on failed drag.\r
+//      This is the original XY coordinates of the draggable element captured\r
+//      in the getDragData method.\r
+        getRepairXY: function() {\r
+            return this.dragData.repairXY;\r
+        }\r
+    });\r
+});</code></pre>\r
+ * See the {@link Ext.dd.DropZone DropZone} documentation for details about building a DropZone which\r
+ * cooperates with this DragZone.\r
+ * @constructor\r
+ * @param {Mixed} el The container element\r
+ * @param {Object} config\r
+ */\r
+Ext.dd.DragZone = function(el, config){\r
+    Ext.dd.DragZone.superclass.constructor.call(this, el, config);\r
+    if(this.containerScroll){\r
+        Ext.dd.ScrollManager.register(this.el);\r
+    }\r
+};\r
+\r
+Ext.extend(Ext.dd.DragZone, Ext.dd.DragSource, {\r
+    /**\r
+     * This property contains the data representing the dragged object. This data is set up by the implementation\r
+     * of the {@link #getDragData} method. It must contain a <tt>ddel</tt> property, but can contain\r
+     * any other data according to the application's needs.\r
+     * @type Object\r
+     * @property dragData\r
+     */\r
+    /**\r
+     * @cfg {Boolean} containerScroll True to register this container with the Scrollmanager\r
+     * for auto scrolling during drag operations.\r
+     */\r
+    /**\r
+     * @cfg {String} hlColor The color to use when visually highlighting the drag source in the afterRepair\r
+     * method after a failed drop (defaults to "c3daf9" - light blue)\r
+     */\r
+\r
+    /**\r
+     * Called when a mousedown occurs in this container. Looks in {@link Ext.dd.Registry}\r
+     * for a valid target to drag based on the mouse down. Override this method\r
+     * to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\r
+     * object has a "ddel" attribute (with an HTML Element) for other functions to work.\r
+     * @param {EventObject} e The mouse down event\r
+     * @return {Object} The dragData\r
+     */\r
+    getDragData : function(e){\r
+        return Ext.dd.Registry.getHandleFromEvent(e);\r
+    },\r
+    \r
+    /**\r
+     * Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\r
+     * this.dragData.ddel\r
+     * @param {Number} x The x position of the click on the dragged object\r
+     * @param {Number} y The y position of the click on the dragged object\r
+     * @return {Boolean} true to continue the drag, false to cancel\r
+     */\r
+    onInitDrag : function(x, y){\r
+        this.proxy.update(this.dragData.ddel.cloneNode(true));\r
+        this.onStartDrag(x, y);\r
+        return true;\r
+    },\r
+    \r
+    /**\r
+     * Called after a repair of an invalid drop. By default, highlights this.dragData.ddel \r
+     */\r
+    afterRepair : function(){\r
+        if(Ext.enableFx){\r
+            Ext.Element.fly(this.dragData.ddel).highlight(this.hlColor || "c3daf9");\r
+        }\r
+        this.dragging = false;\r
+    },\r
+\r
+    /**\r
+     * Called before a repair of an invalid drop to get the XY to animate to. By default returns\r
+     * the XY of this.dragData.ddel\r
+     * @param {EventObject} e The mouse up event\r
+     * @return {Array} The xy location (e.g. [100, 200])\r
+     */\r
+    getRepairXY : function(e){\r
+        return Ext.Element.fly(this.dragData.ddel).getXY();  \r
+    }\r
+});
\ No newline at end of file