mx.events

# InterDragManagerEvent - AS3 Flex

Package | mx.events
Class | public class InterDragManagerEvent
Inheritance | InterDragManagerEvent DragEvent MouseEvent Event 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

Manually dispatching events

Learn more

About Flex events

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | action : String The requested action. | DragEvent
|  | 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
|  | dragEventType : String The event type for the DragEvent to be used by the receiving DragManager when creating the marshaled DragEvent. | InterDragManagerEvent
|  | 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
|  | dropTarget : DisplayObject The potential drop target in the other ApplicationDomain (which is why it is a DisplayObject and not some other class). | InterDragManagerEvent
|  | 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
--- | --- | ---
|  | 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
|  | 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
--- | --- | ---
|  | 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

mx.events.DragEvent

### 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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00