src/dd/DragZone.js

   1 /*!
   2  * Ext JS Library 3.0.3
   3  * Copyright(c) 2006-2009 Ext JS, LLC
   4  * licensing@extjs.com
   5  * http://www.extjs.com/license
   6  */
   7 /**\r
   8  * @class Ext.dd.DragZone\r
   9  * @extends Ext.dd.DragSource\r
  10  * <p>This class provides a container DD instance that allows dragging of multiple child source nodes.</p>\r
  11  * <p>This class does not move the drag target nodes, but a proxy element which may contain\r
  12  * any DOM structure you wish. The DOM element to show in the proxy is provided by either a\r
  13  * provided implementation of {@link #getDragData}, or by registered draggables registered with {@link Ext.dd.Registry}</p>\r
  14  * <p>If you wish to provide draggability for an arbitrary number of DOM nodes, each of which represent some\r
  15  * application object (For example nodes in a {@link Ext.DataView DataView}) then use of this class\r
  16  * is the most efficient way to "activate" those nodes.</p>\r
  17  * <p>By default, this class requires that draggable child nodes are registered with {@link Ext.dd.Registry}.\r
  18  * However a simpler way to allow a DragZone to manage any number of draggable elements is to configure\r
  19  * the DragZone with  an implementation of the {@link #getDragData} method which interrogates the passed\r
  20  * mouse event to see if it has taken place within an element, or class of elements. This is easily done\r
  21  * by using the event's {@link Ext.EventObject#getTarget getTarget} method to identify a node based on a\r
  22  * {@link Ext.DomQuery} selector. For example, to make the nodes of a DataView draggable, use the following\r
  23  * technique. Knowledge of the use of the DataView is required:</p><pre><code>\r
  24 myDataView.on('render', function() {\r
  25     myDataView.dragZone = new Ext.dd.DragZone(myDataView.getEl(), {\r
  26 \r
  27 //      On receipt of a mousedown event, see if it is within a DataView node.\r
  28 //      Return a drag data object if so.\r
  29         getDragData: function(e) {\r
  30 \r
  31 //          Use the DataView's own itemSelector (a mandatory property) to\r
  32 //          test if the mousedown is within one of the DataView's nodes.\r
  33             var sourceEl = e.getTarget(myDataView.itemSelector, 10);\r
  34 \r
  35 //          If the mousedown is within a DataView node, clone the node to produce\r
  36 //          a ddel element for use by the drag proxy. Also add application data\r
  37 //          to the returned data object.\r
  38             if (sourceEl) {\r
  39                 d = sourceEl.cloneNode(true);\r
  40                 d.id = Ext.id();\r
  41                 return {\r
  42                     ddel: d,\r
  43                     sourceEl: sourceEl,\r
  44                     repairXY: Ext.fly(sourceEl).getXY(),\r
  45                     sourceStore: myDataView.store,\r
  46                     draggedRecord: v.getRecord(sourceEl)\r
  47                 }\r
  48             }\r
  49         },\r
  50 \r
  51 //      Provide coordinates for the proxy to slide back to on failed drag.\r
  52 //      This is the original XY coordinates of the draggable element captured\r
  53 //      in the getDragData method.\r
  54         getRepairXY: function() {\r
  55             return this.dragData.repairXY;\r
  56         }\r
  57     });\r
  58 });</code></pre>\r
  59  * See the {@link Ext.dd.DropZone DropZone} documentation for details about building a DropZone which\r
  60  * cooperates with this DragZone.\r
  61  * @constructor\r
  62  * @param {Mixed} el The container element\r
  63  * @param {Object} config\r
  64  */\r
  65 Ext.dd.DragZone = function(el, config){\r
  66     Ext.dd.DragZone.superclass.constructor.call(this, el, config);\r
  67     if(this.containerScroll){\r
  68         Ext.dd.ScrollManager.register(this.el);\r
  69     }\r
  70 };\r
  71 \r
  72 Ext.extend(Ext.dd.DragZone, Ext.dd.DragSource, {\r
  73     /**\r
  74      * This property contains the data representing the dragged object. This data is set up by the implementation\r
  75      * of the {@link #getDragData} method. It must contain a <tt>ddel</tt> property, but can contain\r
  76      * any other data according to the application's needs.\r
  77      * @type Object\r
  78      * @property dragData\r
  79      */\r
  80     /**\r
  81      * @cfg {Boolean} containerScroll True to register this container with the Scrollmanager\r
  82      * for auto scrolling during drag operations.\r
  83      */\r
  84     /**\r
  85      * @cfg {String} hlColor The color to use when visually highlighting the drag source in the afterRepair\r
  86      * method after a failed drop (defaults to "c3daf9" - light blue)\r
  87      */\r
  88 \r
  89     /**\r
  90      * Called when a mousedown occurs in this container. Looks in {@link Ext.dd.Registry}\r
  91      * for a valid target to drag based on the mouse down. Override this method\r
  92      * to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\r
  93      * object has a "ddel" attribute (with an HTML Element) for other functions to work.\r
  94      * @param {EventObject} e The mouse down event\r
  95      * @return {Object} The dragData\r
  96      */\r
  97     getDragData : function(e){\r
  98         return Ext.dd.Registry.getHandleFromEvent(e);\r
  99     },\r
 100     \r
 101     /**\r
 102      * Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\r
 103      * this.dragData.ddel\r
 104      * @param {Number} x The x position of the click on the dragged object\r
 105      * @param {Number} y The y position of the click on the dragged object\r
 106      * @return {Boolean} true to continue the drag, false to cancel\r
 107      */\r
 108     onInitDrag : function(x, y){\r
 109         this.proxy.update(this.dragData.ddel.cloneNode(true));\r
 110         this.onStartDrag(x, y);\r
 111         return true;\r
 112     },\r
 113     \r
 114     /**\r
 115      * Called after a repair of an invalid drop. By default, highlights this.dragData.ddel \r
 116      */\r
 117     afterRepair : function(){\r
 118         if(Ext.enableFx){\r
 119             Ext.Element.fly(this.dragData.ddel).highlight(this.hlColor || "c3daf9");\r
 120         }\r
 121         this.dragging = false;\r
 122     },\r
 123 \r
 124     /**\r
 125      * Called before a repair of an invalid drop to get the XY to animate to. By default returns\r
 126      * the XY of this.dragData.ddel\r
 127      * @param {EventObject} e The mouse up event\r
 128      * @return {Array} The xy location (e.g. [100, 200])\r
 129      */\r
 130     getRepairXY : function(e){\r
 131         return Ext.Element.fly(this.dragData.ddel).getXY();  \r
 132     }\r
 133 });