Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
InterDragManagerEvent

Package | mx.events
Class | public class InterDragManagerEvent
Inheritance | InterDragManagerEvent DragEvent flash.events.MouseEvent

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.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | action : String The requested action. | DragEvent
|  | 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

Public Methods

| Method | Defined By
--- | --- | ---
|  | InterDragManagerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number, localY:Number, 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

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

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.

See also

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, localY:Number, 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.

Sun Mar 5 2017, 03:42 PM +11:00