| window.runtime property | window.runtime.flash.events.MouseEvent |
| Inheritance | MouseEvent  Event Object |
| Runtime Versions: | AIR 1.0, |
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.
Properties
Hide Inherited Public Properties
Show Inherited 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
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
| 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 | ||
[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 | |
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_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 | ||
| 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 | |
Property Detail
altKey | property |
altKey:Boolean| Runtime Versions: | AIR 1.0, |
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.
buttonDown | property |
buttonDown:Boolean| Runtime Versions: | AIR 1.0, |
Indicates whether the primary mouse button is pressed (true) or not (false).
clickCount | property |
clickCount:int [read-only] | Runtime Versions: | 1.0 |
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.
commandKey | property |
commandKey:Boolean| Runtime Versions: | 1.0 |
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.
controlKey | property |
controlKey:Boolean| Runtime Versions: | 1.0 |
Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
ctrlKey | property |
ctrlKey:Boolean| Runtime Versions: | AIR 1.0, |
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.
delta | property |
delta:int| Runtime Versions: | AIR 1.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 setting depends on the device
and operating system and is usually configurable by the user. This
property applies only to the MouseEvent.mouseWheel event.
isRelatedObjectInaccessible | property |
isRelatedObjectInaccessible:Boolean| Runtime Versions: | AIR 1.0, |
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.
See also
localX | property |
localX:Number| Runtime Versions: | AIR 1.0, |
The horizontal coordinate at which the event occurred relative to the containing sprite.
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| Runtime Versions: | AIR 1.0, |
The vertical coordinate at which the event occurred relative to the containing sprite.
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| Runtime Versions: | AIR 1.0, |
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.
See also
shiftKey | property |
shiftKey:Boolean| Runtime Versions: | AIR 1.0, |
Indicates whether the Shift key is active (true) or inactive
(false).
stageX | property |
stageX:Number [read-only] | Runtime Versions: | AIR 1.0, |
The horizontal coordinate at which the event occurred in global Stage coordinates.
This property is calculated when the localX property is set.
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] | Runtime Versions: | AIR 1.0, |
The vertical coordinate at which the event occurred in global Stage coordinates.
This property is calculated when the localY property is set.
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)| Runtime Versions: | 1.0 |
Creates an Event object that contains information about mouse events. Event objects are passed as parameters to event listeners.
Parameterstype: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) | |
cancelable:Boolean (default = false) | |
localX:Number (default = NaN) | |
localY:Number (default = NaN) | |
relatedObject:InteractiveObject (default = null)mouseOut event occurs, relatedObject represents the display list object to which the pointing device now points.
| |
ctrlKey:Boolean (default = false) | |
altKey:Boolean (default = false) | |
shiftKey:Boolean (default = false) | |
buttonDown:Boolean (default = false) | |
delta:int (default = 0)MouseEvent.mouseWheel event.
| |
commandKey:Boolean (default = false)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)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)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 |
toString | () | method |
public function toString():String| Runtime Versions: | AIR 1.0, |
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]
String — A string that contains all the properties of the MouseEvent object.
|
updateAfterEvent | () | method |
public function updateAfterEvent():void| Runtime Versions: | AIR 1.0, |
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"| Runtime Versions: | AIR 1.0, |
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. |
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. |
CONTEXT_MENU | Constant |
public static const CONTEXT_MENU:String = "contextMenu"| Runtime Versions: | 1.0 |
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. |
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. |
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"| Runtime Versions: | AIR 1.0, |
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. |
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. |
MIDDLE_CLICK | Constant |
public static const MIDDLE_CLICK:String = "middleClick"| Runtime Versions: | 1.0 |
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. |
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. |
MIDDLE_MOUSE_DOWN | Constant |
public static const MIDDLE_MOUSE_DOWN:String = "middleMouseDown"| Runtime Versions: | 1.0 |
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. |
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. |
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. |
MIDDLE_MOUSE_UP | Constant |
public static const MIDDLE_MOUSE_UP:String = "middleMouseUp"| Runtime Versions: | 1.0 |
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. |
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. |
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. |
MOUSE_DOWN | Constant |
public static const MOUSE_DOWN:String = "mouseDown"| Runtime Versions: | AIR 1.0, |
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. |
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. |
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. |
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"| Runtime Versions: | AIR 1.0, |
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. |
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. |
MOUSE_OUT | Constant |
public static const MOUSE_OUT:String = "mouseOut"| Runtime Versions: | AIR 1.0, |
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. |
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. |
MOUSE_OVER | Constant |
public static const MOUSE_OVER:String = "mouseOver"| Runtime Versions: | AIR 1.0, |
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. |
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. |
MOUSE_UP | Constant |
public static const MOUSE_UP:String = "mouseUp"| Runtime Versions: | AIR 1.0, |
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. |
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. |
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. |
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"| Runtime Versions: | AIR 1.0, |
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. |
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. |
RIGHT_CLICK | Constant |
public static const RIGHT_CLICK:String = "rightClick"| Runtime Versions: | 1.0 |
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. |
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. |
RIGHT_MOUSE_DOWN | Constant |
public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown"| Runtime Versions: | 1.0 |
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. |
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. |
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. |
RIGHT_MOUSE_UP | Constant |
public static const RIGHT_MOUSE_UP:String = "rightMouseUp"| Runtime Versions: | 1.0 |
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. |
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. |
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. |
ROLL_OUT | Constant |
public static const ROLL_OUT:String = "rollOut"| Runtime Versions: | AIR 1.0, |
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. |
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. |
ROLL_OVER | Constant |
public static const ROLL_OVER:String = "rollOver"| Runtime Versions: | AIR 1.0, |
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. |
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. |
Thu Sep 29 2011, 02:34 AM -07:00