class flash.ui.Mouse

Available on all platforms

The methods of the Mouse class are used to hide and show the mouse pointer, * or to set the pointer to a specific style. The Mouse class is a top-level * class whose properties and methods you can access without using a * constructor. The pointer is visible by default, * but you can hide it and implement a custom pointer.

Class Fields

static var cursor:Dynamic

Sets or returns the type of cursor, or, for a native cursor, the cursor * name. *

The default value is flash.ui.MouseCursor.AUTO.

*

To set values for this property, use the following string values:

* *

Note: For Flash Player 10.2 or AIR 2.6 and later versions, this * property sets or gets the cursor name when you are using a native cursor. * A native cursor name defined using Mouse.registerCursor() * overwrites currently predefined cursor types(such as * flash.ui.MouseCursor.IBEAM).

* *

static var supportsCursor:Bool

Indicates whether the computer or device displays a persistent cursor. *

The supportsCursor property is true on most * desktop computers and false on most mobile devices.

*

Note: Mouse events can be dispatched whether or not this * property is true. However, mouse events may behave * differently depending on the physical characteristics of the pointing * device.

static function hide():Void

Indicates whether the current configuration supports native cursors.

static function show():Void

Registers a native cursor under the given name, with the given data. * *

name

The name to use as a reference to the native cursor * instance. *

cursor

The properties for the native cursor, such as icon bitmap, * specified as a MouseCursorData instance.