Hierarchy
Ext.dd.DragDropExt.dd.DDTargetExt.dd.DropTargetExt.dd.DropZone
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).addCls('my-row-highlight-class');
- },
-
- // On exit from a target node, unhighlight that node.
- onNodeOut : function(target, dd, e, data){
- Ext.fly(target).removeCls('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.
-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).
-The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
-The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
-The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
-The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
-The available property is false until the linked dom element is accessible.
-The available property is false until the linked dom element is accessible.
-Configuration attributes passed into the constructor
-Configuration attributes passed into the constructor
-Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).
-Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).
-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 -groups using a single DragDrop subclass if we want. An object in the format {'group1':true, 'group2':true}
-By default, drags can only be initiated if the mousedown occurs in the -region the linked element is. This is done in part to work around a -bug in some browsers that mis-report the mousedown if the previous -mouseup happened outside of the window. This property is set to true -if outer handles are defined. @default false
-The id of the element associated with this object. This is what we -refer to as the "linked element" because the size and position of -this element is used to determine when the drag and drop objects have -interacted.
-Set to false to enable a DragDrop object to fire drag events while dragging -over its own Element. Defaults to true - DragDrop objects do not by default -fire drag events to themselves.
-An Array of CSS class names for elements to be considered in valid as drag handles.
-An Array of CSS class names for elements to be considered in valid as drag handles.
-An object who's property names identify the IDs of elements to be considered invalid as drag handles. -A non-null property value identifies the ID as invalid. For example, to prevent -dragging from being initiated on element ID "foo", use:
- -{
- foo: true
-}An object who's property names identify HTML tags to be considered invalid as drag handles. -A non-null property value identifies the tag as invalid. Defaults to the -following value which prevents drag operations from being initiated by <a> elements:
- -{
- A: "A"
-}By default, all instances can be a drop target. This can be disabled by -setting isTarget to false.
-By default, all instances can be a drop target. This can be disabled by -setting isTarget to false.
-Maintain offsets when we resetconstraints. Set to true when you want -the position of the element relative to its parent to stay the same -when the page changes
-When set to true, other DD objects in cooperating DDGroups do not receive -notification events when this DD object is dragged over them. Defaults to false.
-The padding configured for this drag and drop object for calculating -the drop zone intersection with this object. An array containing the 4 padding values: [top, right, bottom, left]
-By default the drag and drop instance will only respond to the primary -button click (left button for a right-handed mouse). Set to true to -allow drag and drop to start with any mouse click that is propogated -by the browser
-Array of pixel locations the element will snap to if we specified a -horizontal graduation/interval. This array is generated automatically -when you define a tick interval.
-Lets you specify a css class of elements that will not initiate a drag
-Lets you specify a css class of elements that will not initiate a drag
-the class of the elements you wish to ignore
-Lets you to specify an element id for a child of a drag handle -that should not initiate a drag
-Lets you to specify an element id for a child of a drag handle -that should not initiate a drag
-the element id of the element you wish to ignore
-Allows you to specify a tag name that should not start a drag operation -when clicked. This is designed to facilitate embedding links within a -drag handle that do something other than start the drag.
-the type of element to exclude
-Add this instance to a group of related drag/drop objects. All -instances belong to at least one group, and can belong to as many -groups as needed.
-{string} the name of the group
-Applies the configuration parameters that were passed into the constructor. -This is supposed to happen at each level through the inheritance chain. So -a DDProxy implentation will execute apply config on DDProxy, DD, and -DragDrop in order to get all of the parameters that are available in -each object.
-Clears any constraints applied to this instance. Also clears ticks -since they can't exist independent of a constraint at this time.
-Clears any tick interval defined for this instance
-Clears any tick interval defined for this instance
-Initializes the drag drop object's constraints to restrict movement to a certain element.
- -Usage:
- - var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
- { dragElId: "existingProxyDiv" });
- dd.startDrag = function(){
- this.constrainTo("parent-id");
- };
- Or you can initalize it using the Ext.core.Element object:
- - Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
- startDrag : function(){
- this.constrainTo("parent-id");
- }
- });
- The element to constrain to.
-(optional) Pad provides a way to specify "padding" of the constraints, -and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or -an object containing the sides to pad. For example: {right:10, bottom:10}
-(optional) Constrain the draggable in the content box of the element (inside padding and borders)
-Fired when we are done dragging the object
-Fired when we are done dragging the object
-the mouseup event
-Returns a reference to the actual element to drag. By default this is -the same as the html element, but it can be assigned to another -element. An example of this can be found in Ext.dd.DDProxy
-the html element
-Returns a reference to the linked element
-Returns a reference to the linked element
-the html element
-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.
-The event
-data The custom data
-Sets up the DragDrop object. Must be called in the constructor of any -Ext.dd.DragDrop subclass
-Sets up the DragDrop object. Must be called in the constructor of any -Ext.dd.DragDrop subclass
-the id of the linked element
-the group of related items
-configuration attributes
-Initializes Targeting functionality only... the object does not -get a mousedown handler.
-Initializes Targeting functionality only... the object does not -get a mousedown handler.
-the id of the linked element
-the group of related items
-configuration attributes
-Returns true if this instance is locked, or the drag drop mgr is locked -(meaning that all drag/drop is disabled on the page.)
-true if this obj or all drag/drop is locked, else -false
-Checks the tag exclusion list to see if this click should be ignored
-Checks the tag exclusion list to see if this click should be ignored
-the HTMLElement to evaluate
-true if this is a valid tag type, false if not
-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.
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-False if the drop was invalid.
-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.
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-status The CSS class that communicates the drop status back to the source so that the -underlying Ext.dd.StatusProxy can be updated
-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.
-The drag source that was dragged over this drop target
-The event
-An object containing arbitrary data supplied by the drag zone
-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.
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-status The CSS class that communicates the drop status back to the source so that the -underlying Ext.dd.StatusProxy can be updated
-Override 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.
-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.
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-True if the drop was valid, else false
-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.
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-status The CSS class that communicates the drop status back to the source so that the -underlying Ext.dd.StatusProxy can be updated
-Abstract method called during the onMouseMove event while dragging an -object.
-Abstract method called during the onMouseMove event while dragging an -object.
-the mousemove event
-Abstract method called when this item is dropped on another DragDrop -obj
-Abstract method called when this item is dropped on another DragDrop -obj
-the mouseup event
-In POINT mode, the element -id this was dropped on. In INTERSECT mode, an array of dd items this -was dropped on.
-Abstract method called when this element fist begins hovering over -another DragDrop obj
-Abstract method called when this element fist begins hovering over -another DragDrop obj
-the mousemove event
-In POINT mode, the element -id this is hovering over. In INTERSECT mode, an array of one or more -dragdrop items being hovered over.
-Abstract method called when we are no longer hovering over an element
-Abstract method called when we are no longer hovering over an element
-the mousemove event
-In POINT mode, the element -id this was hovering over. In INTERSECT mode, an array of dd items -that the mouse is no longer over.
-Abstract method called when this element is hovering over another -DragDrop obj
-Abstract method called when this element is hovering over another -DragDrop obj
-the mousemove event
-In POINT mode, the element -id this is hovering over. In INTERSECT mode, an array of dd items -being hovered over.
-Abstract method called when this item is dropped on an area with no -drop target
-Abstract method called when this item is dropped on an area with no -drop target
-the mouseup event
-Event handler that fires when a drag/drop obj gets a mousedown
-Event handler that fires when a drag/drop obj gets a mousedown
-the mousedown event
-Event handler that fires when a drag/drop obj gets a mouseup
-Event handler that fires when a drag/drop obj gets a mouseup
-the mouseup event
-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.
-The custom data associated with the drop node (this is the same value returned from -getTargetFromEvent for this node)
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-True if the drop was valid, else false
-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.
-The custom data associated with the drop node (this is the same value returned from -getTargetFromEvent for this node)
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-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.
-The custom data associated with the drop node (this is the same value returned from -getTargetFromEvent for this node)
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-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.
-The custom data associated with the drop node (this is the same value returned from -getTargetFromEvent for this node)
-The drag source that was dragged over this drop zone
-The event
-An object containing arbitrary data supplied by the drag source
-status The CSS class that communicates the drop status back to the source so that the -underlying Ext.dd.StatusProxy can be updated
-Remove's this instance from the supplied interaction group
-Remove's this instance from the supplied interaction group
-The group to drop
-Unsets an invalid css class
-Unsets an invalid css class
-the class of the element(s) you wish to -re-enable
-Unsets an invalid handle id
-Unsets an invalid handle id
-the id of the element to re-enable
-Unsets an excluded tag name set by addInvalidHandleType
-Unsets an excluded tag name set by addInvalidHandleType
-the type of element to unexclude
-resetConstraints must be called if you manually reposition a dd element.
-resetConstraints must be called if you manually reposition a dd element.
-Allows you to specify that an element other than the linked element -will be moved with the cursor during a drag
-Allows you to specify that an element other than the linked element -will be moved with the cursor during a drag
-{string} the id of the element that will be used to initiate the drag
-Allows you to specify a child of the linked element that should be -used to initiate the drag operation. An example of this would be if -you have a content div with text and links. Clicking anywhere in the -content area would normally start the drag operation. Use this method -to specify that an element inside of the content div is the element -that starts the drag operation.
-{string} the id of the element that will be used to -initiate the drag.
-Stores the initial placement of the linked element.
-Stores the initial placement of the linked element.
-the X offset, default 0
-the Y offset, default 0
-Allows you to set an element outside of the linked element as a drag -handle
-Allows you to set an element outside of the linked element as a drag -handle
-the id of the element that will be used to initiate the drag
-Configures the padding for the target zone in px. Effectively expands -(or reduces) the virtual object size for targeting calculations. -Supports css-style shorthand; if only one parameter is passed, all sides -will have that padding, and if only two are passed, the top and bottom -will have the first param, the left and right the second.
-Top pad
-Right pad
-Bot pad
-Left pad
-By default, the element can be dragged any place on the screen. Use -this method to limit the horizontal travel of the element. Pass in -0,0 for the parameters if you want to lock the drag to the y axis.
-the number of pixels the element can move to the left
-the number of pixels the element can move to the -right
-optional parameter for specifying that the -element -should move iTickSize pixels at a time.
-By default, the element can be dragged any place on the screen. Set -this to limit the vertical travel of the element. Pass in 0,0 for the -parameters if you want to lock the drag to the x axis.
-the number of pixels the element can move up
-the number of pixels the element can move down
-optional parameter for specifying that the -element should move iTickSize pixels at a time.
-Abstract method called after a drag/drop object is clicked -and the drag or mousedown time thresholds have beeen met.
-Abstract method called after a drag/drop object is clicked -and the drag or mousedown time thresholds have beeen met.
-click location
-click location
-