import { InteractiveObject } from "../display/InteractiveObject";
import { Event } from "./Event";
import { MouseEvent as MouseEventAway } from "@awayjs/scene";
/**
/// @eventType flash.events.MouseEvent.CLICK
[Event(name="click", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.CONTEXT_MENU
[Event(name="contextMenu", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.DOUBLE_CLICK
[Event(name="doubleClick", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MIDDLE_CLICK
[Event(name="middleClick", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MIDDLE_MOUSE_DOWN
[Event(name="middleMouseDown", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MIDDLE_MOUSE_UP
[Event(name="middleMouseUp", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MOUSE_DOWN
[Event(name="mouseDown", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MOUSE_MOVE
[Event(name="mouseMove", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MOUSE_OUT
[Event(name="mouseOut", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MOUSE_OVER
[Event(name="mouseOver", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MOUSE_UP
[Event(name="mouseUp", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.MOUSE_WHEEL
[Event(name="mouseWheel", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.RIGHT_CLICK
[Event(name="rightClick", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.RIGHT_MOUSE_DOWN
[Event(name="RightMouseDown", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.RIGHT_MOUSE_UP
[Event(name="rightMouseUp", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.ROLL_OUT
[Event(name="rollOut", type="flash.events.MouseEvent")]
/// @eventType flash.events.MouseEvent.ROLL_OVER
[Event(name="rollOver", type="flash.events.MouseEvent")]
* 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.
*
* EXAMPLE:
*
* 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:
* - The example declares properties for the size (100 x 100 pixels) and the background color
* (orange) for later use in drawing the square.
- 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.
- 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.
*/
export declare class MouseEvent extends Event {
/**
* Defines the value of the type property of a click event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDownFor 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static CLICK: string;
/**
* The MouseEvent.CONTEXT_MENU constant defines the value of the
* type property of a contextMenu event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static CONTEXT_MENU: string;
/**
* 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:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDownFor 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static DOUBLE_CLICK: string;
/**
* Defines the value of the type property of a middleClick event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDownFor 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static MIDDLE_CLICK: string;
/**
* Defines the value of the type property of a middleMouseDown event object.
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static MIDDLE_MOUSE_DOWN: string;
/**
* Defines the value of the type property of a middleMouseUp event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static MIDDLE_MOUSE_UP: string;
/**
* Defines the value of the type property of a mouseDown event object.
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static MOUSE_DOWN: string;
/**
* Defines the value of the type property of a mouseMove event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static MOUSE_MOVE: string;
/**
* Defines the value of the type property of a mouseOut event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static MOUSE_OUT: string;
/**
* Defines the value of the type property of a mouseOver event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static MOUSE_OVER: string;
/**
* Defines the value of the type property of a mouseUp event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
static MOUSE_UP: string;
/**
* Defines the value of the type property of a mouseWheel event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion Flash 9
*/
static MOUSE_WHEEL: string;
static RELEASE_OUTSIDE: string;
/**
* Defines the value of the type property of a rightClick event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDownFor 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static RIGHT_CLICK: string;
/**
* Defines the value of the type property of a rightMouseDown event object.
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDownFor 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static RIGHT_MOUSE_DOWN: string;
/**
* Defines the value of the type property of a rightMouseUp event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblestruebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
* @langversion 3.0
* @playerversion AIR 1.0
* @playerversion Lite 4
*/
static RIGHT_MOUSE_UP: string;
/**
* Defines the value of the type property of a rollOut event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblesfalsebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
*/
static ROLL_OUT: string;
/**
* Defines the value of the type property of a rollOver event object.
*
* This event has the following properties:PropertyValuealtKeytrue if the Alt key is active (Windows).bubblesfalsebuttonDowntrue 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.localYThe vertical coordinate at which the event occurred relative to the containing sprite.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.
*/
static ROLL_OVER: string;
/**
* 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.
* @internal Reserved in case Desktop Player wants to capture this key in a future implementation.
* The Option key modifier on Macintosh system must be represented using this key modifier. So far, it seems
* only the Windows version is hooked up.
*/
private _altKey;
altKey: boolean;
/**
* Indicates whether the primary mouse button is pressed (true) or not (false).
*/
private _buttonDown;
buttonDown: boolean;
/**
* 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.
*/
private _ctrlKey;
ctrlKey: boolean;
/**
* 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.
* @langversion 3.0
* @playerversion Flash 9
* @playerversion Lite 4
*/
private _delta;
delta: number;
/**
* 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.
* @langversion 3.0
* @playerversion Flash 10
* @playerversion Lite 4
*/
private _isRelatedObjectInaccessible;
isRelatedObjectInaccessible: boolean;
/**
* The horizontal coordinate at which the event occurred relative to the containing sprite.
*/
private _localX;
localX: number;
/**
* The vertical coordinate at which the event occurred relative to the containing sprite.
*/
private _localY;
localY: number;
private _movementX;
movementX: number;
private _movementY;
movementY: number;
/**
* 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.
*/
private _relatedObject;
relatedObject: InteractiveObject;
/**
* Indicates whether the Shift key is active (true) or inactive
* (false).
*/
private _shiftKey;
shiftKey: boolean;
/**
* The horizontal coordinate at which the event occurred in global Stage coordinates.
* This property is calculated when the localX property is set.
*/
private _stageX;
readonly stageX: number;
/**
* The vertical coordinate at which the event occurred in global Stage coordinates.
* This property is calculated when the localY property is set.
*/
private _stageY;
readonly stageY: number;
/**
* Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
* @return A new MouseEvent object with property values that match those of the original.
*/
clone(): Event;
/**
* Creates an Event object that contains information about mouse events.
* Event objects are passed as parameters to event listeners.
* @param 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.
* @param bubbles Determines whether the Event object participates in the bubbling phase of the event flow.
* @param cancelable Determines whether the Event object can be canceled.
* @param localX The horizontal coordinate at which the event occurred relative to the containing sprite.
* @param localY The vertical coordinate at which the event occurred relative to the containing sprite.
* @param 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.
* @param 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.
* @param altKey Indicates whether the Alt key is activated (Windows or Linux only).
* @param shiftKey Indicates whether the Shift key is activated.
* @param buttonDown Indicates whether the primary mouse button is pressed.
* @param 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.
* @param commandKey (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.
* @param controlKey (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.
* @param clickCount (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.
*/
constructor(type: string, bubbles?: boolean, cancelable?: boolean, localX?: number, localY?: number, relatedObject?: InteractiveObject, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean, buttonDown?: boolean, delta?: number);
fillFromJS(jsEvent: any): void;
fillFromAway(awayEvent: MouseEventAway): void;
/**
* 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]
* @return A string that contains all the properties of the MouseEvent object.
*/
toString(): string;
/**
* Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
*/
updateAfterEvent(): void;
}