BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
None
Hide Filters
flash.events 

MouseEvent  - AS3

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.consulting.pst.vo
com.adobe.dct.event
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.impl
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.importexport
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.mosaic.core
com.adobe.mosaic.core.events
com.adobe.mosaic.core.validators
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skins.aqua
com.adobe.mosaic.skins.aqua.organizer
com.adobe.mosaic.skins.aqua.tile
com.adobe.mosaic.skins.aqua.util
com.adobe.mosaic.skins.aqua.view
com.adobe.mosaic.skins.aqua.viewManager
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.endpoint
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices

Package flash.events

Interfaces
IEventDispatcher
 
Classes
AccelerometerEvent
ActivityEvent
AsyncErrorEvent
AudioOutputChangeEvent
AVDictionaryDataEvent
AVHTTPStatusEvent
AVPauseAtPeriodEndEvent
BrowserInvokeEvent    
ContextMenuEvent
DataEvent
DatagramSocketDataEvent    
DeviceRotationEvent    
DNSResolverEvent    
DRMAuthenticateEvent    
DRMAuthenticationCompleteEvent
DRMAuthenticationErrorEvent
DRMDeviceGroupErrorEvent
DRMDeviceGroupEvent
DRMErrorEvent
DRMLicenseRequestEvent
DRMMetadataEvent
DRMReturnVoucherCompleteEvent
DRMReturnVoucherErrorEvent
DRMStatusEvent
ErrorEvent
Event
EventDispatcher
EventPhase
FileListEvent    
FocusEvent
FullScreenEvent
GameInputEvent    
GeolocationEvent
GestureEvent
GesturePhase
HTMLUncaughtScriptExceptionEvent    
HTTPStatusEvent
IMEEvent
InvokeEvent    
IOErrorEvent
KeyboardEvent
LocationChangeEvent    
MediaEvent    
MouseEvent
NativeDragEvent    
NativeProcessExitEvent    
NativeWindowBoundsEvent    
NativeWindowDisplayStateEvent    
NetDataEvent
NetMonitorEvent
NetStatusEvent
OutputProgressEvent    
PermissionEvent
PressAndTapGestureEvent
ProgressEvent
RemoteNotificationEvent    
SampleDataEvent
ScreenMouseEvent    
SecurityErrorEvent
ServerSocketConnectEvent    
ShaderEvent
SoftKeyboardEvent
SoftKeyboardTrigger
SQLErrorEvent    
SQLEvent    
SQLUpdateEvent    
StageOrientationEvent    
StageVideoAvailabilityEvent
StageVideoEvent
StatusEvent
StorageVolumeChangeEvent    
SyncEvent
TextEvent
ThrottleEvent
ThrottleType
TimerEvent
TouchEvent
TouchEventIntent    
TransformGestureEvent
UncaughtErrorEvent
UncaughtErrorEvents
VideoEvent
VideoTextureEvent
VsyncStateChangeAvailabilityEvent    
(Beta)
Packageflash.events
Classpublic class MouseEvent
InheritanceMouseEvent Inheritance Event Inheritance Object
Subclasses AutomationDragEvent, ChartEvent, ChartItemEvent, DragEvent, FlexMouseEvent, GridEvent, LegendMouseEvent, ListEvent, NativeDragEvent, ScreenMouseEvent

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

A MouseEvent object is dispatched into the event flow whenever mouse events occur. A mouse event is usually generated by a user input device, such as a mouse or a trackball, that uses a pointer.

When nested nodes are involved, mouse events target the deepest possible nested node that is visible in the display list. This node is called the target node. To have a target node's ancestor receive notification of a mouse event, use EventDispatcher.addEventListener() on the ancestor node with the type parameter set to the specific mouse event you want to detect.

View the examples

More examples

Learn more



Public Properties
 PropertyDefined By
  altKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false).
MouseEvent
 Inheritedbubbles : 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
 Inheritedcancelable : 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
 Inheritedconstructor : 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
 InheritedcurrentTarget : 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
 InheritedeventPhase : 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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
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
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CLICK : String = "click"
[static] Defines the value of the type property of a click event object.
MouseEvent
  CONTEXT_MENU : String = "contextMenu"
[static] The MouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object.
MouseEvent
  DOUBLE_CLICK : String = "doubleClick"
[static] Defines the value of the type property of a doubleClick event object.
MouseEvent
  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_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
  RELEASE_OUTSIDE : String = "releaseOutside"
[static] Defines the value of the type property of a releaseOutside event object.
MouseEvent
  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
Property Detail

altKey

property
altKey:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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.



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

buttonDown

property 
buttonDown:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

Indicates whether the primary mouse button is pressed (true) or not (false).



Implementation
    public function get buttonDown():Boolean
    public function set buttonDown(value:Boolean):void

clickCount

property 
clickCount:int  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Lite 4

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.



Implementation
    public function get clickCount():int

commandKey

property 
commandKey:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Lite 4

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.



Implementation
    public function get commandKey():Boolean
    public function set commandKey(value:Boolean):void

controlKey

property 
controlKey:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Lite 4

Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.



Implementation
    public function get controlKey():Boolean
    public function set controlKey(value:Boolean):void

ctrlKey

property 
ctrlKey:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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.



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

delta

property 
delta:int

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This setting depends on the device and operating system and is usually configurable by the user. This property applies only to the MouseEvent.mouseWheel event.



Implementation
    public function get delta():int
    public function set delta(value:int):void

isRelatedObjectInaccessible

property 
isRelatedObjectInaccessible:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 10, Flash Lite 4

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.



Implementation
    public function get isRelatedObjectInaccessible():Boolean
    public function set isRelatedObjectInaccessible(value:Boolean):void

Related API Elements

localX

property 
localX:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite. Disable mouse locking by setting Stage.mouseLock to false.

When mouse locking is enabled, localX and localY are 0. Use movementX and movementY to determine the changes to mouse position when mouse locking is enabled.



Implementation
    public function get localX():Number
    public function set localX(value:Number):void

Related API Elements


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

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite. Disable mouse locking by setting Stage.mouseLock to false.

When mouse locking is enabled, localX and localY are 0. Use movementX and movementY to determine the changes to mouse position when mouse locking is enabled.



Implementation
    public function get localY():Number
    public function set localY(value:Number):void

Related API Elements


Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

movementX

property 
movementX:Number

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11.2, AIR 3.2

When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event. Enable mouse locking by setting Stage.mouseLock to true.

When mouse locking is enabled:

  • localX and localY contain 0.
  • movementX and movementY contain delta values.
  • movementX and movementY are never transformed based on stage transformation. That means they always remain in screen coordinates.

movementX and movementY are 0 when Stage.mouseLock is false.



Implementation
    public function get movementX():Number
    public function set movementX(value:Number):void

Related API Elements


Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this property.

movementY

property 
movementY:Number

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 11.2, AIR 3.2

When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event. Enable mouse locking by setting Stage.mouseLock to true.

When mouse locking is enabled:

  • localX and localY contain 0.
  • movementX and movementY contain delta values.
  • movementX and movementY are never transformed based on stage transformation. That means they always remain in screen coordinates.

movementX and movementY are 0 when Stage.mouseLock is false.



Implementation
    public function get movementY():Number
    public function set movementY(value:Number):void

Related API Elements


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

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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.



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

Related API Elements

shiftKey

property 
shiftKey:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

Indicates whether the Shift key is active (true) or inactive (false).



Implementation
    public function get shiftKey():Boolean
    public function set shiftKey(value:Boolean):void

stageX

property 
stageX:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

The horizontal coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localX property is set.



Implementation
    public function get stageX():Number

Example
How to use 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]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

The vertical coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localY property is set.



Implementation
    public function get stageY():Number

Example
How to use 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)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

Creates an Event object that contains information about mouse events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Possible values are: MouseEvent.CLICK, MouseEvent.DOUBLE_CLICK, MouseEvent.MOUSE_DOWN, MouseEvent.MOUSE_MOVE, MouseEvent.MOUSE_OUT, MouseEvent.MOUSE_OVER, MouseEvent.MOUSE_UP, MouseEvent.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) — Determines whether the Event object participates in the bubbling phase of the event flow.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled.
 
localX:Number (default = NaN) — The horizontal coordinate at which the event occurred relative to the containing sprite.
 
localY:Number (default = NaN) — The vertical coordinate at which the event occurred relative to the containing sprite.
 
relatedObject:InteractiveObject (default = null) — The complementary InteractiveObject instance that is affected by the event. For example, when a mouseOut event occurs, relatedObject represents the display list object to which the pointing device now points.
 
ctrlKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated.
 
altKey:Boolean (default = false) — Indicates whether the Alt key is activated (Windows or Linux only).
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is activated.
 
buttonDown:Boolean (default = false) — Indicates whether the primary mouse button is pressed.
 
delta:int (default = 0) — Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This parameter is used only for the MouseEvent.mouseWheel event.
 
commandKey:Boolean (default = false) — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is used only for the 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) — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is used only for the 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) — (AIR only) Indicates whether or not the mouse 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. This parameter is for Adobe AIR only; do not set it for Flash Player content.
Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.

Returns
Event — A new MouseEvent object with property values that match those of the original.

toString

()method 
override public function toString():String

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

Returns a string that contains all the properties of the MouseEvent object. The string is in the following format:

[MouseEvent type=value bubbles=value cancelable=value ... delta=value]

Returns
String — A string that contains all the properties of the MouseEvent object.

updateAfterEvent

()method 
public function updateAfterEvent():void

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

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"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor click events, this value is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

CONTEXT_MENU

Constant 
public static const CONTEXT_MENU:String = "contextMenu"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Lite 4

The MouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor double-click events, this value is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MIDDLE_CLICK

Constant 
public static const MIDDLE_CLICK:String = "middleClick"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the type property of a middleClick event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor middle-click events, this property is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MIDDLE_MOUSE_DOWN

Constant 
public static const MIDDLE_MOUSE_DOWN:String = "middleMouseDown"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the type property of a middleMouseDown event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MIDDLE_MOUSE_UP

Constant 
public static const MIDDLE_MOUSE_UP:String = "middleMouseUp"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the type property of a middleMouseUp event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MOUSE_DOWN

Constant 
public static const MOUSE_DOWN:String = "mouseDown"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements


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"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements


Example  ( How to use this example )

The following example is a simple drawing program. The user can draw on the main Sprite object or on a smaller rectangular Sprite object.

In the constructor, a rectangle innerRect Sprite object is created and the line style is set to green. The line style for drawing on the MouseEvent_MOUSE_MOVEExample Sprite container is set to red. Separate event listeners for the MouseEvent.MOUSE_UP and MouseEvent.MOUSE_DOWN events are added for the application's main Sprite object and innerRect Sprite object. In both cases, the mouse down event listener methods move the current drawing position to the mouse pointer's location and add a listener for the MouseEvent.MOUSE_MOVE event. When the mouse pointer is moved, the invoked event listener methods follows the pointer and draw a line using the graphics.LineTo() method. (Note: The innerRect Sprite object obscures the red lines of the main Sprite object that are drawn behind the rectangle.) When the MouseEvent.MOUSE_UP event occurs, the listener for the MOUSE_MOVE event is removed and drawing is stopped.

package {
    import flash.display.Sprite;
    import flash.display.Graphics;
    import flash.events.MouseEvent;

    public class MouseEvent_MOUSE_MOVEExample extends Sprite {
        private var innerRect:Sprite = new Sprite();
        
        public function MouseEvent_MOUSE_MOVEExample() {

            graphics.lineStyle(3, 0xFF0000, 1);
            stage.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
            stage.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);

            innerRect.graphics.lineStyle(1, 0x00FF00, 1);
            innerRect.graphics.beginFill(0xFFFFFF);
            innerRect.graphics.drawRect(10, 10, 200, 200);
            innerRect.graphics.endFill();
            innerRect.addEventListener(MouseEvent.MOUSE_DOWN, innerRectMouseDownHandler);
            innerRect.addEventListener(MouseEvent.MOUSE_UP, innerRectMouseUpHandler);
            addChild(innerRect);
        }

        private function mouseDownHandler(event:MouseEvent):void {
            graphics.moveTo(event.stageX, event.stageY);
            stage.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        }
    
        private function mouseMoveHandler(event:MouseEvent):void {
            graphics.lineTo(event.stageX, event.stageY);
        }    
    
        private function mouseUpHandler(event:MouseEvent):void {
            stage.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        }

        private function innerRectMouseDownHandler(event:MouseEvent):void {
            innerRect.graphics.moveTo(event.localX, event.localY);
            innerRect.addEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
        }
    
        private function innerRectMouseMoveHandler(event:MouseEvent):void {
            innerRect.graphics.lineTo(event.localX, event.localY);
        }    
    
        private function innerRectMouseUpHandler(event:MouseEvent):void {
            innerRect.removeEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
        }
    }
}

MOUSE_OUT

Constant 
public static const MOUSE_OUT:String = "mouseOut"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MOUSE_OVER

Constant 
public static const MOUSE_OVER:String = "mouseOver"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MOUSE_UP

Constant 
public static const MOUSE_UP:String = "mouseUp"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements


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"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

RELEASE_OUTSIDE

Constant 
public static const RELEASE_OUTSIDE:String = "releaseOutside"

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.3, Flash Player 11.3

Defines the value of the type property of a releaseOutside event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownfalse
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject which pointing device button is pressed over previously and out from the instance and released. 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.

Related API Elements


Example
How to use this example
Please see the MOUSE_MOVE constant's example for an illustration of how to use this constant.

RIGHT_CLICK

Constant 
public static const RIGHT_CLICK:String = "rightClick"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the type property of a rightClick event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor right-click events, this property is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

RIGHT_MOUSE_DOWN

Constant 
public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the type property of a rightMouseDown event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor right-click events, this property is always true.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

RIGHT_MOUSE_UP

Constant 
public static const RIGHT_MOUSE_UP:String = "rightMouseUp"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 11.2, Flash Lite 4

Defines the value of the type property of a rightMouseUp event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

ROLL_OUT

Constant 
public static const ROLL_OUT:String = "rollOut"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

ROLL_OVER

Constant 
public static const ROLL_OVER:String = "rollOver"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue 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.
currentTargetThe object that is actively processing the Event object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe 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.

Related API Elements

MouseEventExample.as

The following example uses the MouseEventExample and ChildSprite classes to show how mouse events are dispatched using a simple image. This example carries out the following tasks:
  1. The example declares properties for the size (100 x 100 pixels) and the background color (orange) for later use in drawing the square.
  2. The constructor creates a new ChildSprite object child. Its constructor first draws an orange 100 x 100 pixel square at coordinates (0,0) by calling its draw() method and then adds seven event listeners/subscribers.
    • click/clickHandler(): Dispatched when the user single-clicks with the left mouse button over the square.
    • doubleClick/doubleClickHandler(): Dispatched when the user double-clicks the left mouse button over the square.
    • mouseDown/mouseDownHandler(): When the ChildSprite object (the orange square) is clicked, a trace() message is printed to the screen, and then ChildSprite.draw() is called, which draws a dark yellow square in place of the light blue one drawn in mouseOverHandler(). The mouseDownHandler() method also adds a mouseMoveevent listener and the mouseMoveHandler() subscriber (described below), which processes the mouse moves. Then the startDrag() method is called, which allows the Sprite object to be dragged.
    • mouseOut/mouseOutHandler(): Dispatched whenever the pointer leaves the square area. The draw() method is called to return the square to its normal size and color.
    • mouseOver/mouseOverHandler(): Dispatched when the mouse pointer is over the square. This method redraws the square so that it is larger and its background color is dark yellow.
    • mouseUp/mouseUpHandler(): When the user releases the mouse button, the mouseMove event listener is removed and stopDrag is called, which freezes the square in place.
    • mouseMove/mouseMoveHandler(): Called as part of the mouseDownHandler() function, and dispatched when the user is pressing the left mouse button and dragging the square.
    • mouseWheel/mouseWheelHandler(): Dispatched when the user rotates the mouse wheel over the square.
  3. The ChildSprite instance child is then added to the display list by means of addChild(), which promptly draws the orange square.

Notes:

  • The MouseEventExample class should be the document root.
  • Some of the event methods listed above declare a local variable sprite, which is assigned the cast of event.target to type Sprite.
package {
    import flash.display.Sprite;

    public class MouseEventExample extends Sprite {
        private var size:uint = 100;
        private var bgColor:uint = 0xFFCC00;

        public function MouseEventExample() {
            var child:ChildSprite = new ChildSprite();
            addChild(child);
        }
    }
}

import flash.display.Sprite;
import flash.events.MouseEvent;

class ChildSprite extends Sprite {
    private var size:uint = 50;
    private var overSize:uint = 60;
    private var backgroundColor:uint = 0xFFCC00;
    private var overColor:uint = 0xCCFF00;
    private var downColor:uint = 0x00CCFF;

    public function ChildSprite() {
        draw(size, size, backgroundColor);
            doubleClickEnabled = true;
        addEventListener(MouseEvent.CLICK, clickHandler);
        addEventListener(MouseEvent.DOUBLE_CLICK, doubleClickHandler);
        addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
        addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
        addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
        addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
        addEventListener(MouseEvent.MOUSE_WHEEL, mouseWheelHandler);
    }

    private function draw(w:uint, h:uint, bgColor:uint):void {
        graphics.clear();
        graphics.beginFill(bgColor);
        graphics.drawRect(0, 0, w, h);
        graphics.endFill();
    }

    private function clickHandler(event:MouseEvent):void {
        trace("clickHandler");
    }

    private function doubleClickHandler(event:MouseEvent):void {
        trace("doubleClickHandler");
    }

    private function mouseDownHandler(event:MouseEvent):void {
        trace("mouseDownHandler");
        draw(overSize, overSize, downColor);

        var sprite:Sprite = Sprite(event.target);
        sprite.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        sprite.startDrag();
    }

    private function mouseMoveHandler(event:MouseEvent):void {
        trace("mouseMoveHandler");
        event.updateAfterEvent();
    }

    private function mouseOutHandler(event:MouseEvent):void {
        trace("mouseOutHandler");
        draw(size, size, backgroundColor);
    }

    private function mouseOverHandler(event:MouseEvent):void {
        trace("mouseOverHandler");
        draw(overSize, overSize, overColor);
    }

    private function mouseWheelHandler(event:MouseEvent):void {
        trace("mouseWheelHandler delta: " + event.delta);
    }

    private function mouseUpHandler(event:MouseEvent):void {
        trace("mouseUpHandler");
        var sprite:Sprite = Sprite(event.target);
        sprite.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
        sprite.stopDrag();
        draw(overSize, overSize, overColor);
    }
}