DropZone.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:13k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.dd.DropZone
  3.  * @extends Ext.dd.DropTarget
  4.  * <p>This class provides a container DD instance that allows dropping on multiple child target nodes.</p>
  5.  * <p>By default, this class requires that child nodes accepting drop are registered with {@link Ext.dd.Registry}.
  6.  * However a simpler way to allow a DropZone to manage any number of target elements is to configure the
  7.  * DropZone with an implementation of {@link #getTargetFromEvent} which interrogates the passed
  8.  * mouse event to see if it has taken place within an element, or class of elements. This is easily done
  9.  * by using the event's {@link Ext.EventObject#getTarget getTarget} method to identify a node based on a
  10.  * {@link Ext.DomQuery} selector.</p>
  11.  * <p>Once the DropZone has detected through calling getTargetFromEvent, that the mouse is over
  12.  * a drop target, that target is passed as the first parameter to {@link #onNodeEnter}, {@link #onNodeOver},
  13.  * {@link #onNodeOut}, {@link #onNodeDrop}. You may configure the instance of DropZone with implementations
  14.  * of these methods to provide application-specific behaviour for these events to update both
  15.  * application state, and UI state.</p>
  16.  * <p>For example to make a GridPanel a cooperating target with the example illustrated in
  17.  * {@link Ext.dd.DragZone DragZone}, the following technique might be used:</p><pre><code>
  18. myGridPanel.on('render', function() {
  19.     myGridPanel.dropZone = new Ext.dd.DropZone(myGridPanel.getView().scroller, {
  20. //      If the mouse is over a grid row, return that node. This is
  21. //      provided as the "target" parameter in all "onNodeXXXX" node event handling functions
  22.         getTargetFromEvent: function(e) {
  23.             return e.getTarget(myGridPanel.getView().rowSelector);
  24.         },
  25. //      On entry into a target node, highlight that node.
  26.         onNodeEnter : function(target, dd, e, data){ 
  27.             Ext.fly(target).addClass('my-row-highlight-class');
  28.         },
  29. //      On exit from a target node, unhighlight that node.
  30.         onNodeOut : function(target, dd, e, data){ 
  31.             Ext.fly(target).removeClass('my-row-highlight-class');
  32.         },
  33. //      While over a target node, return the default drop allowed class which
  34. //      places a "tick" icon into the drag proxy.
  35.         onNodeOver : function(target, dd, e, data){ 
  36.             return Ext.dd.DropZone.prototype.dropAllowed;
  37.         },
  38. //      On node drop we can interrogate the target to find the underlying
  39. //      application object that is the real target of the dragged data.
  40. //      In this case, it is a Record in the GridPanel's Store.
  41. //      We can use the data set up by the DragZone's getDragData method to read
  42. //      any data we decided to attach in the DragZone's getDragData method.
  43.         onNodeDrop : function(target, dd, e, data){
  44.             var rowIndex = myGridPanel.getView().findRowIndex(target);
  45.             var r = myGridPanel.getStore().getAt(rowIndex);
  46.             Ext.Msg.alert('Drop gesture', 'Dropped Record id ' + data.draggedRecord.id +
  47.                 ' on Record id ' + r.id);
  48.             return true;
  49.         }
  50.     });
  51. }
  52. </code></pre>
  53.  * See the {@link Ext.dd.DragZone DragZone} documentation for details about building a DragZone which
  54.  * cooperates with this DropZone.
  55.  * @constructor
  56.  * @param {Mixed} el The container element
  57.  * @param {Object} config
  58.  */
  59. Ext.dd.DropZone = function(el, config){
  60.     Ext.dd.DropZone.superclass.constructor.call(this, el, config);
  61. };
  62. Ext.extend(Ext.dd.DropZone, Ext.dd.DropTarget, {
  63.     /**
  64.      * Returns a custom data object associated with the DOM node that is the target of the event.  By default
  65.      * this looks up the event target in the {@link Ext.dd.Registry}, although you can override this method to
  66.      * provide your own custom lookup.
  67.      * @param {Event} e The event
  68.      * @return {Object} data The custom data
  69.      */
  70.     getTargetFromEvent : function(e){
  71.         return Ext.dd.Registry.getTargetFromEvent(e);
  72.     },
  73.     /**
  74.      * Called when the DropZone determines that a {@link Ext.dd.DragSource} has entered a drop node
  75.      * that has either been registered or detected by a configured implementation of {@link #getTargetFromEvent}.
  76.      * This method has no default implementation and should be overridden to provide
  77.      * node-specific processing if necessary.
  78.      * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from 
  79.      * {@link #getTargetFromEvent} for this node)
  80.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  81.      * @param {Event} e The event
  82.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  83.      */
  84.     onNodeEnter : function(n, dd, e, data){
  85.         
  86.     },
  87.     /**
  88.      * Called while the DropZone determines that a {@link Ext.dd.DragSource} is over a drop node
  89.      * that has either been registered or detected by a configured implementation of {@link #getTargetFromEvent}.
  90.      * The default implementation returns this.dropNotAllowed, so it should be
  91.      * overridden to provide the proper feedback.
  92.      * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
  93.      * {@link #getTargetFromEvent} for this node)
  94.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  95.      * @param {Event} e The event
  96.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  97.      * @return {String} status The CSS class that communicates the drop status back to the source so that the
  98.      * underlying {@link Ext.dd.StatusProxy} can be updated
  99.      */
  100.     onNodeOver : function(n, dd, e, data){
  101.         return this.dropAllowed;
  102.     },
  103.     /**
  104.      * Called when the DropZone determines that a {@link Ext.dd.DragSource} has been dragged out of
  105.      * the drop node without dropping.  This method has no default implementation and should be overridden to provide
  106.      * node-specific processing if necessary.
  107.      * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
  108.      * {@link #getTargetFromEvent} for this node)
  109.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  110.      * @param {Event} e The event
  111.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  112.      */
  113.     onNodeOut : function(n, dd, e, data){
  114.         
  115.     },
  116.     /**
  117.      * Called when the DropZone determines that a {@link Ext.dd.DragSource} has been dropped onto
  118.      * the drop node.  The default implementation returns false, so it should be overridden to provide the
  119.      * appropriate processing of the drop event and return true so that the drag source's repair action does not run.
  120.      * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
  121.      * {@link #getTargetFromEvent} for this node)
  122.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  123.      * @param {Event} e The event
  124.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  125.      * @return {Boolean} True if the drop was valid, else false
  126.      */
  127.     onNodeDrop : function(n, dd, e, data){
  128.         return false;
  129.     },
  130.     /**
  131.      * Called while the DropZone determines that a {@link Ext.dd.DragSource} is being dragged over it,
  132.      * but not over any of its registered drop nodes.  The default implementation returns this.dropNotAllowed, so
  133.      * it should be overridden to provide the proper feedback if necessary.
  134.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  135.      * @param {Event} e The event
  136.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  137.      * @return {String} status The CSS class that communicates the drop status back to the source so that the
  138.      * underlying {@link Ext.dd.StatusProxy} can be updated
  139.      */
  140.     onContainerOver : function(dd, e, data){
  141.         return this.dropNotAllowed;
  142.     },
  143.     /**
  144.      * Called when the DropZone determines that a {@link Ext.dd.DragSource} has been dropped on it,
  145.      * but not on any of its registered drop nodes.  The default implementation returns false, so it should be
  146.      * overridden to provide the appropriate processing of the drop event if you need the drop zone itself to
  147.      * be able to accept drops.  It should return true when valid so that the drag source's repair action does not run.
  148.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  149.      * @param {Event} e The event
  150.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  151.      * @return {Boolean} True if the drop was valid, else false
  152.      */
  153.     onContainerDrop : function(dd, e, data){
  154.         return false;
  155.     },
  156.     /**
  157.      * The function a {@link Ext.dd.DragSource} calls once to notify this drop zone that the source is now over
  158.      * the zone.  The default implementation returns this.dropNotAllowed and expects that only registered drop
  159.      * nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops
  160.      * you should override this method and provide a custom implementation.
  161.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  162.      * @param {Event} e The event
  163.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  164.      * @return {String} status The CSS class that communicates the drop status back to the source so that the
  165.      * underlying {@link Ext.dd.StatusProxy} can be updated
  166.      */
  167.     notifyEnter : function(dd, e, data){
  168.         return this.dropNotAllowed;
  169.     },
  170.     /**
  171.      * The function a {@link Ext.dd.DragSource} calls continuously while it is being dragged over the drop zone.
  172.      * This method will be called on every mouse movement while the drag source is over the drop zone.
  173.      * It will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically
  174.      * delegate to the appropriate node-specific methods as necessary when the drag source enters and exits
  175.      * registered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a
  176.      * registered node, it will call {@link #onContainerOver}.
  177.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  178.      * @param {Event} e The event
  179.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  180.      * @return {String} status The CSS class that communicates the drop status back to the source so that the
  181.      * underlying {@link Ext.dd.StatusProxy} can be updated
  182.      */
  183.     notifyOver : function(dd, e, data){
  184.         var n = this.getTargetFromEvent(e);
  185.         if(!n){ // not over valid drop target
  186.             if(this.lastOverNode){
  187.                 this.onNodeOut(this.lastOverNode, dd, e, data);
  188.                 this.lastOverNode = null;
  189.             }
  190.             return this.onContainerOver(dd, e, data);
  191.         }
  192.         if(this.lastOverNode != n){
  193.             if(this.lastOverNode){
  194.                 this.onNodeOut(this.lastOverNode, dd, e, data);
  195.             }
  196.             this.onNodeEnter(n, dd, e, data);
  197.             this.lastOverNode = n;
  198.         }
  199.         return this.onNodeOver(n, dd, e, data);
  200.     },
  201.     /**
  202.      * The function a {@link Ext.dd.DragSource} calls once to notify this drop zone that the source has been dragged
  203.      * out of the zone without dropping.  If the drag source is currently over a registered node, the notification
  204.      * will be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.
  205.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target
  206.      * @param {Event} e The event
  207.      * @param {Object} data An object containing arbitrary data supplied by the drag zone
  208.      */
  209.     notifyOut : function(dd, e, data){
  210.         if(this.lastOverNode){
  211.             this.onNodeOut(this.lastOverNode, dd, e, data);
  212.             this.lastOverNode = null;
  213.         }
  214.     },
  215.     /**
  216.      * The function a {@link Ext.dd.DragSource} calls once to notify this drop zone that the dragged item has
  217.      * been dropped on it.  The drag zone will look up the target node based on the event passed in, and if there
  218.      * is a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,
  219.      * otherwise it will call {@link #onContainerDrop}.
  220.      * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop zone
  221.      * @param {Event} e The event
  222.      * @param {Object} data An object containing arbitrary data supplied by the drag source
  223.      * @return {Boolean} True if the drop was valid, else false
  224.      */
  225.     notifyDrop : function(dd, e, data){
  226.         if(this.lastOverNode){
  227.             this.onNodeOut(this.lastOverNode, dd, e, data);
  228.             this.lastOverNode = null;
  229.         }
  230.         var n = this.getTargetFromEvent(e);
  231.         return n ?
  232.             this.onNodeDrop(n, dd, e, data) :
  233.             this.onContainerDrop(dd, e, data);
  234.     },
  235.     // private
  236.     triggerCacheRefresh : function(){
  237.         Ext.dd.DDM.refreshCache(this.groups);
  238.     }  
  239. });