Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / src / dd / DropTarget.js

diff --git a/src/dd/DropTarget.js b/src/dd/DropTarget.js
new file mode 100644 (file)
index 0000000..23de865
--- /dev/null
+++ b/src/dd/DropTarget.js
@@ -0,0 +1,115 @@
+/*!
+ * 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.DropTarget\r
+ * @extends Ext.dd.DDTarget\r
+ * A simple class that provides the basic implementation needed to make any element a drop target that can have\r
+ * draggable items dropped onto it.  The drop has no effect until an implementation of notifyDrop is provided.\r
+ * @constructor\r
+ * @param {Mixed} el The container element\r
+ * @param {Object} config\r
+ */\r
+Ext.dd.DropTarget = function(el, config){\r
+    this.el = Ext.get(el);\r
+    \r
+    Ext.apply(this, config);\r
+    \r
+    if(this.containerScroll){\r
+        Ext.dd.ScrollManager.register(this.el);\r
+    }\r
+    \r
+    Ext.dd.DropTarget.superclass.constructor.call(this, this.el.dom, this.ddGroup || this.group, \r
+          {isTarget: true});\r
+\r
+};\r
+\r
+Ext.extend(Ext.dd.DropTarget, Ext.dd.DDTarget, {\r
+    /**\r
+     * @cfg {String} ddGroup\r
+     * A named drag drop group to which this object belongs.  If a group is specified, then this object will only\r
+     * interact with other drag drop objects in the same group (defaults to undefined).\r
+     */\r
+    /**\r
+     * @cfg {String} overClass\r
+     * The CSS class applied to the drop target element while the drag source is over it (defaults to "").\r
+     */\r
+    /**\r
+     * @cfg {String} dropAllowed\r
+     * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").\r
+     */\r
+    dropAllowed : "x-dd-drop-ok",\r
+    /**\r
+     * @cfg {String} dropNotAllowed\r
+     * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").\r
+     */\r
+    dropNotAllowed : "x-dd-drop-nodrop",\r
+\r
+    // private\r
+    isTarget : true,\r
+\r
+    // private\r
+    isNotifyTarget : true,\r
+\r
+    /**\r
+     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the source is now over the\r
+     * target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element\r
+     * and returns the dropAllowed config value.  This method should be overridden if drop validation is required.\r
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
+     * @param {Event} e The event\r
+     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
+     * @return {String} status The CSS class that communicates the drop status back to the source so that the\r
+     * underlying {@link Ext.dd.StatusProxy} can be updated\r
+     */\r
+    notifyEnter : function(dd, e, data){\r
+        if(this.overClass){\r
+            this.el.addClass(this.overClass);\r
+        }\r
+        return this.dropAllowed;\r
+    },\r
+\r
+    /**\r
+     * The function a {@link Ext.dd.DragSource} calls continuously while it is being dragged over the target.\r
+     * This method will be called on every mouse movement while the drag source is over the drop target.\r
+     * This default implementation simply returns the dropAllowed config value.\r
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
+     * @param {Event} e The event\r
+     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
+     * @return {String} status The CSS class that communicates the drop status back to the source so that the\r
+     * underlying {@link Ext.dd.StatusProxy} can be updated\r
+     */\r
+    notifyOver : function(dd, e, data){\r
+        return this.dropAllowed;\r
+    },\r
+\r
+    /**\r
+     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the source has been dragged\r
+     * out of the target without dropping.  This default implementation simply removes the CSS class specified by\r
+     * overClass (if any) from the drop element.\r
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
+     * @param {Event} e The event\r
+     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
+     */\r
+    notifyOut : function(dd, e, data){\r
+        if(this.overClass){\r
+            this.el.removeClass(this.overClass);\r
+        }\r
+    },\r
+\r
+    /**\r
+     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the dragged item has\r
+     * been dropped on it.  This method has no default implementation and returns false, so you must provide an\r
+     * implementation that does something to process the drop event and returns true so that the drag source's\r
+     * repair action does not run.\r
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
+     * @param {Event} e The event\r
+     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
+     * @return {Boolean} True if the drop was valid, else false\r
+     */\r
+    notifyDrop : function(dd, e, data){\r
+        return false;\r
+    }\r
+});
\ No newline at end of file