| groups : object An object in the format {'group1':true, 'group2':trueThe group defines a logical collection of DragDrop objects that are
+ This class provides a container DD instance that allows dropping on multiple child target nodes.
+ By default, this class requires that child nodes accepting drop are registered with Ext.dd.Registry.
+However a simpler way to allow a DropZone to manage any number of target elements is to configure the
+DropZone with an implementation of getTargetFromEvent which interrogates the passed
+mouse event to see if it has taken place within an element, or class of elements. This is easily done
+by using the event's getTarget method to identify a node based on a
+Ext.DomQuery selector.
+ Once the DropZone has detected through calling getTargetFromEvent, that the mouse is over
+a drop target, that target is passed as the first parameter to onNodeEnter, onNodeOver,
+onNodeOut, onNodeDrop. You may configure the instance of DropZone with implementations
+of these methods to provide application-specific behaviour for these events to update both
+application state, and UI state.
+ For example to make a GridPanel a cooperating target with the example illustrated in
+DragZone, the following technique might be used: myGridPanel.on('render', function() {
+ myGridPanel.dropZone = new Ext.dd.DropZone(myGridPanel.getView().scroller, {
+
+// If the mouse is over a grid row, return that node. This is
+// provided as the "target" parameter in all "onNodeXXXX" node event handling functions
+ getTargetFromEvent: function(e) {
+ return e.getTarget(myGridPanel.getView().rowSelector);
+ },
+
+// On entry into a target node, highlight that node.
+ onNodeEnter : function(target, dd, e, data){
+ Ext.fly(target).addClass('my-row-highlight-class');
+ },
+
+// On exit from a target node, unhighlight that node.
+ onNodeOut : function(target, dd, e, data){
+ Ext.fly(target).removeClass('my-row-highlight-class');
+ },
+
+// While over a target node, return the default drop allowed class which
+// places a "tick" icon into the drag proxy.
+ onNodeOver : function(target, dd, e, data){
+ return Ext.dd.DropZone.prototype.dropAllowed;
+ },
+
+// On node drop we can interrogate the target to find the underlying
+// application object that is the real target of the dragged data.
+// In this case, it is a Record in the GridPanel's Store.
+// We can use the data set up by the DragZone's getDragData method to read
+// any data we decided to attach in the DragZone's getDragData method.
+ onNodeDrop : function(target, dd, e, data){
+ var rowIndex = myGridPanel.getView().findRowIndex(target);
+ var r = myGridPanel.getStore().getAt(rowIndex);
+ Ext.Msg.alert('Drop gesture', 'Dropped Record id ' + data.draggedRecord.id +
+ ' on Record id ' + r.id);
+ return true;
+ }
+ });
+}
+See the DragZone documentation for details about building a DragZone which
+cooperates with this DropZone. Config Options|
| ddGroup : StringA named drag drop group to which this object belongs. If a group is specified, then this object will only
+interact w... A named drag drop group to which this object belongs. If a group is specified, then this object will only
+interact with other drag drop objects in the same group (defaults to undefined). | DropTarget | | dropAllowed : String The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). | DropTarget | | dropNotAllowed : String The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). | DropTarget | | overClass : String The CSS class applied to the drop target element while the drag source is over it (defaults to ""). | DropTarget |
Public Properties|
| available : boolean The available property is false until the linked dom element is accessible. | DragDrop | | config : object Configuration attributes passed into the constructor | DragDrop | | defaultPadding : Object Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). | DragDrop | | groups : object An object in the format {'group1':true, 'group2':trueThe group defines a logical collection of DragDrop objects that are
related. Instances only get events when interact... The group defines a logical collection of DragDrop objects that are
related. Instances only get events when interacting with other
DragDrop object in the same group. This lets us define multiple
@@ -136,9 +131,9 @@ an object containing the sides to pad. For example: {right:10, bottom:10} <
:
HTMLElement Returns a reference to the linked element Returns a reference to the linked element Parameters:Returns:HTMLElement the html element
| DragDrop | | getTargetFromEvent( Event e )
:
- ObjectReturns a custom data object associated with the DOM node that is the target of the event. By default
-this looks up... Returns a custom data object associated with the DOM node that is the target of the event. By default
-this looks up the event target in the Ext.dd.Registry, although you can override this method to
+ Object Returns a custom data object associated with the DOM node that is the target of the event. By default
+this looks up ... Returns a custom data object associated with the DOM node that is the target of the event. By default
+this looks up the event target in the Ext.dd.Registry, although you can override this method to
provide your own custom lookup. Parameters:Returns:Object data The custom data
| DropZone | | init( id the , String sGroup , object config )
:
voidSets up the DragDrop object. Must be called in the constructor of any
@@ -156,74 +151,74 @@ false | Lock this instance | DragDrop | | notifyDrop( Ext.dd.DragSource source , Event e , Object data )
:
- BooleanThe function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has
-been dropped on it. ... The function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has
-been dropped on it. The drag zone will look up the target node based on the event passed in, and if there
-is a node registered for that event, it will delegate to onNodeDrop for node-specific handling,
+ Boolean The function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has
+been dropped on it. T... The function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has
+been dropped on it. The drag zone will look up the target node based on the event passed in, and if there
+is a node registered for that event, it will delegate to onNodeDrop for node-specific handling,
otherwise it will call onContainerDrop. | DropZone | | notifyEnter( Ext.dd.DragSource source , Event e , Object data )
:
- StringThe function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over
-the zone. The defa... The function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over
-the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop
-nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops
-you should override this method and provide a custom implementation. Parameters:Returns:String status The CSS class that communicates the drop status back to the source so that the
+ String The function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over
+the zone. The defau... The function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over
+the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop
+nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops
+you should override this method and provide a custom implementation.
| DropZone | | notifyOut( Ext.dd.DragSource source , Event e , Object data )
:
- voidThe function a Ext.dd.DragSource calls once to notify this drop zone that the source has been dragged
-out of the zon... The function a Ext.dd.DragSource calls once to notify this drop zone that the source has been dragged
-out of the zone without dropping. If the drag source is currently over a registered node, the notification
+ void The function a Ext.dd.DragSource calls once to notify this drop zone that the source has been dragged
+out of the zone... The function a Ext.dd.DragSource calls once to notify this drop zone that the source has been dragged
+out of the zone without dropping. If the drag source is currently over a registered node, the notification
will be delegated to onNodeOut for node-specific handling, otherwise it will be ignored. | DropZone | | notifyOver( Ext.dd.DragSource source , Event e , Object data )
:
- StringThe function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone.
-This method will b... The function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone.
-This method will be called on every mouse movement while the drag source is over the drop zone.
-It will call onNodeOver while the drag source is over a registered node, and will also automatically
-delegate to the appropriate node-specific methods as necessary when the drag source enters and exits
-registered nodes ( onNodeEnter, onNodeOut). If the drag source is not currently over a
-registered node, it will call onContainerOver. Parameters:Returns:String status The CSS class that communicates the drop status back to the source so that the
+ String The function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone.
+This method will be... The function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone.
+This method will be called on every mouse movement while the drag source is over the drop zone.
+It will call onNodeOver while the drag source is over a registered node, and will also automatically
+delegate to the appropriate node-specific methods as necessary when the drag source enters and exits
+registered nodes ( onNodeEnter, onNodeOut). If the drag source is not currently over a
+registered node, it will call onContainerOver.
| DropZone | | onAvailable()
:
voidOverride the onAvailable method to do what is needed after the initial
position was determined. Override the onAvailable method to do what is needed after the initial
position was determined. | DragDrop | | onContainerDrop( Ext.dd.DragSource source , Event e , Object data )
:
- BooleanCalled when the DropZone determines that a Ext.dd.DragSource has been dropped on it,
-but not on any of its registere... Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it,
-but not on any of its registered drop nodes. The default implementation returns false, so it should be
-overridden to provide the appropriate processing of the drop event if you need the drop zone itself to
+ Boolean Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it,
+but not on any of its registered... Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it,
+but not on any of its registered drop nodes. The default implementation returns false, so it should be
+overridden to provide the appropriate processing of the drop event if you need the drop zone itself to
be able to accept drops. It should return true when valid so that the drag source's repair action does not run. | DropZone | | onContainerOver( Ext.dd.DragSource source , Event e , Object data )
:
- StringCalled while the DropZone determines that a Ext.dd.DragSource is being dragged over it,
-but not over any of its regi... Called while the DropZone determines that a Ext.dd.DragSource is being dragged over it,
-but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so
-it should be overridden to provide the proper feedback if necessary. Parameters:Returns:String status The CSS class that communicates the drop status back to the source so that the
+ String Called while the DropZone determines that a Ext.dd.DragSource is being dragged over it,
+but not over any of its regis... Called while the DropZone determines that a Ext.dd.DragSource is being dragged over it,
+but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so
+it should be overridden to provide the proper feedback if necessary.
| DropZone | | onNodeDrop( Object nodeData , Ext.dd.DragSource source , Event e , Object data )
:
- BooleanCalled when the DropZone determines that a Ext.dd.DragSource has been dropped onto
-the drop node. The default imple... Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto
-the drop node. The default implementation returns false, so it should be overridden to provide the
-appropriate processing of the drop event and return true so that the drag source's repair action does not run. Parameters:nodeData : ObjectThe custom data associated with the drop node (this is the same value returned from
+ Boolean Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto
+the drop node. The default implem... Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto
+the drop node. The default implementation returns false, so it should be overridden to provide the
+appropriate processing of the drop event and return true so that the drag source's repair action does not run.
| DropZone | | onNodeEnter( Object nodeData , Ext.dd.DragSource source , Event e , Object data )
:
- voidCalled when the DropZone determines that a Ext.dd.DragSource has entered a drop node
-that has either been registered... Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node
-that has either been registered or detected by a configured implementation of getTargetFromEvent.
-This method has no default implementation and should be overridden to provide
-node-specific processing if necessary. Parameters:nodeData : ObjectThe custom data associated with the drop node (this is the same value returned from
+ void Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node
+that has either been registered ... Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node
+that has either been registered or detected by a configured implementation of getTargetFromEvent.
+This method has no default implementation and should be overridden to provide
+node-specific processing if necessary.
| DropZone | | onNodeOut( Object nodeData , Ext.dd.DragSource source , Event e , Object data )
:
- voidCalled when the DropZone determines that a Ext.dd.DragSource has been dragged out of
-the drop node without dropping.... Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of
-the drop node without dropping. This method has no default implementation and should be overridden to provide
-node-specific processing if necessary. Parameters:nodeData : ObjectThe custom data associated with the drop node (this is the same value returned from
+ void Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of
+the drop node without dropping. ... Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of
+the drop node without dropping. This method has no default implementation and should be overridden to provide
+node-specific processing if necessary.
| DropZone | | onNodeOver( Object nodeData , Ext.dd.DragSource source , Event e , Object data )
:
- StringCalled while the DropZone determines that a Ext.dd.DragSource is over a drop node
-that has either been registered or... Called while the DropZone determines that a Ext.dd.DragSource is over a drop node
-that has either been registered or detected by a configured implementation of getTargetFromEvent.
-The default implementation returns this.dropNotAllowed, so it should be
-overridden to provide the proper feedback. Parameters:Returns:String status The CSS class that communicates the drop status back to the source so that the
+ String Called while the DropZone determines that a Ext.dd.DragSource is over a drop node
+that has either been registered or ... Called while the DropZone determines that a Ext.dd.DragSource is over a drop node
+that has either been registered or detected by a configured implementation of getTargetFromEvent.
+The default implementation returns this.dropNotAllowed, so it should be
+overridden to provide the proper feedback.
| DropZone | | removeFromGroup( string sGroup )
:
voidRemove's this instance from the supplied interaction group Remove's this instance from the supplied interaction group Parameters:sGroup : stringThe group to drop Returns: | DragDrop | | setPadding( int iTop , int iRight , int iBot , int iLeft )
|
|