flash.events

# MouseEvent - AS3

Package | flash.events
Class | public class MouseEvent
Inheritance | MouseEvent Event Object
Subclasses | AutomationDragEvent, ChartEvent, ChartItemEvent, DragEvent, FlexMouseEvent, GridEvent, LegendMouseEvent, ListEvent, MosaicDragEvent, NativeDragEvent, ScreenMouseEvent

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

A MouseEvent object is dispatched into the event flow whenever mouse events occur. A mouse event is usually generated by a user input device, such as a mouse or a trackball, that uses a pointer.

When nested nodes are involved, mouse events target the deepest possible nested node that is visible in the display list. This node is called the target node. To have a target node's ancestor receive notification of a mouse event, use `EventDispatcher.addEventListener()` on the ancestor node with the `type` parameter set to the specific mouse event you want to detect.

View the examples

More examples

Handling keyboard-related mouse events
Dragging Sprites around the stage
Customizing the mouse cursor
Mouse input example: WordSearch

Learn more

Capturing mouse input

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | 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
|  | 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
--- | --- | ---
|  | MouseEvent(type:String, bubbles:Boolean = true, 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, commandKey:Boolean = false, controlKey:Boolean = false, clickCount:int = 0)
Creates an Event object that contains information about mouse events.
MouseEvent
|  | 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
--- | --- | ---
|  | CLICK : String = "click" [static] Defines the value of the type property of a click event object. | MouseEvent
|  | CONTEXT_MENU : String = "contextMenu" [static] The MouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object. | MouseEvent
|  | DOUBLE_CLICK : String = "doubleClick" [static] Defines the value of the type property of a doubleClick event object. | MouseEvent
|  | 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_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
|  | RELEASE_OUTSIDE : String = "releaseOutside" [static] Defines the value of the type property of a releaseOutside event object. | MouseEvent
|  | 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

Property Detail

### altKey

property

`altKey:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Indicates whether the Alt key is active (`true`) or inactive (`false`). Supported for Windows only. On other operating systems, this property is always set to `false`.

Implementation
`public function get altKey():Boolean`
`public function set altKey(value:Boolean):void`

### buttonDown

property

`buttonDown:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Indicates whether the primary mouse button is pressed (`true`) or not (`false`).

Implementation
`public function get buttonDown():Boolean`
`public function set buttonDown(value:Boolean):void`

### clickCount

property

`clickCount:int` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Lite 4

Indicates whether or not the mouse down event is part of a multi-click sequence. This parameter will be zero for all mouse events other than `MouseEvent.mouseDown`, `MouseEvent.mouseUp`, `MouseEvent.middleMouseDown`, `MouseEvent.middleMouseUp`, `MouseEvent.rightMouseDown`, and `MouseEvent.rightMouseUp`. Listening for single clicks, double clicks, or any multi-click sequence is possible with the `clickCount` parameter. For example, an initial `MouseEvent.mouseDown` and `MouseEvent.mouseUp` will have a `clickCount` of 1, and the second `MouseEvent.mouseDown` and `MouseEvent.mouseUp` in a double-click sequence will have a `clickCount` of 2. If the mouse moves sufficiently or the multi-click sequence is interrupted for some reason, then the next `MouseEvent.mouseDown` will have a clickCount of 1. The doubleClick event will continue to fire as expected.

Implementation
`public function get clickCount():int`

### commandKey

property

`commandKey:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Lite 4

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. Always false on Windows or Linux.

Implementation
`public function get commandKey():Boolean`
`public function set commandKey(value:Boolean):void`

### controlKey

property

`controlKey:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Lite 4

Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.

Implementation
`public function get controlKey():Boolean`
`public function set controlKey(value:Boolean):void`

### ctrlKey

property

`ctrlKey:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

On Windows or Linux, indicates whether the Ctrl key is active (`true`) or inactive (`false`). On Macintosh, indicates whether either the Control key or the Command key is activated.

Implementation
`public function get ctrlKey():Boolean`
`public function set ctrlKey(value:Boolean):void`

### delta

property

`delta:int`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This setting depends on the device and operating system and is usually configurable by the user. This property applies only to the `MouseEvent.mouseWheel` event.

Implementation
`public function get delta():int`
`public function set delta(value:int):void`

### isRelatedObjectInaccessible

property

`isRelatedObjectInaccessible:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 10, Flash Lite 4

If `true`, the `relatedObject` property is set to `null` for reasons related to security sandboxes. If the nominal value of `relatedObject` is a reference to a DisplayObject in another sandbox, `relatedObject` is set to `null` unless there is permission in both directions across this sandbox boundary. Permission is established by calling `Security.allowDomain()` from a SWF file, or by providing a policy file from the server of an image file, and setting the `LoaderContext.checkPolicyFile` property when loading the image.

Implementation
`public function get isRelatedObjectInaccessible():Boolean`
`public function set isRelatedObjectInaccessible(value:Boolean):void`

Related API Elements

MouseEvent.relatedObject
Security.allowDomain()
LoaderContext.checkPolicyFile

### localX

property

`localX:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite. Disable mouse locking by setting `Stage.mouseLock` to `false`.

When mouse locking is enabled, `localX` and `localY` are 0. Use `movementX` and `movementY` to determine the changes to mouse position when mouse locking is enabled.

Implementation
`public function get localX():Number`
`public function set localX(value:Number):void`

Related API Elements

flash.display.Stage.mouseLock
movementX
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

### localY

property

`localY:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite. Disable mouse locking by setting `Stage.mouseLock` to `false`.

When mouse locking is enabled, `localX` and `localY` are 0. Use `movementX` and `movementY` to determine the changes to mouse position when mouse locking is enabled.

Implementation
`public function get localY():Number`
`public function set localY(value:Number):void`

Related API Elements

flash.display.Stage.mouseLock
movementY
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

### movementX

property

`movementX:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 11.2, AIR 3.2

When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event. Enable mouse locking by setting `Stage.mouseLock` to `true`.

When mouse locking is enabled:

- `localX` and `localY` contain 0.
- `movementX` and `movementY` contain delta values.
- `movementX` and `movementY` are never transformed based on stage transformation. That means they always remain in screen coordinates.

`movementX` and `movementY` are 0 when `Stage.mouseLock` is `false`.

Implementation
`public function get movementX():Number`
`public function set movementX(value:Number):void`

Related API Elements

flash.display.Stage.mouseLock
localX
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

### movementY

property

`movementY:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 11.2, AIR 3.2

When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event. Enable mouse locking by setting `Stage.mouseLock` to `true`.

When mouse locking is enabled:

- `localX` and `localY` contain 0.
- `movementX` and `movementY` contain delta values.
- `movementX` and `movementY` are never transformed based on stage transformation. That means they always remain in screen coordinates.

`movementX` and `movementY` are 0 when `Stage.mouseLock` is `false`.

Implementation
`public function get movementY():Number`
`public function set movementY(value:Number):void`

Related API Elements

flash.display.Stage.mouseLock
localY
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

### relatedObject

property

`relatedObject:InteractiveObject`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

A reference to a display list object that is related to the event. For example, when a `mouseOut` event occurs, `relatedObject` represents the display list object to which the pointing device now points. This property applies to the `mouseOut`, `mouseOver`, `rollOut`, and `rollOver` events.

The value of this property can be `null` in two circumstances: if there no related object, or there is a related object, but it is in a security sandbox to which you don't have access. Use the `isRelatedObjectInaccessible()` property to determine which of these reasons applies.

Implementation
`public function get relatedObject():InteractiveObject`
`public function set relatedObject(value:InteractiveObject):void`

Related API Elements

MouseEvent.isRelatedObjectInaccessible

### shiftKey

property

`shiftKey:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Indicates whether the Shift key is active (`true`) or inactive (`false`).

Implementation
`public function get shiftKey():Boolean`
`public function set shiftKey(value:Boolean):void`

### stageX

property

`stageX:Number` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

The horizontal coordinate at which the event occurred in global Stage coordinates. This property is calculated when the `localX` property is set.

Implementation
`public function get stageX():Number`
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

### stageY

property

`stageY:Number` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

The vertical coordinate at which the event occurred in global Stage coordinates. This property is calculated when the `localY` property is set.

Implementation
`public function get stageY():Number`
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.
Constructor Detail

### MouseEvent

()
Constructor

`public function MouseEvent(type:String, bubbles:Boolean = true, 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, commandKey:Boolean = false, controlKey:Boolean = false, clickCount:int = 0)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Creates an Event object that contains information about mouse events. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event. Possible values are: `MouseEvent.CLICK`, `MouseEvent.DOUBLE_CLICK`, `MouseEvent.MOUSE_DOWN`, `MouseEvent.MOUSE_MOVE`, `MouseEvent.MOUSE_OUT`, `MouseEvent.MOUSE_OVER`, `MouseEvent.MOUSE_UP`, `MouseEvent.MIDDLE_CLICK`, `MouseEvent.MIDDLE_MOUSE_DOWN`, `MouseEvent.MIDDLE_MOUSE_UP`, `MouseEvent.RIGHT_CLICK`, `MouseEvent.RIGHT_MOUSE_DOWN`, `MouseEvent.RIGHT_MOUSE_UP`, `MouseEvent.MOUSE_WHEEL`, `MouseEvent.ROLL_OUT`, and `MouseEvent.ROLL_OVER`.
| `bubbles:Boolean` (default = `true`)`` — Determines whether the Event object participates in the bubbling phase of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Determines 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 complementary InteractiveObject instance that is affected by the event. For example, when a `mouseOut` event occurs, `relatedObject` represents the display list object to which the pointing device now points.
| `ctrlKey:Boolean` (default = `false`)`` — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated.
| `altKey:Boolean` (default = `false`)`` — Indicates whether the Alt key is activated (Windows or Linux only).
| `shiftKey:Boolean` (default = `false`)`` — Indicates whether the Shift key is activated.
| `buttonDown:Boolean` (default = `false`)`` — Indicates whether the primary mouse button is pressed.
| `delta:int` (default = `0`)`` — Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This parameter is used only for the `MouseEvent.mouseWheel` event.
| `commandKey:Boolean` (default = `false`)`` — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is used only for the `MouseEvent.click`, `MouseEvent.mouseDown`, `MouseEvent.mouseUp`, `MouseEvent.middleClick`, `MouseEvent.middleMouseDown`, `MouseEvent.middleMouseUp`, `MouseEvent.rightClick`, `MouseEvent.rightMouseDown`, `MouseEvent.rightMouseUp`, and `MouseEvent.doubleClick` events. This parameter is for Adobe AIR only; do not set it for Flash Player content.
| `controlKey:Boolean` (default = `false`)`` — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is used only for the `MouseEvent.click`, `MouseEvent.mouseDown`, `MouseEvent.mouseUp`, `MouseEvent.middleClick`, `MouseEvent.middleMouseDown`, `MouseEvent.middleMouseUp`, `MouseEvent.rightClick`, `MouseEvent.rightMouseDown`, `MouseEvent.rightMouseUp`, and `MouseEvent.doubleClick` events. This parameter is for Adobe AIR only; do not set it for Flash Player content.
| `clickCount:int` (default = `0`)`` — (AIR only) Indicates whether or not the mouse event is part of a multi-click sequence. This parameter will be zero for all mouse events other than `MouseEvent.mouseDown`, `MouseEvent.mouseUp`, `MouseEvent.middleMouseDown`, `MouseEvent.middleMouseUp`, `MouseEvent.rightMouseDown` and `MouseEvent.rightMouseUp`. Listening for single clicks, double clicks, or any multi-click sequence is possible with the `clickCount` parameter. This parameter is for Adobe AIR only; do not set it for Flash Player content.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new MouseEvent 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, Flash Player 9, Flash Lite 4

Returns a string that contains all the properties of the MouseEvent object. The string is in the following format:

`[MouseEvent type=value bubbles=value cancelable=value ... delta=value]`

Returns

| `String` — A string that contains all the properties of the MouseEvent object.

### updateAfterEvent

()
method

`public function updateAfterEvent():void`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.

Constant Detail

### CLICK

Constant

`public static const CLICK:String = "click"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `click` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | For click events, this value is always `false`.
`cancelable` | `false`; there is no default behavior to cancel.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.click

### CONTEXT_MENU

Constant

`public static const CONTEXT_MENU:String = "contextMenu"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Lite 4

The `MouseEvent.CONTEXT_MENU` constant defines the value of the `type` property of a `contextMenu` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the right mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

### DOUBLE_CLICK

Constant

`public static const DOUBLE_CLICK:String = "doubleClick"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `doubleClick` event object. The `doubleClickEnabled` property must be `true` for an object to generate the `doubleClick` event.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | For double-click events, this value is always `false`.
`cancelable` | `false`; there is no default behavior to cancel.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.doubleClick

### MIDDLE_CLICK

Constant

`public static const MIDDLE_CLICK:String = "middleClick"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the `type` property of a `middleClick` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | For middle-click events, this property is always `false`.
`cancelable` | `false`; there is no default behavior to cancel.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.middleClick

### MIDDLE_MOUSE_DOWN

Constant

`public static const MIDDLE_MOUSE_DOWN:String = "middleMouseDown"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the `type` property of a `middleMouseDown` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the middle mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.middleMouseDown

### MIDDLE_MOUSE_UP

Constant

`public static const MIDDLE_MOUSE_UP:String = "middleMouseUp"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the `type` property of a `middleMouseUp` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the middle mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.middleMouseUp

### MOUSE_DOWN

Constant

`public static const MOUSE_DOWN:String = "mouseDown"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `mouseDown` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows and Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.mouseDown
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this constant.

### MOUSE_MOVE

Constant

`public static const MOUSE_MOVE:String = "mouseMove"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `mouseMove` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.mouseMove
Example ( How to use this example )
The following example is a simple drawing program. The user can draw on the main Sprite object or on a smaller rectangular Sprite object.

In the constructor, a rectangle `innerRect` Sprite object is created and the line style is set to green. The line style for drawing on the `MouseEvent_MOUSE_MOVEExample` Sprite container is set to red. Separate event listeners for the `MouseEvent.MOUSE_UP` and `MouseEvent.MOUSE_DOWN` events are added for the application's main Sprite object and `innerRect` Sprite object. In both cases, the mouse down event listener methods move the current drawing position to the mouse pointer's location and add a listener for the `MouseEvent.MOUSE_MOVE` event. When the mouse pointer is moved, the invoked event listener methods follows the pointer and draw a line using the `graphics.LineTo()` method. (Note: The `innerRect` Sprite object obscures the red lines of the main Sprite object that are drawn behind the rectangle.) When the `MouseEvent.MOUSE_UP` event occurs, the listener for the `MOUSE_MOVE` event is removed and drawing is stopped.

Copy

    package {
        import flash.display.Sprite;
        import flash.display.Graphics;
        import flash.events.MouseEvent;

        public class MouseEvent_MOUSE_MOVEExample extends Sprite {
            private var innerRect:Sprite = new Sprite();

            public function MouseEvent_MOUSE_MOVEExample() {

                graphics.lineStyle(3, 0xFF0000, 1);
                stage.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
                stage.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);

                innerRect.graphics.lineStyle(1, 0x00FF00, 1);
                innerRect.graphics.beginFill(0xFFFFFF);
                innerRect.graphics.drawRect(10, 10, 200, 200);
                innerRect.graphics.endFill();
                innerRect.addEventListener(MouseEvent.MOUSE_DOWN, innerRectMouseDownHandler);
                innerRect.addEventListener(MouseEvent.MOUSE_UP, innerRectMouseUpHandler);
                addChild(innerRect);
            }

            private function mouseDownHandler(event:MouseEvent):void {
                graphics.moveTo(event.stageX, event.stageY);
                stage.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
            }

            private function mouseMoveHandler(event:MouseEvent):void {
                graphics.lineTo(event.stageX, event.stageY);
            }

            private function mouseUpHandler(event:MouseEvent):void {
                stage.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
            }

            private function innerRectMouseDownHandler(event:MouseEvent):void {
                innerRect.graphics.moveTo(event.localX, event.localY);
                innerRect.addEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
            }

            private function innerRectMouseMoveHandler(event:MouseEvent):void {
                innerRect.graphics.lineTo(event.localX, event.localY);
            }

            private function innerRectMouseUpHandler(event:MouseEvent):void {
                innerRect.removeEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
            }
        }
    }

### MOUSE_OUT

Constant

`public static const MOUSE_OUT:String = "mouseOut"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `mouseOut` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`relatedObject` | The display list object to which the pointing device now points.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.mouseOut

### MOUSE_OVER

Constant

`public static const MOUSE_OVER:String = "mouseOver"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `mouseOver` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`relatedObject` | The display list object to which the pointing device was pointing.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.mouseOver

### MOUSE_UP

Constant

`public static const MOUSE_UP:String = "mouseUp"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `mouseUp` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.mouseUp
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this constant.

### MOUSE_WHEEL

Constant

`public static const MOUSE_WHEEL:String = "mouseWheel"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9

Defines the value of the `type` property of a `mouseWheel` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`delta` | The number of lines that that each notch on the mouse wheel represents.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.mouseWheel

### RELEASE_OUTSIDE

Constant

`public static const RELEASE_OUTSIDE:String = "releaseOutside"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.3, Flash Player 11.3

Defines the value of the `type` property of a `releaseOutside` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `false`
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject which pointing device button is pressed over previously and out from the instance and released. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.releaseOutside
Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this constant.

### RIGHT_CLICK

Constant

`public static const RIGHT_CLICK:String = "rightClick"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the `type` property of a `rightClick` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | For right-click events, this property is always `false`.
`cancelable` | `false`; there is no default behavior to cancel.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.rightClick

### RIGHT_MOUSE_DOWN

Constant

`public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the `type` property of a `rightMouseDown` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | For right-click events, this property is always `true`.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.rightMouseDown

### RIGHT_MOUSE_UP

Constant

`public static const RIGHT_MOUSE_UP:String = "rightMouseUp"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the `type` property of a `rightMouseUp` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `true`
`buttonDown` | `true` if the right mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`clickCount` | Count of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.rightMouseUp

### ROLL_OUT

Constant

`public static const ROLL_OUT:String = "rollOut"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `rollOut` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `false`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; there is no default behavior to cancel.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`relatedObject` | The display list object to which the pointing device now points.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.rollOut

### ROLL_OVER

Constant

`public static const ROLL_OVER:String = "rollOver"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of a `rollOver` event object.

This event has the following properties:

Property | Value
--- | ---
`altKey` | `true` if the Alt key is active (Windows).
`bubbles` | `false`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; there is no default behavior to cancel.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`ctrlKey` | `true` on Windows or Linux if the Ctrl key is active. `true` on Mac if either the Ctrl key or the Command key is active. Otherwise, `false`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`relatedObject` | The display list object to which the pointing device was pointing.
`localX` | The horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
`movementX` | The change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`movementY` | The change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`stageX` | The horizontal coordinate at which the event occurred in global stage coordinates.
`stageY` | The vertical coordinate at which the event occurred in global stage coordinates.
`target` | The InteractiveObject instance under the pointing device. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Related API Elements

flash.display.InteractiveObject.rollOver
Examples How to use this example
MouseEventExample.as
The following example uses the `MouseEventExample` and `ChildSprite` classes to show how mouse events are dispatched using a simple image. This example carries out the following tasks:

1. The example declares properties for the size (100 x 100 pixels) and the background color (orange) for later use in drawing the square.
2. The constructor creates a new ChildSprite object `child`. Its constructor first draws an orange 100 x 100 pixel square at coordinates (0,0) by calling its `draw()` method and then adds seven event listeners/subscribers.
   - `click`/`clickHandler()`: Dispatched when the user single-clicks with the left mouse button over the square.
   - `doubleClick`/`doubleClickHandler()`: Dispatched when the user double-clicks the left mouse button over the square.
   - `mouseDown`/`mouseDownHandler()`: When the ChildSprite object (the orange square) is clicked, a `trace()` message is printed to the screen, and then `ChildSprite.draw()` is called, which draws a dark yellow square in place of the light blue one drawn in `mouseOverHandler()`. The `mouseDownHandler()` method also adds a `mouseMove`event listener and the `mouseMoveHandler()` subscriber (described below), which processes the mouse moves. Then the `startDrag()` method is called, which allows the Sprite object to be dragged.
   - `mouseOut`/`mouseOutHandler()`: Dispatched whenever the pointer leaves the square area. The `draw()` method is called to return the square to its normal size and color.
   - `mouseOver`/`mouseOverHandler()`: Dispatched when the mouse pointer is over the square. This method redraws the square so that it is larger and its background color is dark yellow.
   - `mouseUp`/`mouseUpHandler()`: When the user releases the mouse button, the `mouseMove` event listener is removed and `stopDrag` is called, which freezes the square in place.
   - `mouseMove`/`mouseMoveHandler()`: Called as part of the `mouseDownHandler()` function, and dispatched when the user is pressing the left mouse button and dragging the square.
   - `mouseWheel`/`mouseWheelHandler()`: Dispatched when the user rotates the mouse wheel over the square.
3. The ChildSprite instance `child` is then added to the display list by means of `addChild()`, which promptly draws the orange square.

Notes:

- The `MouseEventExample` class should be the document root.
- Some of the event methods listed above declare a local variable `sprite`, which is assigned the cast of `event.target` to type Sprite.

Copy

    package {
        import flash.display.Sprite;

        public class MouseEventExample extends Sprite {
            private var size:uint = 100;
            private var bgColor:uint = 0xFFCC00;

            public function MouseEventExample() {
                var child:ChildSprite = new ChildSprite();
                addChild(child);
            }
        }
    }

    import flash.display.Sprite;
    import flash.events.MouseEvent;

    class ChildSprite extends Sprite {
        private var size:uint = 50;
        private var overSize:uint = 60;
        private var backgroundColor:uint = 0xFFCC00;
        private var overColor:uint = 0xCCFF00;
        private var downColor:uint = 0x00CCFF;

        public function ChildSprite() {
            draw(size, size, backgroundColor);
                doubleClickEnabled = true;
            addEventListener(MouseEvent.CLICK, clickHandler);
            addEventListener(MouseEvent.DOUBLE_CLICK, doubleClickHandler);
            addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
            addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
            addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
            addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
            addEventListener(MouseEvent.MOUSE_WHEEL, mouseWheelHandler);
        }

        private function draw(w:uint, h:uint, bgColor:uint):void {
            graphics.clear();
            graphics.beginFill(bgColor);
            graphics.drawRect(0, 0, w, h);
            graphics.endFill();
        }

        private function clickHandler(event:MouseEvent):void {
            trace("clickHandler");
        }

        private function doubleClickHandler(event:MouseEvent):void {
            trace("doubleClickHandler");
        }

        private function mouseDownHandler(event:MouseEvent):void {
            trace("mouseDownHandler");
            draw(overSize, overSize, downColor);

            var sprite:Sprite = Sprite(event.target);
            sprite.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
            sprite.startDrag();
        }

        private function mouseMoveHandler(event:MouseEvent):void {
            trace("mouseMoveHandler");
            event.updateAfterEvent();
        }

        private function mouseOutHandler(event:MouseEvent):void {
            trace("mouseOutHandler");
            draw(size, size, backgroundColor);
        }

        private function mouseOverHandler(event:MouseEvent):void {
            trace("mouseOverHandler");
            draw(overSize, overSize, overColor);
        }

        private function mouseWheelHandler(event:MouseEvent):void {
            trace("mouseWheelHandler delta: " + event.delta);
        }

        private function mouseUpHandler(event:MouseEvent):void {
            trace("mouseUpHandler");
            var sprite:Sprite = Sprite(event.target);
            sprite.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
            sprite.stopDrag();
            draw(overSize, overSize, overColor);
        }
    }

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