flash.events.NativeDragEvent - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.events
Class	public class NativeDragEvent
Inheritance	NativeDragEvent MouseEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Native drag events are dispatched by the interactive objects involved in a drag-and-drop operation.

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 to NativeDragManager.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.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	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 The horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number The vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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
		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
		clone():Event [override] Creates a copy of this NativeDragEvent object.	NativeDragEvent
		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] Formats the properties of this NativeDragEvent object as a string.	NativeDragEvent
		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
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLICK : String = "click" [static] Defines the value of the type property of a click event object.	MouseEvent
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		CONTEXT_MENU : String = "contextMenu" [static] The MouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object.	MouseEvent
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		DOUBLE_CLICK : String = "doubleClick" [static] Defines the value of the type property of a doubleClick event object.	MouseEvent
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MIDDLE_CLICK : String = "middleClick" [static] Defines the value of the type property of a middleClick event object.	MouseEvent
		MIDDLE_MOUSE_DOWN : String = "middleMouseDown" [static] Defines the value of the type property of a middleMouseDown event object.	MouseEvent
		MIDDLE_MOUSE_UP : String = "middleMouseUp" [static] Defines the value of the type property of a middleMouseUp event object.	MouseEvent
		MOUSE_DOWN : String = "mouseDown" [static] Defines the value of the type property of a mouseDown event object.	MouseEvent
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		MOUSE_MOVE : String = "mouseMove" [static] Defines the value of the type property of a mouseMove event object.	MouseEvent
		MOUSE_OUT : String = "mouseOut" [static] Defines the value of the type property of a mouseOut event object.	MouseEvent
		MOUSE_OVER : String = "mouseOver" [static] Defines the value of the type property of a mouseOver event object.	MouseEvent
		MOUSE_UP : String = "mouseUp" [static] Defines the value of the type property of a mouseUp event object.	MouseEvent
		MOUSE_WHEEL : String = "mouseWheel" [static] Defines the value of the type property of a mouseWheel event object.	MouseEvent
		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
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		RIGHT_CLICK : String = "rightClick" [static] Defines the value of the type property of a rightClick event object.	MouseEvent
		RIGHT_MOUSE_DOWN : String = "rightMouseDown" [static] Defines the value of the type property of a rightMouseDown event object.	MouseEvent
		RIGHT_MOUSE_UP : String = "rightMouseUp" [static] Defines the value of the type property of a rightMouseUp event object.	MouseEvent
		ROLL_OUT : String = "rollOut" [static] Defines the value of the type property of a rollOut event object.	MouseEvent
		ROLL_OVER : String = "rollOver" [static] Defines the value of the type property of a rollOver event object.	MouseEvent
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.	Event
		STANDARD_INPUT_CLOSE : String = "standardInputClose" [static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.	Event
		STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

Property Detail

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.

See also

flash.desktop.NativeDragOptions

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.

See also

flash.desktop.Clipboard

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.

Constructor Detail

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.

Parameters

	`type: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.

Method Detail

clone

()

method

override public function clone():Event

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Creates a copy of this NativeDragEvent object.

Returns

Event — A new NativeDragEvent object with property values that match those of the original.

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]

Returns

String — The properties of this NativeDragEvent as a string.

Constant Detail

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

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

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

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

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

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

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