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 Roo.apply(this, config);
27 if(this.containerScroll){
28 Roo.dd.ScrollManager.register(this.el);
32 * @scope Roo.dd.DropTarget
37 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the
38 * target. This default implementation adds the CSS class specified by overClass (if any) to the drop element
39 * and returns the dropAllowed config value. This method should be overridden if drop validation is required.
41 * IMPORTANT : it should set this.overClass and this.dropAllowed
43 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
44 * @param {Event} e The event
45 * @param {Object} data An object containing arbitrary data supplied by the drag source
51 * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.
52 * This method will be called on every mouse movement while the drag source is over the drop target.
53 * This default implementation simply returns the dropAllowed config value.
55 * IMPORTANT : it should set this.dropAllowed
57 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
58 * @param {Event} e The event
59 * @param {Object} data An object containing arbitrary data supplied by the drag source
65 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged
66 * out of the target without dropping. This default implementation simply removes the CSS class specified by
67 * overClass (if any) from the drop element.
68 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
69 * @param {Event} e The event
70 * @param {Object} data An object containing arbitrary data supplied by the drag source
76 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has
77 * been dropped on it. This method has no default implementation and returns false, so you must provide an
78 * implementation that does something to process the drop event and returns true so that the drag source's
79 * repair action does not run.
81 * IMPORTANT : it should set this.success
83 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
84 * @param {Event} e The event
85 * @param {Object} data An object containing arbitrary data supplied by the drag source
91 Roo.dd.DropTarget.superclass.constructor.call( this,
93 this.ddGroup || this.group,
96 listeners : config.listeners || {} ,
104 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
106 * @cfg {String} overClass
107 * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
110 * @cfg {String} ddGroup
111 * The drag drop group to handle drop events for
115 * @cfg {String} dropAllowed
116 * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
118 dropAllowed : "x-dd-drop-ok",
120 * @cfg {String} dropNotAllowed
121 * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
123 dropNotAllowed : "x-dd-drop-nodrop",
125 * @cfg {boolean} success
126 * set this after drop listener..
130 * @cfg {boolean} valid
131 * if the drop point is valid for over/enter..
138 isNotifyTarget : true,
143 notifyEnter : function(dd, e, data){
145 this.fireEvent('enter', this, dd, e, data);
147 this.el.addClass(this.overClass);
149 return this.valid ? this.dropAllowed : this.dropNotAllowed;
155 notifyOver : function(dd, e, data){
157 this.fireEvent('over', this, dd, e, data);
158 return this.valid ? this.dropAllowed : this.dropNotAllowed;
164 notifyOut : function(dd, e, data){
165 this.fireEvent('out', this, dd, e, data);
167 this.el.removeClass(this.overClass);
174 notifyDrop : function(dd, e, data){
175 this.success = false;
176 this.fireEvent('drop', this, dd, e, data);