4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
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.
19 * @param {String/HTMLElement/Element} el The container element
20 * @param {Object} config
22 Roo.dd.DropTarget = function(el, config){
23 this.el = Roo.get(el);
25 var listeners = config.listeners;
27 delete config.listeners;
29 Roo.apply(this, config);
31 if(this.containerScroll){
32 Roo.dd.ScrollManager.register(this.el);
36 * @scope Roo.dd.DropTarget
41 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the
42 * target. This default implementation adds the CSS class specified by overClass (if any) to the drop element
43 * and returns the dropAllowed config value. This method should be overridden if drop validation is required.
45 * IMPORTANT : it should set this.overClass and this.dropAllowed
47 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
48 * @param {Event} e The event
49 * @param {Object} data An object containing arbitrary data supplied by the drag source
55 * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.
56 * This method will be called on every mouse movement while the drag source is over the drop target.
57 * This default implementation simply returns the dropAllowed config value.
59 * IMPORTANT : it should set this.dropAllowed
61 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
62 * @param {Event} e The event
63 * @param {Object} data An object containing arbitrary data supplied by the drag source
69 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged
70 * out of the target without dropping. This default implementation simply removes the CSS class specified by
71 * overClass (if any) from the drop element.
72 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
73 * @param {Event} e The event
74 * @param {Object} data An object containing arbitrary data supplied by the drag source
80 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has
81 * been dropped on it. This method has no default implementation and returns false, so you must provide an
82 * implementation that does something to process the drop event and returns true so that the drag source's
83 * repair action does not run.
85 * IMPORTANT : it should set this.success
87 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
88 * @param {Event} e The event
89 * @param {Object} data An object containing arbitrary data supplied by the drag source
95 Roo.dd.DropTarget.superclass.constructor.call( this,
97 this.ddGroup || this.group,
100 listeners : listeners || {}
108 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
110 * @cfg {String} overClass
111 * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
114 * @cfg {String} ddGroup
115 * The drag drop group to handle drop events for
119 * @cfg {String} dropAllowed
120 * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
122 dropAllowed : "x-dd-drop-ok",
124 * @cfg {String} dropNotAllowed
125 * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
127 dropNotAllowed : "x-dd-drop-nodrop",
129 * @cfg {boolean} success
130 * set this after drop listener..
134 * @cfg {boolean} valid
135 * if the drop point is valid for over/enter..
142 isNotifyTarget : true,
147 notifyEnter : function(dd, e, data){
149 this.fireEvent('enter', this, dd, e, data);
151 this.el.addClass(this.overClass);
153 return this.valid ? this.dropAllowed : this.dropNotAllowed;
159 notifyOver : function(dd, e, data){
161 this.fireEvent('over', this, dd, e, data);
162 return this.valid ? this.dropAllowed : this.dropNotAllowed;
168 notifyOut : function(dd, e, data){
169 this.fireEvent('out', this, dd, e, data);
171 this.el.removeClass(this.overClass);
178 notifyDrop : function(dd, e, data){
179 this.success = false;
180 this.fireEvent('drop', this, dd, e, data);