ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

DragEvent  - AS3 Flex

Packagemx.events
Classpublic class DragEvent
InheritanceDragEvent Inheritance MouseEvent Inheritance Event Inheritance Object
Subclasses InterDragManagerEvent

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent class represents event objects that are dispatched as part of a drag-and-drop operation.

More examples

Learn more

Related API Elements



Public Properties
 PropertyDefined By
  action : String
The requested action.
DragEvent
 InheritedaltKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false).
MouseEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 InheritedbuttonDown : Boolean
Indicates whether the primary mouse button is pressed (true) or not (false).
MouseEvent
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 InheritedclickCount : int
[read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.
MouseEvent
 InheritedcommandKey : Boolean
Indicates whether the command key is activated (Mac only.) The value of property commandKey will have the same value as property ctrlKey on the Mac.
MouseEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontrolKey : Boolean
Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
MouseEvent
 InheritedctrlKey : Boolean
On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
MouseEvent
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 Inheriteddelta : int
Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.
MouseEvent
  draggedItem : Object
If the dragInitiator property contains an IAutomationObject object, this property contains the child IAutomationObject object near the mouse cursor.
DragEvent
  dragInitiator : IUIComponent
The component that initiated the drag.
DragEvent
  dragSource : DragSource
The DragSource object containing the data being dragged.
DragEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 InheritedisRelatedObjectInaccessible : Boolean
If true, the relatedObject property is set to null for reasons related to security sandboxes.
MouseEvent
 InheritedlocalX : Number
When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedlocalY : Number
When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedmovementX : Number
When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event.
MouseEvent
 InheritedmovementY : Number
When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event.
MouseEvent
 InheritedrelatedObject : InteractiveObject
A reference to a display list object that is related to the event.
MouseEvent
 InheritedshiftKey : Boolean
Indicates whether the Shift key is active (true) or inactive (false).
MouseEvent
 InheritedstageX : Number
[read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 InheritedstageY : Number
[read-only] The vertical coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
DragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, dragInitiator:IUIComponent = null, dragSource:DragSource = null, action:String = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
Constructor.
DragEvent
 Inherited
[override] Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
MouseEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string that contains all the properties of the MouseEvent object.
MouseEvent
 Inherited
Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
MouseEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DRAG_COMPLETE : String = "dragComplete"
[static] The DragEvent.DRAG_COMPLETE constant defines the value of the type property of the event object for a dragComplete event.
DragEvent
  DRAG_DROP : String = "dragDrop"
[static] The DragEvent.DRAG_DROP constant defines the value of the type property of the event object for a dragDrop event.
DragEvent
  DRAG_ENTER : String = "dragEnter"
[static] The DragEvent.DRAG_ENTER constant defines the value of the type property of the event object for a dragEnter event.
DragEvent
  DRAG_EXIT : String = "dragExit"
[static] The DragEvent.DRAG_EXIT constant defines the value of the type property of the event object for a dragExit event.
DragEvent
  DRAG_OVER : String = "dragOver"
[static] The DragEvent.DRAG_OVER constant defines the value of the type property of the event object for a dragOver event.
DragEvent
  DRAG_START : String = "dragStart"
[static] The DragEvent.DRAG_START constant defines the value of the type property of the event object for a dragStart event.
DragEvent
Property Detail

action

property
public var action:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The requested action. One of DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.

draggedItem

property 
public var draggedItem:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

If the dragInitiator property contains an IAutomationObject object, this property contains the child IAutomationObject object near the mouse cursor. If the dragInitiator property does not contain an IAutomationObject object, this proprty is null.

dragInitiator

property 
public var dragInitiator:IUIComponent

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The component that initiated the drag.

dragSource

property 
public var dragSource:DragSource

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragSource object containing the data being dragged.

Constructor Detail

DragEvent

()Constructor
public function DragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, dragInitiator:IUIComponent = null, dragSource:DragSource = null, action:String = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor. Normally called by the Flex control and not used in application code.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = true) — Specifies whether the behavior associated with the event can be prevented.
 
dragInitiator:IUIComponent (default = null) — IUIComponent that specifies the component initiating the drag.
 
dragSource:DragSource (default = null) — A DragSource object containing the data being dragged.
 
action:String (default = null) — The specified drop action, such as DragManager.MOVE.
 
ctrlKey:Boolean (default = false) — Indicates whether the Ctrl key was pressed.
 
altKey:Boolean (default = false) — Indicates whether the Alt key was pressed.
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key was pressed.
Constant Detail

DRAG_COMPLETE

Constant
public static const DRAG_COMPLETE:String = "dragComplete"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent.DRAG_COMPLETE constant defines the value of the type property of the event object for a dragComplete event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DRAG_DROP

Constant 
public static const DRAG_DROP:String = "dragDrop"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent.DRAG_DROP constant defines the value of the type property of the event object for a dragDrop event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DRAG_ENTER

Constant 
public static const DRAG_ENTER:String = "dragEnter"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent.DRAG_ENTER constant defines the value of the type property of the event object for a dragEnter event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event, which is always DragManager.MOVE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DRAG_EXIT

Constant 
public static const DRAG_EXIT:String = "dragExit"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent.DRAG_EXIT constant defines the value of the type property of the event object for a dragExit event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DRAG_OVER

Constant 
public static const DRAG_OVER:String = "dragOver"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent.DRAG_OVER constant defines the value of the type property of the event object for a dragOver event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DRAG_START

Constant 
public static const DRAG_START:String = "dragStart"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DragEvent.DRAG_START constant defines the value of the type property of the event object for a dragStart event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.