flash.events.ScreenMouseEvent - Adobe® Flex® 4 Language Reference (Flex 4)

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.

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 The horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number The vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLICK : String = "click" [static] The ScreenMouseEvent.CLICK constant defines the value of the type property of a click event object.	ScreenMouseEvent
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		CONTEXT_MENU : String = "contextMenu" [static] The MouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object.	MouseEvent
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		DOUBLE_CLICK : String = "doubleClick" [static] Defines the value of the type property of a doubleClick event object.	MouseEvent
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MIDDLE_CLICK : String = "middleClick" [static] Defines the value of the type property of a middleClick event object.	MouseEvent
		MIDDLE_MOUSE_DOWN : String = "middleMouseDown" [static] Defines the value of the type property of a middleMouseDown event object.	MouseEvent
		MIDDLE_MOUSE_UP : String = "middleMouseUp" [static] Defines the value of the type property of a middleMouseUp event object.	MouseEvent
		MOUSE_DOWN : String = "mouseDown" [static] The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type property of a mouseDown event object.	ScreenMouseEvent
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		MOUSE_MOVE : String = "mouseMove" [static] Defines the value of the type property of a mouseMove event object.	MouseEvent
		MOUSE_OUT : String = "mouseOut" [static] Defines the value of the type property of a mouseOut event object.	MouseEvent
		MOUSE_OVER : String = "mouseOver" [static] Defines the value of the type property of a mouseOver event object.	MouseEvent
		MOUSE_UP : String = "mouseUp" [static] The ScreenMouseEvent.MOUSE_UP constant defines the value of the type property of a mouseUp event object.	ScreenMouseEvent
		MOUSE_WHEEL : String = "mouseWheel" [static] Defines the value of the type property of a mouseWheel event object.	MouseEvent
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		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
		ROLL_OUT : String = "rollOut" [static] Defines the value of the type property of a rollOut event object.	MouseEvent
		ROLL_OVER : String = "rollOver" [static] Defines the value of the type property of a rollOver event object.	MouseEvent
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.	Event
		STANDARD_INPUT_CLOSE : String = "standardInputClose" [static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.	Event
		STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

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.

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.