Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / DropTarget.html
index 79c594a..0705509 100644 (file)
-<html>\r
-<head>\r
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.dd.DropTarget"></div>/**\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
-    <div id="cfg-Ext.dd.DropTarget-ddGroup"></div>/**\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
-    <div id="cfg-Ext.dd.DropTarget-overClass"></div>/**\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
-    <div id="cfg-Ext.dd.DropTarget-dropAllowed"></div>/**\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
-    <div id="cfg-Ext.dd.DropTarget-dropNotAllowed"></div>/**\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
-    <div id="method-Ext.dd.DropTarget-notifyEnter"></div>/**\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
-    <div id="method-Ext.dd.DropTarget-notifyOver"></div>/**\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
-    <div id="method-Ext.dd.DropTarget-notifyOut"></div>/**\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
-    <div id="method-Ext.dd.DropTarget-notifyDrop"></div>/**\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
-});</pre>    \r
-</body>\r
-</html>
\ No newline at end of file
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-dd-DropTarget'>/**
+</span> * @class Ext.dd.DropTarget
+ * @extends Ext.dd.DDTarget
+ * A simple class that provides the basic implementation needed to make any element a drop target that can have
+ * draggable items dropped onto it.  The drop has no effect until an implementation of notifyDrop is provided.
+ */
+Ext.define('Ext.dd.DropTarget', {
+    extend: 'Ext.dd.DDTarget',
+    requires: ['Ext.dd.ScrollManager'],
+
+<span id='Ext-dd-DropTarget-method-constructor'>    /**
+</span>     * Creates new DropTarget.
+     * @param {String/HTMLElement/Ext.Element} el The container element or ID of it.
+     * @param {Object} config
+     */
+    constructor : function(el, config){
+        this.el = Ext.get(el);
+
+        Ext.apply(this, config);
+
+        if(this.containerScroll){
+            Ext.dd.ScrollManager.register(this.el);
+        }
+
+        this.callParent([this.el.dom, this.ddGroup || this.group,
+              {isTarget: true}]);
+    },
+
+<span id='Ext-dd-DropTarget-cfg-ddGroup'>    /**
+</span>     * @cfg {String} ddGroup
+     * A named drag drop group to which this object belongs.  If a group is specified, then this object will only
+     * interact with other drag drop objects in the same group.
+     */
+<span id='Ext-dd-DropTarget-cfg-overClass'>    /**
+</span>     * @cfg {String} [overClass=&quot;&quot;]
+     * The CSS class applied to the drop target element while the drag source is over it.
+     */
+<span id='Ext-dd-DropTarget-cfg-dropAllowed'>    /**
+</span>     * @cfg {String} [dropAllowed=&quot;x-dd-drop-ok&quot;]
+     * The CSS class returned to the drag source when drop is allowed.
+     */
+    dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok',
+<span id='Ext-dd-DropTarget-cfg-dropNotAllowed'>    /**
+</span>     * @cfg {String} [dropNotAllowed=&quot;x-dd-drop-nodrop&quot;]
+     * The CSS class returned to the drag source when drop is not allowed.
+     */
+    dropNotAllowed : Ext.baseCSSPrefix + 'dd-drop-nodrop',
+
+    // private
+    isTarget : true,
+
+    // private
+    isNotifyTarget : true,
+
+<span id='Ext-dd-DropTarget-method-notifyEnter'>    /**
+</span>     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the source is now over the
+     * target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element
+     * and returns the dropAllowed config value.  This method should be overridden if drop validation is required.
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target
+     * @param {Event} e The event
+     * @param {Object} data An object containing arbitrary data supplied by the drag source
+     * @return {String} status The CSS class that communicates the drop status back to the source so that the
+     * underlying {@link Ext.dd.StatusProxy} can be updated
+     */
+    notifyEnter : function(dd, e, data){
+        if(this.overClass){
+            this.el.addCls(this.overClass);
+        }
+        return this.dropAllowed;
+    },
+
+<span id='Ext-dd-DropTarget-method-notifyOver'>    /**
+</span>     * The function a {@link Ext.dd.DragSource} calls continuously while it is being dragged over the target.
+     * This method will be called on every mouse movement while the drag source is over the drop target.
+     * This default implementation simply returns the dropAllowed config value.
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target
+     * @param {Event} e The event
+     * @param {Object} data An object containing arbitrary data supplied by the drag source
+     * @return {String} status The CSS class that communicates the drop status back to the source so that the
+     * underlying {@link Ext.dd.StatusProxy} can be updated
+     */
+    notifyOver : function(dd, e, data){
+        return this.dropAllowed;
+    },
+
+<span id='Ext-dd-DropTarget-method-notifyOut'>    /**
+</span>     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the source has been dragged
+     * out of the target without dropping.  This default implementation simply removes the CSS class specified by
+     * overClass (if any) from the drop element.
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target
+     * @param {Event} e The event
+     * @param {Object} data An object containing arbitrary data supplied by the drag source
+     */
+    notifyOut : function(dd, e, data){
+        if(this.overClass){
+            this.el.removeCls(this.overClass);
+        }
+    },
+
+<span id='Ext-dd-DropTarget-method-notifyDrop'>    /**
+</span>     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the dragged item has
+     * been dropped on it.  This method has no default implementation and returns false, so you must provide an
+     * implementation that does something to process the drop event and returns true so that the drag source's
+     * repair action does not run.
+     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target
+     * @param {Event} e The event
+     * @param {Object} data An object containing arbitrary data supplied by the drag source
+     * @return {Boolean} False if the drop was invalid.
+     */
+    notifyDrop : function(dd, e, data){
+        return false;
+    },
+
+    destroy : function(){
+        this.callParent();
+        if(this.containerScroll){
+            Ext.dd.ScrollManager.unregister(this.el);
+        }
+    }
+});
+</pre>
+</body>
+</html>