Package | flash.events |
Class | public class NativeDragEvent |
Inheritance | NativeDragEvent MouseEvent Event Object |
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The initiating object dispatches:
-
nativeDragStart
— When the drag operation begins. -
nativeDragUpdate
— While the drag operation is in progress. -
nativeDragComplete
— When the user releases the dragged item (whether or not the drop was accepted).
The initiating object is the interactive object passed that is to the NativeDragManager object in the call
to NativeDragManager.doDrag()
which began the drag operation.
Potential target interactive objects dispatches:
-
nativeDragEnter
— When the drag gesture passes within the object boundary. -
nativeDragOver
— While the drag gesture remains within the object boundary. -
nativeDragExit
— When the drag gesture leaves the object boundary. -
nativeDragDrop
— When the user releases the dragged item over the object and the object has accepted the drop with an earlier call toNativeDragManager.acceptDragDrop()
.
Typically a handler for the nativeDragEnter
or
nativeDragOver
event evaluates the data being dragged,
along with the drag actions allowed, to determine whether an interactive object
can accept a drop. To specify that an interactive object is an eligible target, the
event handler must call the NativeDragManager.acceptDrop()
function,
passing in a reference to the object. If the user releases
the mouse button over the designated object, the object becomes the drop target and dispatches
the nativeDragDrop
event.
Any InteractiveObject type object can be a drag initiator or a drop target.
Related API Elements
flash.desktop.Clipboard
flash.desktop.NativeDragOptions
flash.desktop.NativeDragActions
flash.display.InteractiveObject
Property | Defined By | ||
---|---|---|---|
allowedActions : NativeDragOptions
The NativeDragOptions object specifying the actions that are allowed by the
display object that initiated this drag operation. | NativeDragEvent | ||
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 | ||
clipboard : Clipboard
The Clipboard object containing the data in this drag operation. | NativeDragEvent | ||
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 | ||
dropAction : String
The current action. | NativeDragEvent | ||
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 |
Method | Defined By | ||
---|---|---|---|
NativeDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, clipboard:Clipboard = null, allowedActions:NativeDragOptions = null, dropAction:String = null, controlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false)
Creates an Event object with specific information relevant to native drag-and-drop events. | NativeDragEvent | ||
[override]
Creates a copy of this NativeDragEvent object. | NativeDragEvent | ||
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | ||
Indicates whether an object has a specified property defined. | Object | ||
Checks whether the preventDefault() method has been called on the event. | Event | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Cancels an event's default behavior if that behavior can be canceled. | Event | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | ||
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Formats the properties of this NativeDragEvent object as a string. | NativeDragEvent | ||
Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified. | MouseEvent | ||
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
NATIVE_DRAG_COMPLETE : String = "nativeDragComplete" [static]
NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the
type property of a nativeDragComplete event object. | NativeDragEvent | ||
NATIVE_DRAG_DROP : String = "nativeDragDrop" [static]
NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type
property of a nativeDragDrop event object. | NativeDragEvent | ||
NATIVE_DRAG_ENTER : String = "nativeDragEnter" [static]
NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the
type property of a nativeDragEnter event object. | NativeDragEvent | ||
NATIVE_DRAG_EXIT : String = "nativeDragExit" [static]
NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type
property of a nativeDragExit event object. | NativeDragEvent | ||
NATIVE_DRAG_OVER : String = "nativeDragOver" [static]
NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type
property of a nativeDragOver event object. | NativeDragEvent | ||
NATIVE_DRAG_START : String = "nativeDragStart" [static]
NativeDragEvent.NATIVE_DRAG_START defines the value of the type
property of a nativeDragStart event object. | NativeDragEvent | ||
NATIVE_DRAG_UPDATE : String = "nativeDragUpdate" [static]
NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the
type property of a nativeDragUpdate event object. | NativeDragEvent |
allowedActions | property |
public var allowedActions:NativeDragOptions
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The NativeDragOptions object specifying the actions that are allowed by the display object that initiated this drag operation.
Related API Elements
clipboard | property |
public var clipboard:Clipboard
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The Clipboard object containing the data in this drag operation.
If the object dispatching the event is not in the same security domain
as the initiating object, then the clipboard can be read only in the handler for
a nativeDragDrop
event.
Related API Elements
dropAction | property |
public var dropAction:String
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
The current action. In the nativeDragComplete
event, the dropAction
property reports the final action.
NativeDragEvent | () | Constructor |
public function NativeDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, localX:Number = NaN, localY:Number = NaN, relatedObject:InteractiveObject = null, clipboard:Clipboard = null, allowedActions:NativeDragOptions = null, dropAction:String = null, controlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false)
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Creates an Event object with specific information relevant to native drag-and-drop events.
Event objects are passed as parameters to event listeners. Dispatching a native drag event does not trigger the associated behavior.
Parameterstype:String — The type of the event. Possible values are:
NativeDragEvent.NATIVE_DRAG_START ,
NativeDragEvent.NATIVE_DRAG_UPDATE ,
NativeDragEvent.NATIVE_DRAG_ENTER ,
NativeDragEvent.NATIVE_DRAG_OVER ,
NativeDragEvent.NATIVE_DRAG_EXIT ,
NativeDragEvent.NATIVE_DRAG_DROP ,
and NativeDragEvent.NATIVE_DRAG_COMPLETE .
| |
bubbles:Boolean (default = false ) — Indicates whether the Event object participates in the bubbling phase of the event flow.
| |
cancelable:Boolean (default = true ) — Indicates whether the Event object can be canceled.
| |
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 ) — The related interactive display object.
| |
clipboard:Clipboard (default = null ) — The Clipboard object containing the data to be transfered.
| |
allowedActions:NativeDragOptions (default = null ) — The NativeDragOptions object defining the allowed actions (move, copy, and link).
| |
dropAction:String (default = null ) — The current action.
| |
controlKey:Boolean (default = false ) — Indicates whether the Control key is activated.
| |
altKey:Boolean (default = false ) — Indicates whether the Alt key is activated.
| |
shiftKey:Boolean (default = false ) — Indicates whether the Shift key is activated.
| |
commandKey:Boolean (default = false ) — Indicates whether the Command key is activated.
|
clone | () | method |
toString | () | method |
override public function toString():String
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
Formats the properties of this NativeDragEvent object as a string.
The string is in the following format:
[NativeDragEvent type=value bubbles=value cancelable=value ... commandKey=value]
String — The properties of this NativeDragEvent as a string.
|
NATIVE_DRAG_COMPLETE | Constant |
public static const NATIVE_DRAG_COMPLETE:String = "nativeDragComplete"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the
type
property of a nativeDragComplete
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | false ; there is no default behavior to cancel. |
clipboard | The Clipboard object containing the dragged data. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
NATIVE_DRAG_DROP | Constant |
public static const NATIVE_DRAG_DROP:String = "nativeDragDrop"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type
property of a nativeDragDrop
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | true ; canceling this event cancels the drag operation. |
clipboard | The Clipboard object containing the dragged data. The clipboard can be read even if the object dispatching this event is not in the same security domain as the initiator. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
NATIVE_DRAG_ENTER | Constant |
public static const NATIVE_DRAG_ENTER:String = "nativeDragEnter"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the
type
property of a nativeDragEnter
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | false ; there is no default behavior to cancel. |
clipboard | The Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
NATIVE_DRAG_EXIT | Constant |
public static const NATIVE_DRAG_EXIT:String = "nativeDragExit"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type
property of a nativeDragExit
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | false ; there is no default behavior to cancel. |
clipboard | The Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
NATIVE_DRAG_OVER | Constant |
public static const NATIVE_DRAG_OVER:String = "nativeDragOver"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type
property of a nativeDragOver
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | true ; canceling this event cancels the drag operation. |
clipboard | The Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
NATIVE_DRAG_START | Constant |
public static const NATIVE_DRAG_START:String = "nativeDragStart"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_START defines the value of the type
property of a nativeDragStart
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | true ; canceling this event cancels the drag operation. |
clipboard | The Clipboard object containing the dragged data. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
NATIVE_DRAG_UPDATE | Constant |
public static const NATIVE_DRAG_UPDATE:String = "nativeDragUpdate"
Language Version: | ActionScript 3.0 |
Runtime Versions: | AIR 1.0 |
NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the
type
property of a nativeDragUpdate
event object.
This event has the following properties:
Property | Value |
---|---|
allowedActions | The NativeDragOptions object specifying the actions relevant to this drag operation. |
bubbles | true |
cancelable | false ; there is no default behavior to cancel. |
clipboard | The Clipboard object containing the dragged data. |
dropAction | The action chosen by the drop target (or none if no action was set). |
Related API Elements
Thu Dec 6 2018, 01:12 PM -08:00