flash.events

# ScreenMouseEvent - AS3

Package | flash.events
Class | public class ScreenMouseEvent
Inheritance | ScreenMouseEvent MouseEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

The SystemTrayIcon object dispatches events of type ScreenMouseEvent in response to mouse interaction.

The ScreenMouseEvent object extends the MouseEvent class to provide two additional properties, `screenX` and `screenY`, that report the mouse coordinates in relation to the primary desktop screen rather than an application window or stage.

Related API Elements

flash.desktop.SystemTrayIcon
flash.display.Screen

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | altKey : Boolean Indicates whether the Alt key is active (true) or inactive (false). | MouseEvent
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | buttonDown : Boolean Indicates whether the primary mouse button is pressed (true) or not (false). | MouseEvent
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | clickCount : int [read-only] Indicates whether or not the mouse down event is part of a multi-click sequence. | MouseEvent
|  | commandKey : Boolean Indicates whether the command key is activated (Mac only.) The value of property commandKey will have the same value as property ctrlKey on the Mac. | MouseEvent
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | controlKey : Boolean Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux. | MouseEvent
|  | ctrlKey : Boolean On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). | MouseEvent
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | delta : int Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. | MouseEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | isRelatedObjectInaccessible : Boolean If true, the relatedObject property is set to null for reasons related to security sandboxes. | MouseEvent
|  | localX : Number When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite. | MouseEvent
|  | localY : Number When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite. | MouseEvent
|  | movementX : Number When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event. | MouseEvent
|  | movementY : Number When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event. | MouseEvent
|  | relatedObject : InteractiveObject A reference to a display list object that is related to the event. | MouseEvent
|  | screenX : Number [read-only] The X position of the click in screen coordinates. | ScreenMouseEvent
|  | screenY : Number [read-only] The Y position of the click in screen coordinates. | ScreenMouseEvent
|  | shiftKey : Boolean Indicates whether the Shift key is active (true) or inactive (false). | MouseEvent
|  | stageX : Number [read-only] The horizontal coordinate at which the event occurred in global Stage coordinates. | MouseEvent
|  | stageY : Number [read-only] The vertical coordinate at which the event occurred in global Stage coordinates. | MouseEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ScreenMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, screenX:Number = NaN, screenY:Number = NaN, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)
Creates a ScreenMouseEvent object that contains the mouse location in screen coordinates.
ScreenMouseEvent
|  | clone():Event [override] Creates a copy of the ScreenMouseEvent object and sets the value of each property to match that of the original. | ScreenMouseEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the ScreenMouseEvent object. | ScreenMouseEvent
|  | updateAfterEvent():void Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified. | MouseEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CLICK : String = "click" [static] The ScreenMouseEvent.CLICK constant defines the value of the type property of a click event object. | ScreenMouseEvent
|  | MOUSE_DOWN : String = "mouseDown" [static] The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type property of a mouseDown event object. | ScreenMouseEvent
|  | MOUSE_UP : String = "mouseUp" [static] The ScreenMouseEvent.MOUSE_UP constant defines the value of the type property of a mouseUp event object. | ScreenMouseEvent
|  | RIGHT_CLICK : String = "rightClick" [static] The ScreenMouseEvent.RIGHT_CLICK constant defines the value of the type property of a rightClick event object. | ScreenMouseEvent
|  | RIGHT_MOUSE_DOWN : String = "rightMouseDown" [static] The ScreenMouseEvent.RIGHT_MOUSE_DOWN constant defines the value of the type property of a rightMouseDown event object. | ScreenMouseEvent
|  | RIGHT_MOUSE_UP : String = "rightMouseUp" [static] The ScreenMouseEvent.RIGHT_MOUSE_UP constant defines the value of the type property of a rightMouseUp event object. | ScreenMouseEvent

Property Detail

### screenX

property

`screenX:Number` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

The X position of the click in screen coordinates.

Implementation
`public function get screenX():Number`

### screenY

property

`screenY:Number` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

The Y position of the click in screen coordinates.

Implementation
`public function get screenY():Number`
Constructor Detail

### ScreenMouseEvent

()
Constructor

`public function ScreenMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, screenX:Number = NaN, screenY:Number = NaN, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Creates a ScreenMouseEvent object that contains the mouse location in screen coordinates.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property.
| `bubbles:Boolean` (default = `false`)`` — The X position of the click in screen coordinates.
| `cancelable:Boolean` (default = `false`)`` — The Y position of the click in screen coordinates.
| `screenX:Number` (default = `NaN`)`` — Set to `false` since screen mouse events never bubble.
| `screenY:Number` (default = `NaN`)`` — Set to `false` since there is no default behavior to cancel.
| `ctrlKey:Boolean` (default = `false`)`` — On Windows or Linux, indicates whether the Ctrl key was down when this event occurred. On Mac, indicates whether the Ctrl key or the Command key was down.
| `altKey:Boolean` (default = `false`)`` — Set to `true` to indicate that the alt key was down when this event occured.
| `shiftKey:Boolean` (default = `false`)`` — Set to `true` to indicate that the shift key was down when this event occured.
| `buttonDown:Boolean` (default = `false`)`` — Set to `true` to indicate that a mouse button was down when this event occured.
| `commandKey:Boolean` (default = `false`)`` — Indicates whether the Command key was down (Mac only).
| `controlKey:Boolean` (default = `false`)`` — Indicates whether the Ctrl or Control key was down.

Related API Elements

flash.events.MouseEvent
flash.display.Screen
Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

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

Returns

| `Event` — A new ScreenMouseEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

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

`[ScreenMouseEvent type=value bubbles=value cancelable=value status=value]`

Returns

| `String` — A string that contains all the properties of the ScreenMouseEvent object.

Constant Detail

### CLICK

Constant

`public static const CLICK:String = "click"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

The `ScreenMouseEvent.CLICK` constant defines the value of the `type` property of a `click` event object.

This event has the following relevant properties:

Property | Value
--- | ---
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey` | `true` 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`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX` | The horizontal coordinate at which the event occurred in screen coordinates.
`screenY` | The vertical coordinate at which the event occurred in screen coordinates.
`target` | The SystemTrayIcon object under the pointing device.

### MOUSE_DOWN

Constant

`public static const MOUSE_DOWN:String = "mouseDown"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

The `ScreenMouseEvent.MOUSE_DOWN` constant defines the value of the `type` property of a `mouseDown` event object.

This event has the following relevant properties:

Property | Value
--- | ---
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey` | `true` 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`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX` | The horizontal coordinate at which the event occurred in screen coordinates.
`screenY` | The vertical coordinate at which the event occurred in screen coordinates.
`target` | The SystemTrayIcon object under the pointing device.

### MOUSE_UP

Constant

`public static const MOUSE_UP:String = "mouseUp"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

The `ScreenMouseEvent.MOUSE_UP` constant defines the value of the `type` property of a `mouseUp` event object.

This event has the following relevant properties:

Property | Value
--- | ---
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey` | `true` 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`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX` | The horizontal coordinate at which the event occurred in screen coordinates.
`screenY` | The vertical coordinate at which the event occurred in screen coordinates.
`target` | The SystemTrayIcon object under the pointing device.

### RIGHT_CLICK

Constant

`public static const RIGHT_CLICK:String = "rightClick"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

The `ScreenMouseEvent.RIGHT_CLICK` constant defines the value of the `type` property of a `rightClick` event object.

This event has the following relevant properties:

Property | Value
--- | ---
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey` | `true` 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`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX` | The horizontal coordinate at which the event occurred in screen coordinates.
`screenY` | The vertical coordinate at which the event occurred in screen coordinates.
`target` | The SystemTrayIcon object under the pointing device.

### RIGHT_MOUSE_DOWN

Constant

`public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

The `ScreenMouseEvent.RIGHT_MOUSE_DOWN` constant defines the value of the `type` property of a `rightMouseDown` event object.

This event has the following relevant properties:

Property | Value
--- | ---
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey` | `true` 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`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX` | The horizontal coordinate at which the event occurred in screen coordinates.
`screenY` | The vertical coordinate at which the event occurred in screen coordinates.
`target` | The SystemTrayIcon object under the pointing device.

### RIGHT_MOUSE_UP

Constant

`public static const RIGHT_MOUSE_UP:String = "rightMouseUp"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.5

The `ScreenMouseEvent.RIGHT_MOUSE_UP` constant defines the value of the `type` property of a `rightMouseUp` event object.

This event has the following relevant properties:

Property | Value
--- | ---
`buttonDown` | `true` if the primary mouse button is pressed; `false` otherwise.
`ctrlKey` | `true` 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`.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`commandKey` | `true` on the Mac if the Command key is active; `false` if it is inactive. Always `false` on Windows.
`controlKey` | `true` if the Ctrl or Control key is active; `false` if it is inactive.
`screenX` | The horizontal coordinate at which the event occurred in screen coordinates.
`screenY` | The vertical coordinate at which the event occurred in screen coordinates.
`target` | The SystemTrayIcon object under the pointing device.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00