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

InterDragManagerEvent  - AS3 Flex

Packagemx.events
Classpublic class InterDragManagerEvent
InheritanceInterDragManagerEvent Inheritance DragEvent Inheritance MouseEvent Inheritance Event Inheritance Object

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

An event sent between DragManagers that are in separate but trusted ApplicationDomains to handle the dispatching of DragEvents to the drag targets. One DragManager has a DragProxy that moves with the mouse and looks for changes to the dropTarget. It cannot directly dispatch the DragEvent to a potential target in another ApplicationDomain because code in that ApplicationDomain would not type-match on DragEvent. Instead, the DragManager dispatches a InterDragManagerEvent that the other ApplicationDomain's DragManager listens for and it marshals the DragEvent and dispatches it to the potential dropTarget.

More examples

Learn more



Public Properties
 PropertyDefined By
 Inheritedaction : 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
  dragEventType : String
The event type for the DragEvent to be used by the receiving DragManager when creating the marshaled DragEvent.
InterDragManagerEvent
 InheriteddraggedItem : Object
If the dragInitiator property contains an IAutomationObject object, this property contains the child IAutomationObject object near the mouse cursor.
DragEvent
 InheriteddragInitiator : IUIComponent
The component that initiated the drag.
DragEvent
 InheriteddragSource : DragSource
The DragSource object containing the data being dragged.
DragEvent
  dropTarget : DisplayObject
The potential drop target in the other ApplicationDomain (which is why it is a DisplayObject and not some other class).
InterDragManagerEvent
 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
  
InterDragManagerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, dropTarget:DisplayObject = null, dragEventType:String = null, dragInitiator:IUIComponent = null, dragSource:DragSource = null, action:String = null, draggedItem:Object = null)
Constructor.
InterDragManagerEvent
 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
  DISPATCH_DRAG_EVENT : String = "dispatchDragEvent"
[static] Dispatch a DragEvent event to a target in another ApplicationDomain.
InterDragManagerEvent
Property Detail

dragEventType

property
public var dragEventType:String

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

The event type for the DragEvent to be used by the receiving DragManager when creating the marshaled DragEvent.

Related API Elements

dropTarget

property 
public var dropTarget:DisplayObject

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

The potential drop target in the other ApplicationDomain (which is why it is a DisplayObject and not some other class).

Constructor Detail

InterDragManagerEvent

()Constructor
public function InterDragManagerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, dropTarget:DisplayObject = null, dragEventType:String = null, dragInitiator:IUIComponent = null, dragSource:DragSource = null, action:String = null, draggedItem:Object = null)

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

Constructor.

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 = false) — Specifies whether the behavior associated with the event can be prevented.
 
localX:Number (default = NaN) — The horizontal coordinate at which the event occurred relative to the containing sprite.
 
localY:Number (default = NaN) — The vertical coordinate at which the event occurred relative to the containing sprite.
 
relatedObject:InteractiveObject (default = null) — A reference to a display list object that is related to the event.
 
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.
 
buttonDown:Boolean (default = false) — Indicates whether the primary mouse button is pressed (true) or not (false).
 
delta:int (default = 0) — Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.
 
dropTarget:DisplayObject (default = null) — The potential drop target in the other application domain (which is why it is a DisplayObject and not some other class).
 
dragEventType:String (default = null) — The event type for the DragEvent to be used by the receiving DragManager when creating the marshaled DragEvent.
 
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.
 
draggedItem:Object (default = null) — An object representing the item that was dragged.
Constant Detail

DISPATCH_DRAG_EVENT

Constant
public static const DISPATCH_DRAG_EVENT:String = "dispatchDragEvent"

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

Dispatch a DragEvent event to a target in another ApplicationDomain. The receiving DragManager marshals the DragEvent and dispatches it to the target specified in the dropTarget property.