Creates an Event object that contains information about mouse events. Event objects are passed as parameters to event listeners.
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.
Determines whether the Event object participates in the bubbling phase of the event flow.
Determines whether the Event object can be canceled.
The horizontal coordinate at which the event occurred relative to the containing sprite.
The vertical coordinate at which the event occurred relative to the containing sprite.
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.
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.
Indicates whether the Alt key is activated(Windows or Linux only).
Indicates whether the Shift key is activated.
Indicates whether the primary mouse button is pressed.
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.
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.
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.
Indicates whether the primary mouse button is pressed(true)
or not(false).
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.
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.
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.
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.
The current phase in the event flow. This property can contain the following numeric values:
EventPhase.CAPTURING_PHASE).EventPhase.AT_TARGET).EventPhase.BUBBLING_PHASE).The horizontal coordinate at which the event occurred relative to the containing sprite.
The vertical coordinate at which the event occurred relative to the containing sprite.
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.
Indicates whether the Shift key is active(true) or inactive
(false).
The horizontal coordinate at which the event occurred in global Stage
coordinates. This property is calculated when the localX
property is set.
The vertical coordinate at which the event occurred in global Stage
coordinates. This property is calculated when the localY
property is set.
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.
The type of event. The type is case-sensitive.
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:
The Event.ADDED constant defines the value of the
type property of an added event object.
This event has the following properties:
The Event.ADDED_TO_STAGE constant defines the value of the
type property of an addedToStage event object.
This event has the following properties:
The Event.CANCEL constant defines the value of the
type property of a cancel event object.
This event has the following properties:
The Event.CHANGE constant defines the value of the
type property of a change event object.
This event has the following properties:
Defines the value of the type property of a
click event object.
This event has the following properties:
The Event.CLOSE constant defines the value of the
type property of a close event object.
This event has the following properties:
The Event.COMPLETE constant defines the value of the
type property of a complete event object.
This event has the following properties:
The Event.CONNECT constant defines the value of the
type property of a connect event object.
This event has the following properties:
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:
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:
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:
The Event.ID3 constant defines the value of the
type property of an id3 event object.
This event has the following properties:
The Event.INIT constant defines the value of the
type property of an init event object.
This event has the following properties:
Defines the value of the type property of a
middleClick event object.
This event has the following properties:
Defines the value of the type property of a
middleMouseDown event object.
This event has the following properties:
Defines the value of the type property of a
middleMouseUp event object.
This event has the following properties:
Defines the value of the type property of a
mouseDown event object.
This event has the following properties:
The Event.MOUSE_LEAVE constant defines the value of the
type property of a mouseLeave event object.
This event has the following properties:
Defines the value of the type property of a
mouseMove event object.
This event has the following properties:
Defines the value of the type property of a
mouseOut event object.
This event has the following properties:
Defines the value of the type property of a
mouseOver event object.
This event has the following properties:
Defines the value of the type property of a
mouseUp event object.
This event has the following properties:
Defines the value of the type property of a
mouseWheel event object.
This event has the following properties:
The Event.OPEN constant defines the value of the
type property of an open event object.
This event has the following properties:
Defines the value of the type property of a
releaseOutside event object.
This event has the following properties:
The Event.REMOVED constant defines the value of the
type property of a removed event object.
This event has the following properties:
The Event.REMOVED_FROM_STAGE constant defines the value of
the type property of a removedFromStage event
object.
This event has the following properties:
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:
The Event.RESIZE constant defines the value of the
type property of a resize event object.
This event has the following properties:
Defines the value of the type property of a
rightClick event object.
This event has the following properties:
Defines the value of the type property of a
rightMouseDown event object.
This event has the following properties:
Defines the value of the type property of a
rightMouseUp event object.
This event has the following properties:
Defines the value of the type property of a
rollOut event object.
This event has the following properties:
Defines the value of the type property of a
rollOver event object.
This event has the following properties:
The Event.SCROLL constant defines the value of the
type property of a scroll event object.
This event has the following properties:
The Event.SELECT constant defines the value of the
type property of a select event object.
This event has the following properties:
The Event.SOUND_COMPLETE constant defines the value of the
type property of a soundComplete event object.
This event has the following properties:
The Event.TAB_CHILDREN_CHANGE constant defines the value of
the type property of a tabChildrenChange event
object.
This event has the following properties:
The Event.TAB_ENABLED_CHANGE constant defines the value of
the type property of a tabEnabledChange event
object.
This event has the following properties:
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object.
This event has the following properties:
The Event.UNLOAD constant defines the value of the
type property of an unload event object.
This event has the following properties:
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().
A new Event object that is identical to the original.
Checks whether the preventDefault() method has been called on
the event. If the preventDefault() method has been called,
returns true; otherwise, returns false.
If preventDefault() has been called, returns
true; otherwise, returns false.
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.
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.
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 a string containing all the properties of the Event object. The string is in the following format:
[Event type=_value_ bubbles=_value_
cancelable=_value_]
A string containing all the properties of the Event object.
Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
Generated using TypeDoc
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 thetypeparameter set to the specific mouse event you want to detect.