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     var listeners = false; ;
  26     if (config && config.listeners) {
  27         listeners= config.listeners;
  28         delete config.listeners;
  29     }
  30     Roo.apply(this, config);
  31
  32     if(this.containerScroll){
  33         Roo.dd.ScrollManager.register(this.el);
  34     }
  35     this.addEvents( {
  36          /**
  37          * @scope Roo.dd.DropTarget
  38          */
  39
  40          /**
  41          * @event enter
  42          * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the
  43          * target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element
  44          * and returns the dropAllowed config value.  This method should be overridden if drop validation is required.
  45          *
  46          * IMPORTANT : it should set this.overClass and this.dropAllowed
  47          *
  48          * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  49          * @param {Event} e The event
  50          * @param {Object} data An object containing arbitrary data supplied by the drag source
  51          */
  52         "enter" : true,
  53
  54          /**
  55          * @event over
  56          * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.
  57          * This method will be called on every mouse movement while the drag source is over the drop target.
  58          * This default implementation simply returns the dropAllowed config value.
  59          *
  60          * IMPORTANT : it should set this.dropAllowed
  61          *
  62          * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  63          * @param {Event} e The event
  64          * @param {Object} data An object containing arbitrary data supplied by the drag source
  65
  66          */
  67         "over" : true,
  68         /**
  69          * @event out
  70          * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged
  71          * out of the target without dropping.  This default implementation simply removes the CSS class specified by
  72          * overClass (if any) from the drop element.
  73          *
  74          * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  75          * @param {Event} e The event
  76          * @param {Object} data An object containing arbitrary data supplied by the drag source
  77          */
  78          "out" : true,
  79
  80         /**
  81          * @event drop
  82          * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has
  83          * been dropped on it.  This method has no default implementation and returns false, so you must provide an
  84          * implementation that does something to process the drop event and returns true so that the drag source's
  85          * repair action does not run.
  86          *
  87          * IMPORTANT : it should set this.success
  88          *
  89          * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
  90          * @param {Event} e The event
  91          * @param {Object} data An object containing arbitrary data supplied by the drag source
  92         */
  93          "drop" : true
  94     });
  95
  96
  97     Roo.dd.DropTarget.superclass.constructor.call(  this,
  98         this.el.dom,
  99         this.ddGroup || this.group,
 100         {
 101             isTarget: true,
 102             listeners : listeners || {}
 103
 104
 105         }
 106     );
 107
 108 };
 109
 110 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
 111     /**
 112      * @cfg {String} overClass
 113      * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
 114      */
 115      /**
 116      * @cfg {String} ddGroup
 117      * The drag drop group to handle drop events for
 118      */
 119
 120     /**
 121      * @cfg {String} dropAllowed
 122      * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
 123      */
 124     dropAllowed : "x-dd-drop-ok",
 125     /**
 126      * @cfg {String} dropNotAllowed
 127      * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
 128      */
 129     dropNotAllowed : "x-dd-drop-nodrop",
 130     /**
 131      * @cfg {boolean} success
 132      * set this after drop listener..
 133      */
 134     success : false,
 135     /**
 136      * @cfg {boolean|String} valid true/false or string (ok-add/ok-sub/ok/nodrop)
 137      * if the drop point is valid for over/enter..
 138      */
 139     valid : false,
 140     // private
 141     isTarget : true,
 142
 143     // private
 144     isNotifyTarget : true,
 145
 146     /**
 147      * @hide
 148      */
 149     notifyEnter : function(dd, e, data)
 150     {
 151         this.valid = true;
 152         this.fireEvent('enter', dd, e, data);
 153         if(this.overClass){
 154             this.el.addClass(this.overClass);
 155         }
 156         return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : (
 157             this.valid ? this.dropAllowed : this.dropNotAllowed
 158         );
 159     },
 160
 161     /**
 162      * @hide
 163      */
 164     notifyOver : function(dd, e, data)
 165     {
 166         this.valid = true;
 167         this.fireEvent('over', dd, e, data);
 168         return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : (
 169             this.valid ? this.dropAllowed : this.dropNotAllowed
 170         );
 171     },
 172
 173     /**
 174      * @hide
 175      */
 176     notifyOut : function(dd, e, data)
 177     {
 178         this.fireEvent('out', dd, e, data);
 179         if(this.overClass){
 180             this.el.removeClass(this.overClass);
 181         }
 182     },
 183
 184     /**
 185      * @hide
 186      */
 187     notifyDrop : function(dd, e, data)
 188     {
 189         this.success = false;
 190         this.fireEvent('drop', dd, e, data);
 191         return this.success;
 192     }
 193 });