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.

### Hierarchy

- Event
  - MouseEvent

## Index

### Constructors

- constructor

### Properties

- altKey
- bubbles
- buttonDown
- cancelable
- clickCount
- commandKey
- ctrlKey
- currentTarget
- delta
- eventPhase
- isRelatedObjectInaccessible
- localX
- localY
- relatedObject
- shiftKey
- stageX
- stageY
- target
- type
- ACTIVATE
- ADDED
- ADDED_TO_STAGE
- CANCEL
- CHANGE
- CLEAR
- CLICK
- CLOSE
- COMPLETE
- CONNECT
- CONTEXT3D_CREATE
- COPY
- CUT
- DEACTIVATE
- DOUBLE_CLICK
- ENTER_FRAME
- EXIT_FRAME
- FRAME_CONSTRUCTED
- FRAME_LABEL
- FULLSCREEN
- ID3
- INIT
- MIDDLE_CLICK
- MIDDLE_MOUSE_DOWN
- MIDDLE_MOUSE_UP
- MOUSE_DOWN
- MOUSE_LEAVE
- MOUSE_MOVE
- MOUSE_OUT
- MOUSE_OVER
- MOUSE_UP
- MOUSE_WHEEL
- OPEN
- PASTE
- RELEASE_OUTSIDE
- REMOVED
- REMOVED_FROM_STAGE
- RENDER
- RESIZE
- RIGHT_CLICK
- RIGHT_MOUSE_DOWN
- RIGHT_MOUSE_UP
- ROLL_OUT
- ROLL_OVER
- SCROLL
- SELECT
- SELECT_ALL
- SOUND_COMPLETE
- TAB_CHILDREN_CHANGE
- TAB_ENABLED_CHANGE
- TAB_INDEX_CHANGE
- TEXTURE_READY
- UNLOAD

### Methods

- clone
- formatToString
- isDefaultPrevented
- preventDefault
- stopImmediatePropagation
- stopPropagation
- toString
- updateAfterEvent

## Constructors

### constructor

- new MouseEvent(type: string, bubbles?: boolean, cancelable?: boolean, localX?: number, localY?: number, relatedObject?: InteractiveObject, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, buttonDown?: boolean, delta?: number, commandKey?: boolean, clickCount?: number): MouseEvent

- Overrides Event.constructor

  - Defined in lib/openfl/events/MouseEvent.d.ts:256

  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`.

  - ##### Optional bubbles: boolean

    Determines whether the Event object participates in the bubbling phase of the event flow.

  - ##### Optional cancelable: boolean

    Determines whether the Event object can be canceled.

  - ##### Optional localX: number

    The horizontal coordinate at which the event occurred relative to the containing sprite.

  - ##### Optional localY: number

    The vertical coordinate at which the event occurred relative to the containing sprite.

  - ##### Optional relatedObject: InteractiveObject

    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.

  - ##### Optional ctrlKey: boolean

    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.

  - ##### Optional altKey: boolean

    Indicates whether the Alt key is activated(Windows or Linux only).

  - ##### Optional shiftKey: boolean

    Indicates whether the Shift key is activated.

  - ##### Optional buttonDown: boolean

    Indicates whether the primary mouse button is pressed.

  - ##### Optional delta: number

    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.

  - ##### Optional commandKey: boolean

  - ##### Optional clickCount: number

  #### Returns MouseEvent

## Properties

### altKey

altKey: boolean

- Defined in lib/openfl/events/MouseEvent.d.ts:171

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`.

### bubbles

bubbles: boolean

Inherited from Event.bubbles

- Defined in lib/openfl/events/Event.d.ts:346

Indicates whether an event is a bubbling event. If the event can bubble, this value is `true`; otherwise it is `false`.

When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list hierarchy to the node just before the target node; the target phase, which comprises the target node; and the bubbling phase, which flows from the node subsequent to the target node back up the display list hierarchy.

Some events, such as the `activate` and `unload` events, do not have a bubbling phase. The `bubbles` property has a value of `false` for events that do not have a bubbling phase.

### buttonDown

buttonDown: boolean

- Defined in lib/openfl/events/MouseEvent.d.ts:177

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

### cancelable

cancelable: boolean

Inherited from Event.cancelable

- Defined in lib/openfl/events/Event.d.ts:353

Indicates whether the behavior associated with the event can be prevented. If the behavior can be canceled, this value is `true`; otherwise it is `false`.

### clickCount

clickCount: number

- Defined in lib/openfl/events/MouseEvent.d.ts:179

### commandKey

commandKey: boolean

- Defined in lib/openfl/events/MouseEvent.d.ts:181

### ctrlKey

ctrlKey: boolean

- Defined in lib/openfl/events/MouseEvent.d.ts:188

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.

### currentTarget

currentTarget: any

Inherited from Event.currentTarget

- Defined in lib/openfl/events/Event.d.ts:361

The object that is actively processing the Event object with an event listener. For example, if a user clicks an OK button, the current target could be the node containing that button or one of its ancestors that has registered an event listener for that event.

### delta

delta: number

- Defined in lib/openfl/events/MouseEvent.d.ts:198

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.

### eventPhase

eventPhase: EventPhase

Inherited from Event.eventPhase

- Defined in lib/openfl/events/Event.d.ts:372

The current phase in the event flow. This property can contain the following numeric values:

- The capture phase(`EventPhase.CAPTURING_PHASE`).
- The target phase(`EventPhase.AT_TARGET`).
- The bubbling phase(`EventPhase.BUBBLING_PHASE`).

### isRelatedObjectInaccessible

isRelatedObjectInaccessible: boolean

- Defined in lib/openfl/events/MouseEvent.d.ts:200

### localX

localX: number

- Defined in lib/openfl/events/MouseEvent.d.ts:206

The horizontal coordinate at which the event occurred relative to the containing sprite.

### localY

localY: number

- Defined in lib/openfl/events/MouseEvent.d.ts:212

The vertical coordinate at which the event occurred relative to the containing sprite.

### relatedObject

relatedObject: InteractiveObject

- Defined in lib/openfl/events/MouseEvent.d.ts:236

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.

### shiftKey

shiftKey: boolean

- Defined in lib/openfl/events/MouseEvent.d.ts:242

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

### stageX

stageX: number

- Defined in lib/openfl/events/MouseEvent.d.ts:249

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

### stageY

stageY: number

- Defined in lib/openfl/events/MouseEvent.d.ts:256

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

### target

target: any

Inherited from Event.target

- Defined in lib/openfl/events/Event.d.ts:379

The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

### type

type: string

Inherited from Event.type

- Defined in lib/openfl/events/Event.d.ts:384

The type of event. The type is case-sensitive.

### Static ACTIVATE

ACTIVATE: string

Inherited from Event.ACTIVATE

- Defined in lib/openfl/events/Event.d.ts:64

The `ACTIVATE` constant defines the value of the `type` property of an `activate` event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

This event has the following properties:

### Static ADDED

ADDED: string

Inherited from Event.ADDED

- Defined in lib/openfl/events/Event.d.ts:72

The `Event.ADDED` constant defines the value of the `type` property of an `added` event object.

This event has the following properties:

### Static ADDED_TO_STAGE

ADDED_TO_STAGE: string

Inherited from Event.ADDED_TO_STAGE

- Defined in lib/openfl/events/Event.d.ts:80

The `Event.ADDED_TO_STAGE` constant defines the value of the `type` property of an `addedToStage` event object.

This event has the following properties:

### Static CANCEL

CANCEL: string

Inherited from Event.CANCEL

- Defined in lib/openfl/events/Event.d.ts:92

The `Event.CANCEL` constant defines the value of the `type` property of a `cancel` event object.

This event has the following properties:

### Static CHANGE

CHANGE: string

Inherited from Event.CHANGE

- Defined in lib/openfl/events/Event.d.ts:100

The `Event.CHANGE` constant defines the value of the `type` property of a `change` event object.

This event has the following properties:

### Static CLEAR

CLEAR: string

Inherited from Event.CLEAR

- Defined in lib/openfl/events/Event.d.ts:110

### Static CLICK

CLICK: string

- Defined in lib/openfl/events/MouseEvent.d.ts:30

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

This event has the following properties:

### Static CLOSE

CLOSE: string

Inherited from Event.CLOSE

- Defined in lib/openfl/events/Event.d.ts:118

The `Event.CLOSE` constant defines the value of the `type` property of a `close` event object.

This event has the following properties:

### Static COMPLETE

COMPLETE: string

Inherited from Event.COMPLETE

- Defined in lib/openfl/events/Event.d.ts:126

The `Event.COMPLETE` constant defines the value of the `type` property of a `complete` event object.

This event has the following properties:

### Static CONNECT

CONNECT: string

Inherited from Event.CONNECT

- Defined in lib/openfl/events/Event.d.ts:134

The `Event.CONNECT` constant defines the value of the `type` property of a `connect` event object.

This event has the following properties:

### Static CONTEXT3D_CREATE

CONTEXT3D_CREATE: string

Inherited from Event.CONTEXT3D_CREATE

- Defined in lib/openfl/events/Event.d.ts:136

### Static COPY

COPY: string

Inherited from Event.COPY

- Defined in lib/openfl/events/Event.d.ts:138

### Static CUT

CUT: string

Inherited from Event.CUT

- Defined in lib/openfl/events/Event.d.ts:140

### Static DEACTIVATE

DEACTIVATE: string

Inherited from Event.DEACTIVATE

- Defined in lib/openfl/events/Event.d.ts:155

The `Event.DEACTIVATE` constant defines the value of the `type` property of a `deactivate` event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

This event has the following properties:

### Static DOUBLE_CLICK

DOUBLE_CLICK: string

- Defined in lib/openfl/events/MouseEvent.d.ts:44

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:

### Static ENTER_FRAME

ENTER_FRAME: string

Inherited from Event.ENTER_FRAME

- Defined in lib/openfl/events/Event.d.ts:167

The `Event.ENTER_FRAME` constant defines the value of the `type` property of an `enterFrame` event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

This event has the following properties:

### Static EXIT_FRAME

EXIT_FRAME: string

Inherited from Event.EXIT_FRAME

- Defined in lib/openfl/events/Event.d.ts:173

### Static FRAME_CONSTRUCTED

FRAME_CONSTRUCTED: string

Inherited from Event.FRAME_CONSTRUCTED

- Defined in lib/openfl/events/Event.d.ts:175

### Static FRAME_LABEL

FRAME_LABEL: string

Inherited from Event.FRAME_LABEL

- Defined in lib/openfl/events/Event.d.ts:177

### Static FULLSCREEN

FULLSCREEN: string

Inherited from Event.FULLSCREEN

- Defined in lib/openfl/events/Event.d.ts:179

### Static ID3

ID3: string

Inherited from Event.ID3

- Defined in lib/openfl/events/Event.d.ts:187

The `Event.ID3` constant defines the value of the `type` property of an `id3` event object.

This event has the following properties:

### Static INIT

INIT: string

Inherited from Event.INIT

- Defined in lib/openfl/events/Event.d.ts:195

The `Event.INIT` constant defines the value of the `type` property of an `init` event object.

This event has the following properties:

### Static MIDDLE_CLICK

MIDDLE_CLICK: string

- Defined in lib/openfl/events/MouseEvent.d.ts:52

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

This event has the following properties:

### Static MIDDLE_MOUSE_DOWN

MIDDLE_MOUSE_DOWN: string

- Defined in lib/openfl/events/MouseEvent.d.ts:60

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

This event has the following properties:

### Static MIDDLE_MOUSE_UP

MIDDLE_MOUSE_UP: string

- Defined in lib/openfl/events/MouseEvent.d.ts:68

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

This event has the following properties:

### Static MOUSE_DOWN

MOUSE_DOWN: string

- Defined in lib/openfl/events/MouseEvent.d.ts:76

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

This event has the following properties:

### Static MOUSE_LEAVE

MOUSE_LEAVE: string

Inherited from Event.MOUSE_LEAVE

- Defined in lib/openfl/events/Event.d.ts:203

The `Event.MOUSE_LEAVE` constant defines the value of the `type` property of a `mouseLeave` event object.

This event has the following properties:

### Static MOUSE_MOVE

MOUSE_MOVE: string

- Defined in lib/openfl/events/MouseEvent.d.ts:84

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

This event has the following properties:

### Static MOUSE_OUT

MOUSE_OUT: string

- Defined in lib/openfl/events/MouseEvent.d.ts:92

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

This event has the following properties:

### Static MOUSE_OVER

MOUSE_OVER: string

- Defined in lib/openfl/events/MouseEvent.d.ts:100

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

This event has the following properties:

### Static MOUSE_UP

MOUSE_UP: string

- Defined in lib/openfl/events/MouseEvent.d.ts:108

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

This event has the following properties:

### Static MOUSE_WHEEL

MOUSE_WHEEL: string

- Defined in lib/openfl/events/MouseEvent.d.ts:116

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

This event has the following properties:

### Static OPEN

OPEN: string

Inherited from Event.OPEN

- Defined in lib/openfl/events/Event.d.ts:211

The `Event.OPEN` constant defines the value of the `type` property of an `open` event object.

This event has the following properties:

### Static PASTE

PASTE: string

Inherited from Event.PASTE

- Defined in lib/openfl/events/Event.d.ts:213

### Static RELEASE_OUTSIDE

RELEASE_OUTSIDE: string

- Defined in lib/openfl/events/MouseEvent.d.ts:124

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

This event has the following properties:

### Static REMOVED

REMOVED: string

Inherited from Event.REMOVED

- Defined in lib/openfl/events/Event.d.ts:221

The `Event.REMOVED` constant defines the value of the `type` property of a `removed` event object.

This event has the following properties:

### Static REMOVED_FROM_STAGE

REMOVED_FROM_STAGE: string

Inherited from Event.REMOVED_FROM_STAGE

- Defined in lib/openfl/events/Event.d.ts:230

The `Event.REMOVED_FROM_STAGE` constant defines the value of the `type` property of a `removedFromStage` event object.

This event has the following properties:

### Static RENDER

RENDER: string

Inherited from Event.RENDER

- Defined in lib/openfl/events/Event.d.ts:242

The `Event.RENDER` constant defines the value of the `type` property of a `render` event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

This event has the following properties:

### Static RESIZE

RESIZE: string

Inherited from Event.RESIZE

- Defined in lib/openfl/events/Event.d.ts:250

The `Event.RESIZE` constant defines the value of the `type` property of a `resize` event object.

This event has the following properties:

### Static RIGHT_CLICK

RIGHT_CLICK: string

- Defined in lib/openfl/events/MouseEvent.d.ts:132

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

This event has the following properties:

### Static RIGHT_MOUSE_DOWN

RIGHT_MOUSE_DOWN: string

- Defined in lib/openfl/events/MouseEvent.d.ts:140

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

This event has the following properties:

### Static RIGHT_MOUSE_UP

RIGHT_MOUSE_UP: string

- Defined in lib/openfl/events/MouseEvent.d.ts:148

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

This event has the following properties:

### Static ROLL_OUT

ROLL_OUT: string

- Defined in lib/openfl/events/MouseEvent.d.ts:156

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

This event has the following properties:

### Static ROLL_OVER

ROLL_OVER: string

- Defined in lib/openfl/events/MouseEvent.d.ts:164

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

This event has the following properties:

### Static SCROLL

SCROLL: string

Inherited from Event.SCROLL

- Defined in lib/openfl/events/Event.d.ts:258

The `Event.SCROLL` constant defines the value of the `type` property of a `scroll` event object.

This event has the following properties:

### Static SELECT

SELECT: string

Inherited from Event.SELECT

- Defined in lib/openfl/events/Event.d.ts:266

The `Event.SELECT` constant defines the value of the `type` property of a `select` event object.

This event has the following properties:

### Static SELECT_ALL

SELECT_ALL: string

Inherited from Event.SELECT_ALL

- Defined in lib/openfl/events/Event.d.ts:268

### Static SOUND_COMPLETE

SOUND_COMPLETE: string

Inherited from Event.SOUND_COMPLETE

- Defined in lib/openfl/events/Event.d.ts:276

The `Event.SOUND_COMPLETE` constant defines the value of the `type` property of a `soundComplete` event object.

This event has the following properties:

### Static TAB_CHILDREN_CHANGE

TAB_CHILDREN_CHANGE: string

Inherited from Event.TAB_CHILDREN_CHANGE

- Defined in lib/openfl/events/Event.d.ts:289

The `Event.TAB_CHILDREN_CHANGE` constant defines the value of the `type` property of a `tabChildrenChange` event object.

This event has the following properties:

### Static TAB_ENABLED_CHANGE

TAB_ENABLED_CHANGE: string

Inherited from Event.TAB_ENABLED_CHANGE

- Defined in lib/openfl/events/Event.d.ts:298

The `Event.TAB_ENABLED_CHANGE` constant defines the value of the `type` property of a `tabEnabledChange` event object.

This event has the following properties:

### Static TAB_INDEX_CHANGE

TAB_INDEX_CHANGE: string

Inherited from Event.TAB_INDEX_CHANGE

- Defined in lib/openfl/events/Event.d.ts:306

The `Event.TAB_INDEX_CHANGE` constant defines the value of the `type` property of a `tabIndexChange` event object.

This event has the following properties:

### Static TEXTURE_READY

TEXTURE_READY: string

Inherited from Event.TEXTURE_READY

- Defined in lib/openfl/events/Event.d.ts:308

### Static UNLOAD

UNLOAD: string

Inherited from Event.UNLOAD

- Defined in lib/openfl/events/Event.d.ts:320

The `Event.UNLOAD` constant defines the value of the `type` property of an `unload` event object.

This event has the following properties:

## Methods

### clone

- clone(): Event

- Inherited from Event.clone

  - Defined in lib/openfl/events/Event.d.ts:424

  Duplicates an instance of an Event subclass.

  Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call `clone()`; the EventDispatcher class calls it automatically when you redispatch an event - that is, when you call `dispatchEvent(event)` from a handler that is handling `event`.

  The new Event object includes all the properties of the original.

  When creating your own custom Event class, you must override the inherited `Event.clone()` method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

  In this example, `PingEvent` is a subclass of `Event` and therefore implements its own version of `clone()`.

  #### Returns Event

  A new Event object that is identical to the original.

### formatToString

- formatToString(className: string, ...args: any[]): string

- Inherited from Event.formatToString

  - Defined in lib/openfl/events/Event.d.ts:427

  #### Parameters

  - ##### className: string

  - ##### Rest ...args: any[]

  #### Returns string

### isDefaultPrevented

- isDefaultPrevented(): boolean

- Inherited from Event.isDefaultPrevented

  - Defined in lib/openfl/events/Event.d.ts:438

  Checks whether the `preventDefault()` method has been called on the event. If the `preventDefault()` method has been called, returns `true`; otherwise, returns `false`.

  #### Returns boolean

  If `preventDefault()` has been called, returns `true`; otherwise, returns `false`.

### preventDefault

- preventDefault(): void

- Inherited from Event.preventDefault

  - Defined in lib/openfl/events/Event.d.ts:447

  Cancels an event's default behavior if that behavior can be canceled. Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the `TextEvent.TEXT_INPUT` event's default behavior can be canceled, you can use the `preventDefault()` method to prevent the character from appearing. An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the `preventDefault()` method has no effect on this default behavior. You can use the `Event.cancelable` property to check whether you can prevent the default behavior associated with a particular event. If the value of `Event.cancelable` is true, then `preventDefault()` can be used to cancel the event; otherwise, `preventDefault()` has no effect.

  #### Returns void

### stopImmediatePropagation

- stopImmediatePropagation(): void

- Inherited from Event.stopImmediatePropagation

  - Defined in lib/openfl/events/Event.d.ts:461

  Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the `stopPropagation()` method doesn't take effect until all the event listeners in the current node finish processing.

  Note: This method does not cancel the behavior associated with this event; see `preventDefault()` for that functionality.

  #### Returns void

### stopPropagation

- stopPropagation(): void

- Inherited from Event.stopPropagation

  - Defined in lib/openfl/events/Event.d.ts:477

  Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node(`currentTarget`). In contrast, the `stopImmediatePropagation()` method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

  Note: This method does not cancel the behavior associated with this event; see `preventDefault()` for that functionality.

  #### Returns void

### toString

- toString(): string

- Inherited from Event.toString

  - Defined in lib/openfl/events/Event.d.ts:489

  Returns a string containing all the properties of the Event object. The string is in the following format:

  `[Event type=_value_ bubbles=_value_ cancelable=_value_]`

  #### Returns string

  A string containing all the properties of the Event object.

### updateAfterEvent

- updateAfterEvent(): void

- - Defined in lib/openfl/events/MouseEvent.d.ts:316

  Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.

  #### Returns void

Generated using TypeDoc