| 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 |
More examples
Learn more
Public Properties
Hide Inherited Public Properties
Show Inherited Public PropertiesPublic 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 | ||
 | [override]
Creates a copy of the MouseEvent object and sets the value of each property to match that of the original. | MouseEvent | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string that contains all the properties of the MouseEvent object. | MouseEvent | |
|
Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified. | MouseEvent | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CLEAR : String = "clear" [static]
The Event.CLEAR constant 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]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
| CONTEXT_MENU : String = "contextMenu" [static]
The MouseEvent.CONTEXT_MENU constant defines the value of the
type property of a contextMenu event object. | MouseEvent | |
| COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| DOUBLE_CLICK : String = "doubleClick" [static]
Defines the value of the type property of a doubleClick event object. | MouseEvent | |
| ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
| LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MIDDLE_CLICK : String = "middleClick" [static]
Defines the value of the type property of a middleClick event object. | MouseEvent | |
| MIDDLE_MOUSE_DOWN : String = "middleMouseDown" [static]
Defines the value of the type property of a middleMouseDown event object. | MouseEvent | |
| MIDDLE_MOUSE_UP : String = "middleMouseUp" [static]
Defines the value of the type property of a middleMouseUp event object. | MouseEvent | |
| MOUSE_DOWN : String = "mouseDown" [static]
Defines the value of the type property of a mouseDown event object. | MouseEvent | |
| MOUSE_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_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| MOUSE_MOVE : String = "mouseMove" [static]
Defines the value of the type property of a mouseMove event object. | MouseEvent | |
| MOUSE_OUT : String = "mouseOut" [static]
Defines the value of the type property of a mouseOut event object. | MouseEvent | |
| MOUSE_OVER : String = "mouseOver" [static]
Defines the value of the type property of a mouseOver event object. | MouseEvent | |
| MOUSE_UP : String = "mouseUp" [static]
Defines the value of the type property of a mouseUp event object. | MouseEvent | |
| MOUSE_WHEEL : String = "mouseWheel" [static]
Defines the value of the type property of a mouseWheel event object. | MouseEvent | |
| 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 | ||
| NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| RIGHT_CLICK : String = "rightClick" [static]
Defines the value of the type property of a rightClick event object. | MouseEvent | |
| RIGHT_MOUSE_DOWN : String = "rightMouseDown" [static]
Defines the value of the type property of a rightMouseDown event object. | MouseEvent | |
| RIGHT_MOUSE_UP : String = "rightMouseUp" [static]
Defines the value of the type property of a rightMouseUp event object. | MouseEvent | |
| ROLL_OUT : String = "rollOut" [static]
Defines the value of the type property of a rollOut event object. | MouseEvent | |
| ROLL_OVER : String = "rollOver" [static]
Defines the value of the type property of a rollOver event object. | MouseEvent | |
| SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
| UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
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.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
localX:Number (default = 0) | |
localY:Number (default = 0) | |
relatedObject:InteractiveObject (default = null) | |
ctrlKey:Boolean (default = false) | |
altKey:Boolean (default = false) | |
shiftKey:Boolean (default = false) | |
buttonDown:Boolean (default = false) | |
delta:int (default = 0) |
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. |
Mon Nov 28 2011, 06:48 AM -08:00