ActionScript 3.0 Language and Components Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Frames No Frames |
MouseEvent

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Flash® Player dispatches MouseEvent objects 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

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
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | ctrlKey : Boolean Indicates whether the Control 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
|  | 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
--- | --- | ---
|  | 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) Creates an Event object that contains information about mouse events. | MouseEvent
|  | clone():Event 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 your custom Event class. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether preventDefault() 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
|  | toString():String Returns a string that contains all the properties of the MouseEvent object. | MouseEvent
|  | updateAfterEvent():void Instructs Flash Player 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] Defines the value of the type property of an activate event object. | Event
|  | ADDED : String = "added" [static] Defines the value of the type property of an added event object. | Event
|  | ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object. | Event
|  | CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object. | Event
|  | CHANGE : String = "change" [static] Defines the value of the type property of a change event object. | Event
|  | CLEAR : String = "clear" [static] Defines 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] Defines the value of the type property of a close event object. | Event
|  | COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object. | Event
|  | CONNECT : String = "connect" [static] Defines the value of the type property of a connect event object. | Event
|  | 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] Defines the value of the type property of a deactivate 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] Defines the value of the type property of an enterFrame event object. | Event
|  | EXIT_FRAME : String = "exitFrame" [static] Defines the value of the type property of an exitFrame event object. | Event
|  | FRAME_CONSTRUCTED : String = "frameConstructed" [static] Defines the value of the type property of an frameConstructed event object. | Event
|  | FULLSCREEN : String = "fullScreen" [static] Defines the value of the type property of a fullScreen event object. | Event
|  | ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object. | Event
|  | INIT : String = "init" [static] Defines the value of the type property of an init event object. | Event
|  | MOUSE_DOWN : String = "mouseDown" [static] Defines the value of the type property of a mouseDown event object. | MouseEvent
|  | MOUSE_LEAVE : String = "mouseLeave" [static] 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
|  | OPEN : String = "open" [static] Defines the value of the type property of an open event object. | Event
|  | PASTE : String = "paste" [static] Defines the value of the type property of a paste event object. | Event
|  | REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object. | Event
|  | REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object. | Event
|  | RENDER : String = "render" [static] Defines the value of the type property of a render event object. | Event
|  | RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object. | Event
|  | 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
|  | SAMPLE_DATA : String = "sampleData" [static] Defines the value of the type property of a sampleData event object. | Event
|  | SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object. | Event
|  | SELECT : String = "select" [static] Defines the value of the type property of a select event object. | Event
|  | SELECT_ALL : String = "selectAll" [static] Defines the value of the type property of a selectAll event object. | Event
|  | SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the type property of a soundComplete event object. | Event
|  | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object. | Event
|  | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object. | Event
|  | TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object. | Event
|  | UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object. | Event

Property Detail

altKey | property

`altKey:Boolean` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Indicates whether the Alt key is active (`true`) or inactive (`false`). Supported for Windows operating systems only.

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

buttonDown | property |

`buttonDown:Boolean` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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`

ctrlKey | property |

`ctrlKey:Boolean` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

Indicates whether the Control key is active (`true`) or inactive (`false`). On Macintosh computers, you must use this property to represent the Command key.

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

delta | property |

`delta:int` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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`

localX | property |

`localX:Number` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

The horizontal coordinate at which the event occurred relative to the containing sprite.

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

localY | property |

`localY:Number` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

The vertical coordinate at which the event occurred relative to the containing sprite.

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

relatedObject | property |

`relatedObject:InteractiveObject` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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 only to the `mouseOut` and `mouseOver` events.

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

shiftKey | property |

`shiftKey:Boolean` [read-write]

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

Player Version : | Flash Player 9

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

Player Version : | Flash Player 9

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 examples
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)`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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.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`)`` — Indicates whether the Control key is activated.
| `altKey:Boolean` (default = `false`)`` — Indicates whether the Alt key is activated (Windows 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.

Method Detail

clone | () | method

`override public function clone():Event`

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

Player Version : | Flash Player 9

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

Player Version : | Flash Player 9

Instructs Flash Player 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

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; there is no default behavior to cancel.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.click

DOUBLE_CLICK | Constant |

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; there is no default behavior to cancel.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.doubleClick

MOUSE_DOWN | Constant |

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.mouseDown
Example
How to use examples
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

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.mouseMove
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.

    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

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.mouseOut

MOUSE_OVER | Constant |

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.mouseOver

MOUSE_UP | Constant |

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.mouseUp
Example
How to use examples
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

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; the default behavior cannot be canceled.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.mouseWheel

ROLL_OUT | Constant |

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; there is no default behavior to cancel.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.rollOut

ROLL_OVER | Constant |

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

Language Version : | ActionScript 3.0

Player Version : | Flash Player 9

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

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`cancelable` | `false`; there is no default behavior to cancel.
`ctrlKey` | `true` if the Control key is active; `false` if it is inactive.
`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.
`localY` | The vertical coordinate at which the event occurred relative to the containing sprite.
`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.

See also

flash.display.InteractiveObject.rollOver
Examples How to use examples
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.

    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);
        }
    }

Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Tue May 20 2008, 04:02 AM -07:00