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 = false; ;
26 if (config && config.listeners) {
27 listeners= config.listeners;
28 delete config.listeners;
30 Roo.apply(this, config);
32 if(this.containerScroll){
33 Roo.dd.ScrollManager.register(this.el);
37 * @scope Roo.dd.DropTarget
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.
46 * IMPORTANT : it should set this.overClass and this.dropAllowed
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
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.
60 * IMPORTANT : it should set this.dropAllowed
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
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.
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
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.
87 * IMPORTANT : it should set this.success
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
97 Roo.dd.DropTarget.superclass.constructor.call( this,
99 this.ddGroup || this.group,
102 listeners : listeners || {}
110 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
112 * @cfg {String} overClass
113 * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
116 * @cfg {String} ddGroup
117 * The drag drop group to handle drop events for
121 * @cfg {String} dropAllowed
122 * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
124 dropAllowed : "x-dd-drop-ok",
126 * @cfg {String} dropNotAllowed
127 * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
129 dropNotAllowed : "x-dd-drop-nodrop",
131 * @cfg {boolean} success
132 * set this after drop listener..
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..
144 isNotifyTarget : true,
149 notifyEnter : function(dd, e, data)
152 this.fireEvent('enter', dd, e, data);
154 this.el.addClass(this.overClass);
156 return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : (
157 this.valid ? this.dropAllowed : this.dropNotAllowed
164 notifyOver : function(dd, e, data)
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
176 notifyOut : function(dd, e, data)
178 this.fireEvent('out', dd, e, data);
180 this.el.removeClass(this.overClass);
187 notifyDrop : function(dd, e, data)
189 this.success = false;
190 this.fireEvent('drop', dd, e, data);