git.roojs.org Git - roojs1/blob - Roo/dd/DropTarget.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12
  13 /**
  14  * @class Roo.dd.DropTarget
  15  * @extends Roo.dd.DDTarget
  16  * A simple class that provides the basic implementation needed to make any element a drop target that can have
  17  * draggable items dropped onto it.  The drop has no effect until an implementation of notifyDrop is provided.
  18  * @constructor
  19  * @param {String/HTMLElement/Element} el The container element
  20  * @param {Object} config
  21  */
  22 Roo.dd.DropTarget = function(el, config){
  23     this.el = Roo.get(el);
  24
  25     Roo.apply(this, config);
  26
  27     if(this.containerScroll){
  28         Roo.dd.ScrollManager.register(this.el);
  29     }
  30
  31
  32     this.events = {
  33         /**
  34          * @scope Roo.BasicLayoutRegion
  35          */
  36
  37         /
  38         /**
  39          * @event invalidated
  40          * Fires when the layout for this region is changed.
  41          * @param {Roo.LayoutRegion} this
  42          */
  43         "invalidated" : true,
  44         /**
  45          * @event visibilitychange
  46          * Fires when this region is shown or hidden
  47          * @param {Roo.LayoutRegion} this
  48          * @param {Boolean} visibility true or false
  49          */
  50         "visibilitychange" : true,
  51     }
  52     Roo.dd.DropTarget.superclass.constructor.call(  this,
  53         this.el.dom,
  54         this.ddGroup || this.group,
  55         {
  56             isTarget: true,
  57             events : {
  58                  /**
  59                  * @scope Roo.dd.DropTarget
  60                  */
  61
  62                  /**
  63                  * @event notifyenter
  64                  * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the
  65                  * target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element
  66                  * and returns the dropAllowed config value.  This method should be overridden if drop validation is required.
  67                  *
  68                  * IMPORTANT : it should set this.overClass and this.dropAllowed;
  69                  *
  70                  * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  71                  * @param {Event} e The event
  72                  * @param {Object} data An object containing arbitrary data supplied by the drag source
  73                  * @return {String} status The CSS class that communicates the drop status back to the source so that the
  74                  * underlying {@link Roo.dd.StatusProxy} can be updated
  75                  */
  76                 "notifyenter" : true,
  77
  78
  79             }
  80
  81
  82         }
  83     );
  84
  85 };
  86
  87 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
  88     /**
  89      * @cfg {String} overClass
  90      * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
  91      */
  92     /**
  93      * @cfg {String} dropAllowed
  94      * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
  95      */
  96     dropAllowed : "x-dd-drop-ok",
  97     /**
  98      * @cfg {String} dropNotAllowed
  99      * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
 100      */
 101     dropNotAllowed : "x-dd-drop-nodrop",
 102
 103     // private
 104     isTarget : true,
 105
 106     // private
 107     isNotifyTarget : true,
 108
 109     /**
 110      * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the
 111      * target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element
 112      * and returns the dropAllowed config value.  This method should be overridden if drop validation is required.
 113      * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
 114      * @param {Event} e The event
 115      * @param {Object} data An object containing arbitrary data supplied by the drag source
 116      * @return {String} status The CSS class that communicates the drop status back to the source so that the
 117      * underlying {@link Roo.dd.StatusProxy} can be updated
 118      */
 119     notifyEnter : function(dd, e, data){
 120         if(this.overClass){
 121             this.el.addClass(this.overClass);
 122         }
 123         return this.dropAllowed;
 124     },
 125
 126     /**
 127      * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.
 128      * This method will be called on every mouse movement while the drag source is over the drop target.
 129      * This default implementation simply returns the dropAllowed config value.
 130      * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
 131      * @param {Event} e The event
 132      * @param {Object} data An object containing arbitrary data supplied by the drag source
 133      * @return {String} status The CSS class that communicates the drop status back to the source so that the
 134      * underlying {@link Roo.dd.StatusProxy} can be updated
 135      */
 136     notifyOver : function(dd, e, data){
 137         return this.dropAllowed;
 138     },
 139
 140     /**
 141      * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged
 142      * out of the target without dropping.  This default implementation simply removes the CSS class specified by
 143      * overClass (if any) from the drop element.
 144      * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
 145      * @param {Event} e The event
 146      * @param {Object} data An object containing arbitrary data supplied by the drag source
 147      */
 148     notifyOut : function(dd, e, data){
 149         if(this.overClass){
 150             this.el.removeClass(this.overClass);
 151         }
 152     },
 153
 154     /**
 155      * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has
 156      * been dropped on it.  This method has no default implementation and returns false, so you must provide an
 157      * implementation that does something to process the drop event and returns true so that the drag source's
 158      * repair action does not run.
 159      * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
 160      * @param {Event} e The event
 161      * @param {Object} data An object containing arbitrary data supplied by the drag source
 162      * @return {Boolean} True if the drop was valid, else false
 163      */
 164     notifyDrop : function(dd, e, data){
 165         return false;
 166     }
 167 });