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 enter
  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                  */
  74                 "enter" : true,
  75
  76                  /**
  77                  * @event over
  78                  * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.
  79                  * This method will be called on every mouse movement while the drag source is over the drop target.
  80                  * This default implementation simply returns the dropAllowed config value.
  81                  *
  82                  * IMPORTANT : it should set this.dropAllowed
  83                  *
  84                  * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  85                  * @param {Event} e The event
  86                  * @param {Object} data An object containing arbitrary data supplied by the drag source
  87
  88                  */
  89                 "over" : true,
  90                 /**
  91                  * @event out
  92                  * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged
  93                  * out of the target without dropping.  This default implementation simply removes the CSS class specified by
  94                  * overClass (if any) from the drop element.
  95                  * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  96                  * @param {Event} e The event
  97                  * @param {Object} data An object containing arbitrary data supplied by the drag source
  98                  */
  99                  "out" : true,
 100
 101                 /**
 102                  * @event drop
 103                  * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has
 104                  * been dropped on it.  This method has no default implementation and returns false, so you must provide an
 105                  * implementation that does something to process the drop event and returns true so that the drag source's
 106                  * repair action does not run.
 107                  *
 108                  * IMPORTANT : it should set this.success
 109                  *
 110                  * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
 111                  * @param {Event} e The event
 112                  * @param {Object} data An object containing arbitrary data supplied by the drag source
 113                 */
 114                  "drop" : true
 115             }
 116
 117
 118         }
 119     );
 120
 121 };
 122
 123 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
 124     /**
 125      * @cfg {String} overClass
 126      * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
 127      */
 128     /**
 129      * @cfg {String} dropAllowed
 130      * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
 131      */
 132     dropAllowed : "x-dd-drop-ok",
 133     /**
 134      * @cfg {String} dropNotAllowed
 135      * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
 136      */
 137     dropNotAllowed : "x-dd-drop-nodrop",
 138     /**
 139      * @cfg {boolean} success
 140      * set this after drop listener..
 141      */
 142
 143     // private
 144     isTarget : true,
 145
 146     // private
 147     isNotifyTarget : true,
 148
 149     // private
 150
 151     notifyEnter : function(dd, e, data){
 152         this.fireEvent('enter', this, dd, e, data);
 153         if(this.overClass){
 154             this.el.addClass(this.overClass);
 155         }
 156         return this.dropAllowed;
 157     },
 158
 159     // private
 160
 161     notifyOver : function(dd, e, data){
 162         this.fireEvent('over', this, dd, e, data);
 163         return this.dropAllowed;
 164     },
 165
 166
 167     notifyOut : function(dd, e, data){
 168         this.fireEvent('out', this, dd, e, data);
 169         if(this.overClass){
 170             this.el.removeClass(this.overClass);
 171         }
 172     },
 173
 174
 175     notifyDrop : function(dd, e, data){
 176         this.fireEvent('drop', this, dd, e, data);
 177         return false;
 178     }
 179 });