Ext.tree.TreeDropZone

Lets you specify a css class of elements that will not initiate a drag

Parameters

• cssClass : string
  the class of the elements you wish to ignore

Returns

• Void

Lets you to specify an element id for a child of a drag handle that should not initiate a drag

Parameters

• id : string
  the element id of the element you wish to ignore

Returns

• Void

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.

Parameters

• tagName : string
  the type of element to exclude

Returns

• Void

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.

Parameters

• {string} : sGroup
  the name of the group

Returns

• Void

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.

Returns

• Void

Clears any constraints applied to this instance. Also clears ticks since they can't exist independent of a constraint at this time.

Returns

• Void

Clears any tick interval defined for this instance

Returns

• Void

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");
     }
 });

Parameters

• constrainTo : Mixed
  The element to constrain to.
• pad : Object/Number
  (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}
• inContent : Boolean
  (optional) Constrain the draggable in the content box of the element (inside padding and borders)

Returns

• Void

Fired when we are done dragging the object

Parameters

• e : Event
  the mouseup event

Returns

• Void

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

Returns

• HTMLElement   the html element

Returns a reference to the linked element

Returns

• HTMLElement   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.

Parameters

• e : Event
  The event

Returns

• Object   data The custom data

Sets up the DragDrop object. Must be called in the constructor of any Ext.dd.DragDrop subclass

Parameters

• the : id
  id of the linked element
• sGroup : String
  the group of related items
• config : object
  configuration attributes

Returns

• Void

Initializes Targeting functionality only... the object does not get a mousedown handler.

Parameters

• the : id
  id of the linked element
• sGroup : String
  the group of related items
• config : object
  configuration attributes

Returns

• Void

Returns true if this instance is locked, or the drag drop mgr is locked (meaning that all drag/drop is disabled on the page.)

Returns

• boolean   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

Parameters

• node : HTMLElement
  the HTMLElement to evaluate

Returns

• boolean   true if this is a valid tag type, false if not

Lock this instance

Returns

• Void

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.

Parameters

• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• Boolean   True if the drop was valid, else false

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

• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• String   status The CSS class that communicates the drop status back to the source so that the underlying {@link 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.

Parameters

• source : Ext.dd.DragSource
  The drag source that was dragged over this drop target
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag zone

Returns

• Void

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

• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• String   status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated

Override the onAvailable method to do what is needed after the initial position was determined.

Returns

• Void

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.

Parameters

• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• Boolean   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.

Parameters

• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• String   status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated

Abstract method called during the onMouseMove event while dragging an object.

Parameters

• e : Event
  the mousemove event

Returns

• Void

Abstract method called when this item is dropped on another DragDrop obj

Parameters

• e : Event
  the mouseup event
• id : String|DragDrop[]
  In POINT mode, the element id this was dropped on. In INTERSECT mode, an array of dd items this was dropped on.

Returns

• Void

Abstract method called when this element fist begins hovering over another DragDrop obj

Parameters

• e : Event
  the mousemove event
• id : String|DragDrop[]
  In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of one or more dragdrop items being hovered over.

Returns

• Void

Abstract method called when we are no longer hovering over an element

Parameters

• e : Event
  the mousemove event
• id : String|DragDrop[]
  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.

Returns

• Void

Abstract method called when this element is hovering over another DragDrop obj

Parameters

• e : Event
  the mousemove event
• id : String|DragDrop[]
  In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of dd items being hovered over.

Returns

• Void

Abstract method called when this item is dropped on an area with no drop target

Parameters

• e : Event
  the mouseup event

Returns

• Void

Event handler that fires when a drag/drop obj gets a mousedown

Parameters

• e : Event
  the mousedown event

Returns

• Void

Event handler that fires when a drag/drop obj gets a mouseup

Parameters

• e : Event
  the mouseup event

Returns

• Void

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 : Object
  The custom data associated with the drop node (this is the same value returned from getTargetFromEvent for this node)
• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• Boolean   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.

Parameters

• nodeData : Object
  The custom data associated with the drop node (this is the same value returned from getTargetFromEvent for this node)
• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• Void

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 : Object
  The custom data associated with the drop node (this is the same value returned from getTargetFromEvent for this node)
• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• Void

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

• nodeData : Object
  The custom data associated with the drop node (this is the same value returned from getTargetFromEvent for this node)
• source : Ext.dd.DragSource
  The drag source that was dragged over this drop zone
• e : Event
  The event
• data : Object
  An object containing arbitrary data supplied by the drag source

Returns

• String   status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated

Remove's this instance from the supplied interaction group

Parameters

• sGroup : string
  The group to drop

Returns

• Void

Unsets an invalid css class

Parameters

• cssClass : string
  the class of the element(s) you wish to re-enable

Returns

• Void

Unsets an invalid handle id

Parameters

• id : string
  the id of the element to re-enable

Returns

• Void

Unsets an excluded tag name set by addInvalidHandleType

Parameters

• tagName : string
  the type of element to unexclude

Returns

• Void

resetConstraints must be called if you manually reposition a dd element.

Parameters

• maintainOffset : boolean

Returns

• Void

Allows you to specify that an element other than the linked element will be moved with the cursor during a drag

Parameters

• {string} : id
  the id of the element that will be used to initiate the drag

Returns

• Void

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.

Parameters

• {string} : id
  the id of the element that will be used to initiate the drag.

Returns

• Void

Stores the initial placement of the linked element.

Parameters

• diffX : int
  the X offset, default 0
• diffY : int
  the Y offset, default 0

Returns

• Void

Allows you to set an element outside of the linked element as a drag handle

Parameters

• the : id
  id of the element that will be used to initiate the drag

Returns

• Void

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.

Parameters

• iTop : int
  Top pad
• iRight : int
  Right pad
• iBot : int
  Bot pad
• iLeft : int
  Left pad

Returns

• Void

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.

Parameters

• iLeft : int
  the number of pixels the element can move to the left
• iRight : int
  the number of pixels the element can move to the right
• iTickSize : int
  optional parameter for specifying that the element should move iTickSize pixels at a time.

Returns

• Void

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.

Parameters

• iUp : int
  the number of pixels the element can move up
• iDown : int
  the number of pixels the element can move down
• iTickSize : int
  optional parameter for specifying that the element should move iTickSize pixels at a time.

Returns

• Void

Abstract method called after a drag/drop object is clicked and the drag or mousedown time thresholds have beeen met.

Parameters

• X : int
  click location
• Y : int
  click location

Returns

• Void

toString method

Returns

• string   string representation of the dd obj

Unlock this instace

Returns

• Void

Remove all drag and drop hooks for this element

Returns

• Void