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">
12 * @class Roo.dd.DropZone
13 * @extends Roo.dd.DropTarget
14 * This class provides a container DD instance that proxies for multiple child node targets.<br />
15 * By default, this class requires that child nodes accepting drop are registered with {@link Roo.dd.Registry}.
17 * @param {String/HTMLElement/Element} el The container element
18 * @param {Object} config
20 Roo.dd.DropZone = function(el, config){
21 Roo.dd.DropZone.superclass.constructor.call(this, el, config);
24 Roo.extend(Roo.dd.DropZone, Roo.dd.DropTarget, {
26 * Returns a custom data object associated with the DOM node that is the target of the event. By default
27 * this looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to
28 * provide your own custom lookup.
29 * @param {Event} e The event
30 * @return {Object} data The custom data
32 getTargetFromEvent : function(e){
33 return Roo.dd.Registry.getTargetFromEvent(e);
37 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node
38 * that it has registered. This method has no default implementation and should be overridden to provide
39 * node-specific processing if necessary.
40 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
41 * {@link #getTargetFromEvent} for this node)
42 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
43 * @param {Event} e The event
44 * @param {Object} data An object containing arbitrary data supplied by the drag source
46 onNodeEnter : function(n, dd, e, data){
51 * Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node
52 * that it has registered. The default implementation returns this.dropNotAllowed, so it should be
53 * overridden to provide the proper feedback.
54 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
55 * {@link #getTargetFromEvent} for this node)
56 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
57 * @param {Event} e The event
58 * @param {Object} data An object containing arbitrary data supplied by the drag source
59 * @return {String} status The CSS class that communicates the drop status back to the source so that the
60 * underlying {@link Roo.dd.StatusProxy} can be updated
62 onNodeOver : function(n, dd, e, data){
63 return this.dropAllowed;
67 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of
68 * the drop node without dropping. This method has no default implementation and should be overridden to provide
69 * node-specific processing if necessary.
70 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
71 * {@link #getTargetFromEvent} for this node)
72 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
73 * @param {Event} e The event
74 * @param {Object} data An object containing arbitrary data supplied by the drag source
76 onNodeOut : function(n, dd, e, data){
81 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto
82 * the drop node. The default implementation returns false, so it should be overridden to provide the
83 * appropriate processing of the drop event and return true so that the drag source's repair action does not run.
84 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
85 * {@link #getTargetFromEvent} for this node)
86 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
87 * @param {Event} e The event
88 * @param {Object} data An object containing arbitrary data supplied by the drag source
89 * @return {Boolean} True if the drop was valid, else false
91 onNodeDrop : function(n, dd, e, data){
96 * Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,
97 * but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so
98 * it should be overridden to provide the proper feedback if necessary.
99 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
100 * @param {Event} e The event
101 * @param {Object} data An object containing arbitrary data supplied by the drag source
102 * @return {String} status The CSS class that communicates the drop status back to the source so that the
103 * underlying {@link Roo.dd.StatusProxy} can be updated
105 onContainerOver : function(dd, e, data){
106 return this.dropNotAllowed;
110 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,
111 * but not on any of its registered drop nodes. The default implementation returns false, so it should be
112 * overridden to provide the appropriate processing of the drop event if you need the drop zone itself to
113 * be able to accept drops. It should return true when valid so that the drag source's repair action does not run.
114 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
115 * @param {Event} e The event
116 * @param {Object} data An object containing arbitrary data supplied by the drag source
117 * @return {Boolean} True if the drop was valid, else false
119 onContainerDrop : function(dd, e, data){
124 * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over
125 * the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop
126 * nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops
127 * you should override this method and provide a custom implementation.
128 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
129 * @param {Event} e The event
130 * @param {Object} data An object containing arbitrary data supplied by the drag source
131 * @return {String} status The CSS class that communicates the drop status back to the source so that the
132 * underlying {@link Roo.dd.StatusProxy} can be updated
134 notifyEnter : function(dd, e, data){
135 return this.dropNotAllowed;
139 * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.
140 * This method will be called on every mouse movement while the drag source is over the drop zone.
141 * It will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically
142 * delegate to the appropriate node-specific methods as necessary when the drag source enters and exits
143 * registered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a
144 * registered node, it will call {@link #onContainerOver}.
145 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
146 * @param {Event} e The event
147 * @param {Object} data An object containing arbitrary data supplied by the drag source
148 * @return {String} status The CSS class that communicates the drop status back to the source so that the
149 * underlying {@link Roo.dd.StatusProxy} can be updated
151 notifyOver : function(dd, e, data){
152 var n = this.getTargetFromEvent(e);
153 if(!n){ // not over valid drop target
154 if(this.lastOverNode){
155 this.onNodeOut(this.lastOverNode, dd, e, data);
156 this.lastOverNode = null;
158 return this.onContainerOver(dd, e, data);
160 if(this.lastOverNode != n){
161 if(this.lastOverNode){
162 this.onNodeOut(this.lastOverNode, dd, e, data);
164 this.onNodeEnter(n, dd, e, data);
165 this.lastOverNode = n;
167 return this.onNodeOver(n, dd, e, data);
171 * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged
172 * out of the zone without dropping. If the drag source is currently over a registered node, the notification
173 * will be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.
174 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
175 * @param {Event} e The event
176 * @param {Object} data An object containing arbitrary data supplied by the drag zone
178 notifyOut : function(dd, e, data){
179 if(this.lastOverNode){
180 this.onNodeOut(this.lastOverNode, dd, e, data);
181 this.lastOverNode = null;
186 * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has
187 * been dropped on it. The drag zone will look up the target node based on the event passed in, and if there
188 * is a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,
189 * otherwise it will call {@link #onContainerDrop}.
190 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
191 * @param {Event} e The event
192 * @param {Object} data An object containing arbitrary data supplied by the drag source
193 * @return {Boolean} True if the drop was valid, else false
195 notifyDrop : function(dd, e, data){
196 if(this.lastOverNode){
197 this.onNodeOut(this.lastOverNode, dd, e, data);
198 this.lastOverNode = null;
200 var n = this.getTargetFromEvent(e);
202 this.onNodeDrop(n, dd, e, data) :
203 this.onContainerDrop(dd, e, data);
207 triggerCacheRefresh : function(){
208 Roo.dd.DDM.refreshCache(this.groups);