Adobe Flex 2 Language Reference - collected by Jimbob | Back to MY RESOURCES


(Flex 2 Plug-in for Mercury Quick Test Pro)
Packagemx.automation.events
Classpublic class AutomationDragEvent
InheritanceAutomationDragEvent Inheritance MouseEvent Inheritance Event Inheritance Object

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

See also

mx.managers.DragManager
mx.core.UIComponent


Public Properties
 PropertyDefined by
  action : String
The requested action.
AutomationDragEvent
 InheritedaltKey : Boolean
Reserved for future use.
MouseEvent
 Inheritedbubbles : Boolean
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
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedctrlKey : Boolean
Indicates whether the Control key is active (true) or inactive (false).
MouseEvent
 InheritedcurrentTarget : Object
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 : IAutomationObject
Contains the child IAutomationObject object being dragged.
AutomationDragEvent
  dropParent : IAutomationObject
The IAutomationObject object which will be parenting the dropped item.
AutomationDragEvent
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 InheritedlocalX : Number
The horizontal coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedlocalY : Number
The vertical coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
The horizontal coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 InheritedstageY : Number
The vertical coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
AutomationDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, action:String = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)
Constructor.
AutomationDragEvent
 Inherited
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 your custom Event class.
Event
 Inherited
Checks whether preventDefault() has been called on the event.
Event
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
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 a string that contains all the properties of the MouseEvent object.
MouseEvent
 Inherited
Instructs Flash Player 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
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLICK : String = "click"
[static] Defines the value of the type property of a click event object.
MouseEvent
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCLOSING : String = "closing"
[static] Defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedDOM_INITIALIZE : String = "domInitialize"
[static] Defines the value of the type property of a domInitialize event object.
Event
 InheritedDOUBLE_CLICK : String = "doubleClick"
[static] Defines the value of the type property of a doubleClick event object.
MouseEvent
  DRAG_COMPLETE : String = "dragComplete"
[static] The AutomationDragEvent.DRAG_COMPLETE constant defines the value of the type property of the event object for a dragComplete event.
AutomationDragEvent
  DRAG_DROP : String = "dragDrop"
[static] The AutomationDragEvent.DRAG_DROP constant defines the value of the type property of the event object for a dragDrop event.
AutomationDragEvent
  DRAG_START : String = "dragStart"
[static] The AutomationDragEvent.DRAG_START constant defines the value of the type property of the event object for a dragStart event.
AutomationDragEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] Defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] Defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] Defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_DOWN : String = "mouseDown"
[static] Defines the value of the type property of a mouseDown event object.
MouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedMOUSE_MOVE : String = "mouseMove"
[static] Defines the value of the type property of a mouseMove event object.
MouseEvent
 InheritedMOUSE_OUT : String = "mouseOut"
[static] Defines the value of the type property of a mouseOut event object.
MouseEvent
 InheritedMOUSE_OVER : String = "mouseOver"
[static] Defines the value of the type property of a mouseOver event object.
MouseEvent
 InheritedMOUSE_UP : String = "mouseUp"
[static] Defines the value of the type property of a mouseUp event object.
MouseEvent
 InheritedMOUSE_WHEEL : String = "mouseWheel"
[static] Defines the value of the type property of a mouseWheel event object.
MouseEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] Defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedROLL_OUT : String = "rollOut"
[static] Defines the value of the type property of a rollOut event object.
MouseEvent
 InheritedROLL_OVER : String = "rollOver"
[static] Defines the value of the type property of a rollOver event object.
MouseEvent
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
actionproperty
public var action:String

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

See also

draggedItemproperty 
public var draggedItem:IAutomationObject

Contains the child IAutomationObject object being dragged.

dropParentproperty 
public var dropParent:IAutomationObject

The IAutomationObject object which will be parenting the dropped item.

Constructor detail
AutomationDragEvent()constructor
public function AutomationDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, action:String = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false)

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 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_COMPLETEconstant
public static const DRAG_COMPLETE:String = "dragComplete"

The AutomationDragEvent.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
altKey Indicates whether the Alt key is down (true) or not (false).
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelabletrue
ctrlKey Indicates whether the Control key is down (true) or not (false).
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.
draggedItemThe item being dragged.
dropParentThe object which will be parenting the item dropped.
shiftKey Indicates whether the Shift key is down (true) or not (false).
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_DROPconstant 
public static const DRAG_DROP:String = "dragDrop"

The AutomationDragEvent.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
altKey Indicates whether the Alt key is down (true) or not (false).
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelabletrue
ctrlKey Indicates whether the Control key is down (true) or not (false).
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.
draggedItemThe item being dragged.
dropParentThe object which will be parenting the item dropped.
shiftKey Indicates whether the Shift key is down (true) or not (false).
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_STARTconstant 
public static const DRAG_START:String = "dragStart"

The AutomationDragEvent.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
altKey Indicates whether the Alt key is down (true) or not (false).
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelabletrue
ctrlKey Indicates whether the Control key is down (true) or not (false).
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.
draggedItemThe item being dragged.
dropParentThe object which will be parenting the item dropped.
shiftKey Indicates whether the Shift key is down (true) or not (false).
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.





collected by Jimbob 2007.05