--- /dev/null
+<html>\r
+<head>\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.DropZone"></div>/**\r
+ * @class Ext.dd.DropZone\r
+ * @extends Ext.dd.DropTarget\r
+ * <p>This class provides a container DD instance that allows dropping on multiple child target nodes.</p>\r
+ * <p>By default, this class requires that child nodes accepting drop are registered with {@link Ext.dd.Registry}.\r
+ * However a simpler way to allow a DropZone to manage any number of target elements is to configure the\r
+ * DropZone with an implementation of {@link #getTargetFromEvent} 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.</p>\r
+ * <p>Once the DropZone has detected through calling getTargetFromEvent, that the mouse is over\r
+ * a drop target, that target is passed as the first parameter to {@link #onNodeEnter}, {@link #onNodeOver},\r
+ * {@link #onNodeOut}, {@link #onNodeDrop}. You may configure the instance of DropZone with implementations\r
+ * of these methods to provide application-specific behaviour for these events to update both\r
+ * application state, and UI state.</p>\r
+ * <p>For example to make a GridPanel a cooperating target with the example illustrated in\r
+ * {@link Ext.dd.DragZone DragZone}, the following technique might be used:</p><pre><code>\r
+myGridPanel.on('render', function() {\r
+ myGridPanel.dropZone = new Ext.dd.DropZone(myGridPanel.getView().scroller, {\r
+\r
+// If the mouse is over a grid row, return that node. This is\r
+// provided as the "target" parameter in all "onNodeXXXX" node event handling functions\r
+ getTargetFromEvent: function(e) {\r
+ return e.getTarget(myGridPanel.getView().rowSelector);\r
+ },\r
+\r
+// On entry into a target node, highlight that node.\r
+ onNodeEnter : function(target, dd, e, data){ \r
+ Ext.fly(target).addClass('my-row-highlight-class');\r
+ },\r
+\r
+// On exit from a target node, unhighlight that node.\r
+ onNodeOut : function(target, dd, e, data){ \r
+ Ext.fly(target).removeClass('my-row-highlight-class');\r
+ },\r
+\r
+// While over a target node, return the default drop allowed class which\r
+// places a "tick" icon into the drag proxy.\r
+ onNodeOver : function(target, dd, e, data){ \r
+ return Ext.dd.DropZone.prototype.dropAllowed;\r
+ },\r
+\r
+// On node drop we can interrogate the target to find the underlying\r
+// application object that is the real target of the dragged data.\r
+// In this case, it is a Record in the GridPanel's Store.\r
+// We can use the data set up by the DragZone's getDragData method to read\r
+// any data we decided to attach in the DragZone's getDragData method.\r
+ onNodeDrop : function(target, dd, e, data){\r
+ var rowIndex = myGridPanel.getView().findRowIndex(target);\r
+ var r = myGridPanel.getStore().getAt(rowIndex);\r
+ Ext.Msg.alert('Drop gesture', 'Dropped Record id ' + data.draggedRecord.id +\r
+ ' on Record id ' + r.id);\r
+ return true;\r
+ }\r
+ });\r
+}\r
+</code></pre>\r
+ * See the {@link Ext.dd.DragZone DragZone} documentation for details about building a DragZone which\r
+ * cooperates with this DropZone.\r
+ * @constructor\r
+ * @param {Mixed} el The container element\r
+ * @param {Object} config\r
+ */\r
+Ext.dd.DropZone = function(el, config){\r
+ Ext.dd.DropZone.superclass.constructor.call(this, el, config);\r
+};\r
+\r
+Ext.extend(Ext.dd.DropZone, Ext.dd.DropTarget, {\r
+ <div id="method-Ext.dd.DropZone-getTargetFromEvent"></div>/**\r
+ * Returns a custom data object associated with the DOM node that is the target of the event. By default\r
+ * this looks up the event target in the {@link Ext.dd.Registry}, although you can override this method to\r
+ * provide your own custom lookup.\r
+ * @param {Event} e The event\r
+ * @return {Object} data The custom data\r
+ */\r
+ getTargetFromEvent : function(e){\r
+ return Ext.dd.Registry.getTargetFromEvent(e);\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-onNodeEnter"></div>/**\r
+ * Called when the DropZone determines that a {@link Ext.dd.DragSource} has entered a drop node\r
+ * that has either been registered or detected by a configured implementation of {@link #getTargetFromEvent}.\r
+ * This method has no default implementation and should be overridden to provide\r
+ * node-specific processing if necessary.\r
+ * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from \r
+ * {@link #getTargetFromEvent} for this node)\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\r
+ * @param {Event} e The event\r
+ * @param {Object} data An object containing arbitrary data supplied by the drag source\r
+ */\r
+ onNodeEnter : function(n, dd, e, data){\r
+ \r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-onNodeOver"></div>/**\r
+ * Called while the DropZone determines that a {@link Ext.dd.DragSource} is over a drop node\r
+ * that has either been registered or detected by a configured implementation of {@link #getTargetFromEvent}.\r
+ * The default implementation returns this.dropNotAllowed, so it should be\r
+ * overridden to provide the proper feedback.\r
+ * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from\r
+ * {@link #getTargetFromEvent} for this node)\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ onNodeOver : function(n, dd, e, data){\r
+ return this.dropAllowed;\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-onNodeOut"></div>/**\r
+ * Called when the DropZone determines that a {@link Ext.dd.DragSource} has been dragged out of\r
+ * the drop node without dropping. This method has no default implementation and should be overridden to provide\r
+ * node-specific processing if necessary.\r
+ * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from\r
+ * {@link #getTargetFromEvent} for this node)\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\r
+ * @param {Event} e The event\r
+ * @param {Object} data An object containing arbitrary data supplied by the drag source\r
+ */\r
+ onNodeOut : function(n, dd, e, data){\r
+ \r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-onNodeDrop"></div>/**\r
+ * Called when the DropZone determines that a {@link Ext.dd.DragSource} has been dropped onto\r
+ * the drop node. The default implementation returns false, so it should be overridden to provide the\r
+ * appropriate processing of the drop event and return true so that the drag source's repair action does not run.\r
+ * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from\r
+ * {@link #getTargetFromEvent} for this node)\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ onNodeDrop : function(n, dd, e, data){\r
+ return false;\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-onContainerOver"></div>/**\r
+ * Called while the DropZone determines that a {@link Ext.dd.DragSource} is being dragged over it,\r
+ * but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\r
+ * it should be overridden to provide the proper feedback if necessary.\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ onContainerOver : function(dd, e, data){\r
+ return this.dropNotAllowed;\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-onContainerDrop"></div>/**\r
+ * Called when the DropZone determines that a {@link Ext.dd.DragSource} has been dropped on it,\r
+ * but not on any of its registered drop nodes. The default implementation returns false, so it should be\r
+ * overridden to provide the appropriate processing of the drop event if you need the drop zone itself to\r
+ * be able to accept drops. It should return true when valid so that the drag source's repair action does not run.\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ onContainerDrop : function(dd, e, data){\r
+ return false;\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-notifyEnter"></div>/**\r
+ * The function a {@link Ext.dd.DragSource} calls once to notify this drop zone that the source is now over\r
+ * the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\r
+ * nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\r
+ * you should override this method and provide a custom implementation.\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ return this.dropNotAllowed;\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-notifyOver"></div>/**\r
+ * The function a {@link Ext.dd.DragSource} calls continuously while it is being dragged over the drop zone.\r
+ * This method will be called on every mouse movement while the drag source is over the drop zone.\r
+ * It will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\r
+ * delegate to the appropriate node-specific methods as necessary when the drag source enters and exits\r
+ * registered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\r
+ * registered node, it will call {@link #onContainerOver}.\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ var n = this.getTargetFromEvent(e);\r
+ if(!n){ // not over valid drop target\r
+ if(this.lastOverNode){\r
+ this.onNodeOut(this.lastOverNode, dd, e, data);\r
+ this.lastOverNode = null;\r
+ }\r
+ return this.onContainerOver(dd, e, data);\r
+ }\r
+ if(this.lastOverNode != n){\r
+ if(this.lastOverNode){\r
+ this.onNodeOut(this.lastOverNode, dd, e, data);\r
+ }\r
+ this.onNodeEnter(n, dd, e, data);\r
+ this.lastOverNode = n;\r
+ }\r
+ return this.onNodeOver(n, dd, e, data);\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-notifyOut"></div>/**\r
+ * The function a {@link Ext.dd.DragSource} calls once to notify this drop zone that the source has been dragged\r
+ * out of the zone without dropping. If the drag source is currently over a registered node, the notification\r
+ * will be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.\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 zone\r
+ */\r
+ notifyOut : function(dd, e, data){\r
+ if(this.lastOverNode){\r
+ this.onNodeOut(this.lastOverNode, dd, e, data);\r
+ this.lastOverNode = null;\r
+ }\r
+ },\r
+\r
+ <div id="method-Ext.dd.DropZone-notifyDrop"></div>/**\r
+ * The function a {@link Ext.dd.DragSource} calls once to notify this drop zone that the dragged item has\r
+ * been dropped on it. The drag zone will look up the target node based on the event passed in, and if there\r
+ * is a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\r
+ * otherwise it will call {@link #onContainerDrop}.\r
+ * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone\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
+ if(this.lastOverNode){\r
+ this.onNodeOut(this.lastOverNode, dd, e, data);\r
+ this.lastOverNode = null;\r
+ }\r
+ var n = this.getTargetFromEvent(e);\r
+ return n ?\r
+ this.onNodeDrop(n, dd, e, data) :\r
+ this.onContainerDrop(dd, e, data);\r
+ },\r
+\r
+ // private\r
+ triggerCacheRefresh : function(){\r
+ Ext.dd.DDM.refreshCache(this.groups);\r
+ } \r
+});</pre> \r
+</body>\r
+</html>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff