Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
FlexMouseEvent

Package | mx.events
Class | public class FlexMouseEvent
Inheritance | FlexMouseEvent flash.events.MouseEvent

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.

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

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.

Wed Nov 15 2017, 09:50 AM +01:00