Sencha Documentation

Ext.dd.DragDropMgr

Overview
DragDropMgr is a singleton that tracks the element interaction for all DragDrop items in the window. Generally, you will not call this class directly, but it does have helper methods that could be useful in your DragDrop implementations.

Properties

 
INTERSECT : int
In intersect mode, drag and drop interaction is defined by the overlap of two or more drag and drop objects.
In intersect mode, drag and drop interaction is defined by the overlap of two or more drag and drop objects.
 
POINT : int
In point mode, drag and drop interaction is defined by the location of the cursor during the drag/drop
In point mode, drag and drop interaction is defined by the location of the cursor during the drag/drop
 
clickPixelThresh : int
The number of pixels that the mouse needs to move after the mousedown before the drag is initiated. Default=3;
The number of pixels that the mouse needs to move after the mousedown before the drag is initiated. Default=3;
 
clickTimeThresh : int
The number of milliseconds after the mousedown event to initiate the drag if we don't get a mouseup event. Default=35...
The number of milliseconds after the mousedown event to initiate the drag if we don't get a mouseup event. Default=350
 
mode : int
The current drag and drop mode. Default: POINT
The current drag and drop mode. Default: POINT
 
preventDefault : boolean
Flag to determine if we should prevent the default behavior of the events we define. By default this is true, but thi...
Flag to determine if we should prevent the default behavior of the events we define. By default this is true, but this can be set to false if you need the default behavior (not recommended)
 
stopPropagation : boolean
Flag to determine if we should stop the propagation of the events we generate. This is true by default but you may wa...
Flag to determine if we should stop the propagation of the events we generate. This is true by default but you may want to set it to false if the html element contains other features that require the mouse click.
 
useCache : boolean
Set useCache to false if you want to force object the lookup of each drag and drop linked element constantly during a...
Set useCache to false if you want to force object the lookup of each drag and drop linked element constantly during a drag.

Methods

 
getBestMatch( DragDrop[] dds ) : DragDrop
Helper function for getting the best match from the list of drag and drop objects returned by the drag and drop event...
Helper function for getting the best match from the list of drag and drop objects returned by the drag and drop events when we are in INTERSECT mode. It returns either the first object that the cursor is over, or the object that has the greatest overlap with the dragged element.

Parameters

  • dds : DragDrop[]
    The array of drag and drop objects targeted

Returns

  • DragDrop   The best single match
 
getCss( String id ) : Object
Returns the style property for the DOM element (i.e., document.getElById(id).style)
Returns the style property for the DOM element (i.e., document.getElById(id).style)

Parameters

  • id : String
    the id of the elment to get

Returns

  • Object   The style property of the element
 
getDDById( String id ) : DragDrop
Returns the DragDrop instance for a given id
Returns the DragDrop instance for a given id

Parameters

  • id : String
    the id of the DragDrop object

Returns

  • DragDrop   the drag drop object, null if it is not found
 
getElement( String id ) : Object
Returns the actual DOM element
Returns the actual DOM element

Parameters

  • id : String
    the id of the elment to get

Returns

  • Object   The element
 
getLocation( DragDrop oDD ) : Ext.util.Region
Returns a Region object containing the drag and drop element's position and size, including the padding configured fo...
Returns a Region object containing the drag and drop element's position and size, including the padding configured for it

Parameters

  • oDD : DragDrop
    the drag and drop object to get the location for

Returns

  • Ext.util.Region   a Region object representing the total area the element occupies, including any padding the instance is configured for.
 
getRelated( DragDrop p_oDD, boolean bTargetsOnly ) : DragDrop[]
Returns the drag and drop instances that are in all groups the passed in instance belongs to.
Returns the drag and drop instances that are in all groups the passed in instance belongs to.

Parameters

  • p_oDD : DragDrop
    the obj to get related data for
  • bTargetsOnly : boolean
    if true, only return targetable objs

Returns

  • DragDrop[]   the related instances
 
isDragDrop( String id ) : boolean
Utility function to determine if a given element has been registered as a drag drop item.
Utility function to determine if a given element has been registered as a drag drop item.

Parameters

  • id : String
    the element id to check

Returns

  • boolean   true if this element is a DragDrop item, false otherwise
 
isHandle( String id ) : boolean
Utility function to determine if a given element has been registered as a drag drop handle for the given Drag Drop ob...
Utility function to determine if a given element has been registered as a drag drop handle for the given Drag Drop object.

Parameters

  • id : String
    the element id to check

Returns

  • boolean   true if this element is a DragDrop handle, false otherwise
 
isLegalTarget( DragDrop oDD, DragDrop oTargetDD ) : boolean
Returns true if the specified dd target is a legal target for the specifice drag obj
Returns true if the specified dd target is a legal target for the specifice drag obj

Parameters

  • oDD : DragDrop
    the drag obj
  • oTargetDD : DragDrop
    the target

Returns

  • boolean   true if the target is a legal target for the dd obj
 
isLocked : boolean
Is drag and drop locked?
Is drag and drop locked?
 
isTypeOfDD( Object the ) : boolean
My goal is to be able to transparently determine if an object is typeof DragDrop, and the exact subclass of DragDrop....
My goal is to be able to transparently determine if an object is typeof DragDrop, and the exact subclass of DragDrop. typeof returns "object", oDD.constructor.toString() always returns "DragDrop" and not the name of the subclass. So for now it just evaluates a well-known variable in DragDrop.

Parameters

  • the : Object
    object to evaluate

Returns

  • boolean   true if typeof oDD = DragDrop
 
lock : Void
Lock all drag and drop functionality
Lock all drag and drop functionality
 
refreshCache( Object groups ) : Void
Refreshes the cache of the top-left and bottom-right points of the drag and drop objects in the specified group(s). ...
Refreshes the cache of the top-left and bottom-right points of the drag and drop objects in the specified group(s). This is in the format that is stored in the drag and drop instance, so typical usage is: Ext.dd.DragDropMgr.refreshCache(ddinstance.groups); Alternatively: Ext.dd.DragDropMgr.refreshCache({group1:true, group2:true});

Parameters

  • groups : Object
    an associative array of groups to refresh

Returns

  • Void
 
regDragDrop( DragDrop oDD, String sGroup ) : Void
Each DragDrop instance must be registered with the DragDropMgr. This is executed in DragDrop.init()
Each DragDrop instance must be registered with the DragDropMgr. This is executed in DragDrop.init()

Parameters

  • oDD : DragDrop
    the DragDrop object to register
  • sGroup : String
    the name of the group this element belongs to

Returns

  • Void
 
regHandle( String sDDId, String sHandleId ) : Void
Each DragDrop handle element must be registered. This is done automatically when executing DragDrop.setHandleElId()
Each DragDrop handle element must be registered. This is done automatically when executing DragDrop.setHandleElId()

Parameters

  • sDDId : String
    the DragDrop id this element is a handle for
  • sHandleId : String
    the id of the element that is the drag handle

Returns

  • Void
 
startDrag( x {int}, y {int} ) : Void
Fired when either the drag pixel threshol or the mousedown hold time threshold has been met.
Fired when either the drag pixel threshol or the mousedown hold time threshold has been met.

Parameters

  • {int} : x
    the X position of the original mousedown
  • {int} : y
    the Y position of the original mousedown

Returns

  • Void
 
stopEvent( Event e ) : Void
Utility to stop event propagation and event default, if these features are turned on.
Utility to stop event propagation and event default, if these features are turned on.

Parameters

  • e : Event
    the event as returned by this.getEvent()

Returns

  • Void
 
unlock : Void
Unlock all drag and drop functionality
Unlock all drag and drop functionality
 
verifyEl( HTMLElement el ) : boolean
This checks to make sure an element exists and is in the DOM. The main purpose is to handle cases where innerHTML is...
This checks to make sure an element exists and is in the DOM. The main purpose is to handle cases where innerHTML is used to remove drag and drop objects from the DOM. IE provides an 'unspecified error' when trying to access the offsetParent of such an element

Parameters

  • el : HTMLElement
    the element to check

Returns

  • boolean   true if the element looks usable
© 2011 Sencha Inc.