| Package | mx.managers |
| Class | public class DragManager |
| Inheritance | DragManager  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
All methods and properties of the DragManager are static, so you do not need to create an instance of it.
All Flex components support drag and drop operations. Flex provides additional support for drag and drop to the List, Tree, and DataGrid controls.
When the user selects an item with the mouse, the selected component is called the drag initiator. The image displayed during the drag operation is called the drag proxy.
When the user moves the drag proxy over another component,
the dragEnter event is sent to that component.
If the component accepts the drag, it becomes the drop target
and receives dragOver, dragExit,
and dragDrop events.
When the drag is complete, a dragComplete event
is sent to the drag initiator.
Learn more
Dragging and dropping in multi-versioned applications
About drag and drop
The drag-and-drop operation
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| isDragging : Boolean [static] [read-only]
Read-only property that returns true
if a drag is in progress. | DragManager | ||
| Method | Defined By | ||
|---|---|---|---|
[static]
Call this method from your dragEnter event handler if you accept
the drag/drop data. | DragManager | ||
doDrag(dragInitiator:IUIComponent, dragSource:DragSource, mouseEvent:MouseEvent, dragImage:IFlexDisplayObject = null, xOffset:Number = 0, yOffset:Number = 0, imageAlpha:Number = 0.5, allowMove:Boolean = true):void [static]
Initiates a drag and drop operation. | DragManager | ||
[static]
Returns the current drag and drop feedback. | DragManager | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
[static]
Sets the feedback indicator for the drag and drop operation. | DragManager | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
| Style | Description | Defined By | ||
|---|---|---|---|---|
copyCursor | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Cursor displayed during a copy operation. The default value is the "mx.skins.cursor.DragCopy" symbol in the Assets.swf file. | DragManager | ||
defaultDragImageSkin | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the default drag image, which is also called the drag proxy. The default value is mx.skins.halo.DefaultDragImage (for both Halo and Spark themes). | DragManager | ||
linkCursor | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Cursor displayed during a link operation. The default value is the "mx.skins.cursor.DragLink" symbol in the Assets.swf file. | DragManager | ||
moveCursor | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Cursor displayed during a move operation. The default value is the "mx.skins.cursor.DragMove" symbol in the Assets.swf file. | DragManager | ||
rejectCursor | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Cursor displayed for a reject operation. The default value is the "mx.skins.cursor.DragReject" symbol in the Assets.swf file. | DragManager | ||
| Constant | Defined By | ||
|---|---|---|---|
| COPY : String = "copy" [static]
Constant that specifies that the type of drag action is "copy". | DragManager | ||
| LINK : String = "link" [static]
Constant that specifies that the type of drag action is "link". | DragManager | ||
| MOVE : String = "move" [static]
Constant that specifies that the type of drag action is "move". | DragManager | ||
| NONE : String = "none" [static]
Constant that specifies that the type of drag action is "none". | DragManager | ||
isDragging | property |
acceptDragDrop | () | method |
public static function acceptDragDrop(target:IUIComponent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Call this method from your dragEnter event handler if you accept
the drag/drop data.
Typically, you cast event.target to the data type of the drop target.
In the following example, the drop target is an MX Canvas container:
DragManager.acceptDragDrop(Canvas(event.target));
Parameters
target:IUIComponent — The drop target accepting the drag.
|
doDrag | () | method |
public static function doDrag(dragInitiator:IUIComponent, dragSource:DragSource, mouseEvent:MouseEvent, dragImage:IFlexDisplayObject = null, xOffset:Number = 0, yOffset:Number = 0, imageAlpha:Number = 0.5, allowMove:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initiates a drag and drop operation.
Parameters
dragInitiator:IUIComponent — IUIComponent that specifies the component initiating
the drag.
| |
dragSource:DragSource — DragSource object that contains the data
being dragged.
| |
mouseEvent:MouseEvent — The MouseEvent that contains the mouse information
for the start of the drag.
| |
dragImage:IFlexDisplayObject (default = null) | |
xOffset:Number (default = 0)dragImage. This argument is optional. If omitted, the drag proxy
is shown at the upper-left corner of the drag initiator. The offset is expressed
in pixels from the left edge of the drag proxy to the left edge of the drag
initiator, and is usually a negative number.
| |
yOffset:Number (default = 0)dragImage. This argument is optional. If omitted, the drag proxy
is shown at the upper-left corner of the drag initiator. The offset is expressed
in pixels from the top edge of the drag proxy to the top edge of the drag
initiator, and is usually a negative number.
| |
imageAlpha:Number (default = 0.5) | |
allowMove:Boolean (default = true) |
getFeedback | () | method |
public static function getFeedback():String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the current drag and drop feedback.
ReturnsString — Possible return values are DragManager.COPY,
DragManager.MOVE,
DragManager.LINK, or DragManager.NONE.
|
showFeedback | () | method |
public static function showFeedback(feedback:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the feedback indicator for the drag and drop operation.
Possible values are DragManager.COPY, DragManager.MOVE,
DragManager.LINK, or DragManager.NONE.
Parameters
feedback:String — The type of feedback indicator to display.
|
COPY | Constant |
public static const COPY:String = "copy"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constant that specifies that the type of drag action is "copy".
LINK | Constant |
public static const LINK:String = "link"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constant that specifies that the type of drag action is "link".
MOVE | Constant |
public static const MOVE:String = "move"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constant that specifies that the type of drag action is "move".
NONE | Constant |
public static const NONE:String = "none"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constant that specifies that the type of drag action is "none".
Mon Apr 10 2017, 12:28 PM -07:00