mx.events

# FlexMouseEvent - AS3 Flex

Package | mx.events
Class | public class FlexMouseEvent
Inheritance | FlexMouseEvent MouseEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The FlexMouseEvent class represents the event object passed to the event listener for Flex-specific mouse activity.

More examples

Manually dispatching events

Learn more

About Flex events

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
--- | --- | ---
|  | FlexMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = 0, localY:Number = 0, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0)
Constructor.
FlexMouseEvent
|  | 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
--- | --- | ---
|  | MOUSE_DOWN_OUTSIDE : String = "mouseDownOutside" [static] The FlexMouseEvent.MOUSE_DOWN_OUTSIDE constant defines the value of the type property of the event object for a mouseDownOutside event. | FlexMouseEvent
|  | MOUSE_WHEEL_CHANGING : String = "mouseWheelChanging" [static] The FlexMouseEvent.MOUSE_WHEEL_CHANGING constant defines the value of the type property of the event object for a mouseWheelChanging event. | FlexMouseEvent
|  | MOUSE_WHEEL_OUTSIDE : String = "mouseWheelOutside" [static] The FlexMouseEvent.MOUSE_WHEEL_OUTSIDE constant defines the value of the type property of the event object for a mouseWheelOutside event. | FlexMouseEvent

Constructor Detail

### FlexMouseEvent

()
Constructor

`public function FlexMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, localX:Number = 0, localY:Number = 0, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Specifies whether the behavior associated with the event can be prevented.
| `localX:Number` (default = `0`)`` — The horizontal position at which the event occurred.
| `localY:Number` (default = `0`)`` — The vertical position at which the event occurred.
| `relatedObject:InteractiveObject` (default = `null`)`` — The display list object that is related to the event.
| `ctrlKey:Boolean` (default = `false`)`` — Whether the Control key is down.
| `altKey:Boolean` (default = `false`)`` — Whether the Alt key is down.
| `shiftKey:Boolean` (default = `false`)`` — Whether the Shift key is down.
| `buttonDown:Boolean` (default = `false`)`` — Whether the Control key is down.
| `delta:int` (default = `0`)`` — How many lines should be scrolled for each notch the user scrolls the mouse wheel.

Constant Detail

### MOUSE_DOWN_OUTSIDE

Constant

`public static const MOUSE_DOWN_OUTSIDE:String = "mouseDownOutside"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The `FlexMouseEvent.MOUSE_DOWN_OUTSIDE` constant defines the value of the `type` property of the event object for a `mouseDownOutside` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`altKey` | Indicates whether the Alt key is down (`true`) or not (`false`).
`bubbles` | false
`buttonDown` | Indicates whether the main mouse button is down (`true`) or not (`false`).
`cancelable` | false
`ctrlKey` | Indicates whether the Control key is down (`true`) or not (`false`).
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`. For PopUpManager events, the object is the pop-up window.
`delta` | Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0.
`localX` | The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`localY` | The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`relatedObject` | A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located.
`shiftKey` | Indicates whether the Shift key is down (`true`) or not (`false`).
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event. For PopUpManager events, the object is the pop-up window.

### MOUSE_WHEEL_CHANGING

Constant

`public static const MOUSE_WHEEL_CHANGING:String = "mouseWheelChanging"`

Language Version: | ActionScript 3.0

Product Version: | Flex 4.5

Runtime Versions: | Flash Player 10, AIR 2.5

The `FlexMouseEvent.MOUSE_WHEEL_CHANGING` constant defines the value of the `type` property of the event object for a `mouseWheelChanging` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`altKey` | Indicates whether the Alt key is down (`true`) or not (`false`).
`bubbles` | false
`buttonDown` | Indicates whether the main mouse button is down (`true`) or not (`false`).
`cancelable` | false
`ctrlKey` | Indicates whether the Control key is down (`true`) or not (`false`).
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`delta` | Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel.
`localX` | The horizontal position at which the event occurred.
`localY` | The vertical position at which the event occurred.
`relatedObject` | A reference to a display list object that is related to the event. For this event, the object is the component which is the target of the mouseWheel event.
`shiftKey` | Indicates whether the Shift key is down (`true`) or not (`false`).
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

### MOUSE_WHEEL_OUTSIDE

Constant

`public static const MOUSE_WHEEL_OUTSIDE:String = "mouseWheelOutside"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The `FlexMouseEvent.MOUSE_WHEEL_OUTSIDE` constant defines the value of the `type` property of the event object for a `mouseWheelOutside` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`altKey` | Indicates whether the Alt key is down (`true`) or not (`false`).
`bubbles` | false
`buttonDown` | Indicates whether the main mouse button is down (`true`) or not (`false`).
`cancelable` | false
`ctrlKey` | Indicates whether the Control key is down (`true`) or not (`false`).
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`. For PopUpManager events, the object is the pop-up window.
`delta` | Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0.
`localX` | The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`localY` | The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
`relatedObject` | A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located.
`shiftKey` | Indicates whether the Shift key is down (`true`) or not (`false`).
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event. For PopUpManager events, the object is the pop-up window.

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