AutomationDragEvent

Package	mx.automation.events
Class	public class AutomationDragEvent
Inheritance	AutomationDragEvent MouseEvent Event Object
Subclasses	AutomationDragEventWithPositionInfo

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Learn more

Instrumenting events

Related API Elements

mx.managers.DragManager
mx.core.UIComponent

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		action : String The requested action.	AutomationDragEvent
		altKey : Boolean Indicates whether the Alt key is active (true) or inactive (false).	MouseEvent
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		buttonDown : Boolean Indicates whether the primary mouse button is pressed (true) or not (false).	MouseEvent
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		clickCount : int [read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.	MouseEvent
		commandKey : 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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		controlKey : Boolean Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.	MouseEvent
		ctrlKey : Boolean On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).	MouseEvent
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		delta : int Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.	MouseEvent
		draggedItem : IAutomationObject Contains the child IAutomationObject object that is being dragged.	AutomationDragEvent
		dropParent : IAutomationObject The IAutomationObject object that is the parent of the dropped item.	AutomationDragEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		isRelatedObjectInaccessible : Boolean If true, the relatedObject property is set to null for reasons related to security sandboxes.	MouseEvent
		localX : Number When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		movementX : Number When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event.	MouseEvent
		movementY : Number When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event.	MouseEvent
		relatedObject : InteractiveObject A reference to a display list object that is related to the event.	MouseEvent
		shiftKey : Boolean Indicates whether the Shift key is active (true) or inactive (false).	MouseEvent
		stageX : Number [read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		stageY : Number [read-only] The vertical coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AutomationDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, action:String = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false) Constructor.	AutomationDragEvent
		clone():Event [override] Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.	MouseEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the MouseEvent object.	MouseEvent
		updateAfterEvent():void Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.	MouseEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		DRAG_COMPLETE : String = "dragComplete" [static] Defines the value of the type property of the event object for a dragComplete event.	AutomationDragEvent
		DRAG_DROP : String = "dragDrop" [static] Defines the value of the type property of the event object for a dragDrop event.	AutomationDragEvent
		DRAG_START : String = "dragStart" [static] Defines the value of the type property of the event object for a dragStart event.	AutomationDragEvent

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.

Related API Elements

mx.managers.DragManager

draggedItem

property

public var draggedItem:IAutomationObject

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Contains the child IAutomationObject object that is being dragged.

dropParent

property

public var dropParent:IAutomationObject

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The IAutomationObject object that is the parent of the dropped item.

Constructor Detail

()

Constructor

public function AutomationDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, 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.

	`action:String` (default = `null`) — The specified drop action, such as `DragManager.MOVE`.

	`ctrlKey:Boolean` (default = `false`) — Indicates whether the Control 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

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:

Property	Value
`altKey`	Indicates whether the Alt key is down (`true`) or not (`false`).
`action`	The action that caused the event: `DragManager.COPY`, `DragManager.LINK`, `DragManager.MOVE`, or `DragManager.NONE`.
`bubbles`	`false`
`cancelable`	`true`
`ctrlKey`	Indicates whether the Control key is down (`true`) or not (`false`).
`currentTarget`	The 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 `currentTarget`.
`draggedItem`	The item being dragged.
`dropParent`	The object that parents the item that was dropped.
`shiftKey`	Indicates whether the Shift key is down (`true`) or not (`false`).
`target`	The object that dispatched the event; it is not always the object that listens 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

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:

Property	Value
`altKey`	Indicates whether the Alt key is down (`true`) or not (`false`).
`action`	The action that caused the event: `DragManager.COPY`, `DragManager.LINK`, `DragManager.MOVE`, or `DragManager.NONE`.
`bubbles`	`false`
`cancelable`	`true`
`ctrlKey`	Indicates whether the Control key is down (`true`) or not (`false`).
`currentTarget`	The 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 `currentTarget`.
`draggedItem`	The item being dragged.
`dropParent`	The object that parents the item that was dropped.
`shiftKey`	Indicates whether the Shift key is down (`true`) or not (`false`).
`target`	The object that dispatched the event; it is not always the object that listens for the event. Use the `currentTarget` property to always access the object that is 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

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:

Property	Value
`altKey`	Indicates whether the Alt key is down (`true`) or not (`false`).
`action`	The action that caused the event: `DragManager.COPY`, `DragManager.LINK`, `DragManager.MOVE`, or `DragManager.NONE`.
`bubbles`	`false`
`cancelable`	`true`
`ctrlKey`	Indicates whether the Control key is down (`true`) or not (`false`).
`currentTarget`	The 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 `currentTarget`.
`draggedItem`	The item being dragged.
`dropParent`	The object that parents the item that was dropped.
`shiftKey`	Indicates whether the Shift key is down (`true`) or not (`false`).
`target`	The object that dispatched the event; it is not always the object that listens for the event. Use the `currentTarget` property to always access the object that is listening for the event.

AutomationDragEvent - AS3 Flex

Classes x

action

draggedItem

dropParent