class MouseEvent

package openfl.events

extends Event

Available on all platforms

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.

Constructor

new (type:String, bubbles:Bool = true, cancelable:Bool = false, localX:Float = 0, localY:Float = 0, ?relatedObject:InteractiveObject, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, buttonDown:Bool = false, delta:Int = 0, commandKey:Bool = false, clickCount:Int = 0)

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

Parameters:

type

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

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

cancelable

Determines whether the Event object can be canceled.

localX

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

localY

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

relatedObject

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

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

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

shiftKey

Indicates whether the Shift key is activated.

buttonDown

Indicates whether the primary mouse button is pressed.

delta

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.

Variables

altKey:Bool

Indicates whether the Alt key is active(true) or inactive (false). Supported for Windows only. On other operating systems, this property is always set to false.

buttonDown:Bool

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

clickCount:Int

commandKey:Bool

ctrlKey:Bool

On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive(false). On Macintosh, indicates whether either the Control key or the Command key is activated.

delta:Int

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

isRelatedObjectInaccessible:Bool

localX:Float

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

localY:Float

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

relatedObject:InteractiveObject

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:Bool

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

stageX:Float

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

stageY:Float

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

Methods

updateAfterEvent ():Void

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

Static variables

staticinline read onlyCLICK:String = "click"

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

This event has the following properties:

staticinline read onlyDOUBLE_CLICK:String = "doubleClick"

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:

staticinline read onlyMIDDLE_CLICK:String = "middleClick"

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

This event has the following properties:

staticinline read onlyMIDDLE_MOUSE_DOWN:String = "middleMouseDown"

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

This event has the following properties:

staticinline read onlyMIDDLE_MOUSE_UP:String = "middleMouseUp"

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

This event has the following properties:

staticinline read onlyMOUSE_DOWN:String = "mouseDown"

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

This event has the following properties:

staticinline read onlyMOUSE_MOVE:String = "mouseMove"

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

This event has the following properties:

staticinline read onlyMOUSE_OUT:String = "mouseOut"

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

This event has the following properties:

staticinline read onlyMOUSE_OVER:String = "mouseOver"

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

This event has the following properties:

staticinline read onlyMOUSE_UP:String = "mouseUp"

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

This event has the following properties:

staticinline read onlyMOUSE_WHEEL:String = "mouseWheel"

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

This event has the following properties:

staticinline read onlyRELEASE_OUTSIDE:String = "releaseOutside"

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

This event has the following properties:

staticinline read onlyRIGHT_CLICK:String = "rightClick"

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

This event has the following properties:

staticinline read onlyRIGHT_MOUSE_DOWN:String = "rightMouseDown"

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

This event has the following properties:

staticinline read onlyRIGHT_MOUSE_UP:String = "rightMouseUp"

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

This event has the following properties:

staticinline read onlyROLL_OUT:String = "rollOut"

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

This event has the following properties:

staticinline read onlyROLL_OVER:String = "rollOver"

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

This event has the following properties:

Inherited Variables

Defined by Event

read onlybubbles:Bool

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.

read onlycancelable:Bool

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.

read onlycurrentTarget:Any

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.

read onlyeventPhase:EventPhase

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

read onlytarget:Any

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.

read onlytype:String

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

Inherited Methods

Defined by Event

clone ():Event

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:

A new Event object that is identical to the original.

formatToString (className:String, ?p1:Dynamic, ?p2:Dynamic, ?p3:Dynamic, ?p4:Dynamic, ?p5:Dynamic):String

isDefaultPrevented ():Bool

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

Returns:

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

preventDefault ():Void

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.

stopImmediatePropagation ():Void

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.

stopPropagation ():Void

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.

toString ():String

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:

A string containing all the properties of the Event object.