CursorManager - BETA ActionScript® 3 (AS3 Flex) Reference for the Adobe® Flash® Platform API Reference

(Preview)

Package	mx.managers
Class	public class CursorManager
Inheritance	CursorManager Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The CursorManager class controls a prioritized list of cursors, where the cursor with the highest priority is currently visible. If the cursor list contains more than one cursor with the same priority, the Cursor Manager displays the most recently created cursor.

For example, if your application performs processing that requires the user to wait until the processing completes, you can change the cursor so that it reflects the waiting period. In this case, you can change the cursor to an hourglass or other image.

You also might want to change the cursor to provide feedback to the user to indicate the actions that the user can perform. For example, you can use one cursor image to indicate that user input is enabled, and another to indicate that input is disabled. You can use a JPEG, GIF, PNG, or SVG image, a Sprite object, or a SWF file as the cursor image.

All methods and properties of the CursorManager are static, so you do not need to create an instance of it.

In AIR, each mx.core.Window instance uses its own instance of the CursorManager class. Instead of directly referencing the static methods and properties of the CursorManager class, use the Window.cursorManager property to reference the CursorManager instance for the Window instance.

More examples

Cursors in sandboxed applications
Cursors in multi-versioned applications

Related API Elements

mx.managers.CursorManagerPriority
mx.core.Window

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentCursorID : int [static] ID of the current custom cursor, or NO_CURSOR if the system cursor is showing.	CursorManager
		currentCursorXOffset : Number [static] The x offset of the custom cursor, in pixels, relative to the mouse pointer.	CursorManager
		currentCursorYOffset : Number [static] The y offset of the custom cursor, in pixels, relative to the mouse pointer.	CursorManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		getInstance():ICursorManager [static] Each mx.core.Window instance in an AIR application has its own CursorManager instance.	CursorManager
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hideCursor():void [static] Makes the cursor invisible.	CursorManager
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeAllCursors():void [static] Removes all of the cursors from the cursor list and restores the system cursor.	CursorManager
		removeBusyCursor():void [static] Removes the busy cursor from the cursor list.	CursorManager
		removeCursor(cursorID:int):void [static] Removes a cursor from the cursor list.	CursorManager
		setBusyCursor():void [static] Displays the busy cursor.	CursorManager
		setCursor(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int [static] Creates a new cursor and sets an optional priority for the cursor.	CursorManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		showCursor():void [static] Makes the cursor visible.	CursorManager
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

	Style		Description	Defined By
		busyCursor	Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The skin for the busy cursor. The default value is `mx.skins.halo.BusyCursor`.	CursorManager
		busyCursorBackground	Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The class to use as the skin for the busy cursor background. The default value is the "cursorStretch" symbol from the Assets.swf file.	CursorManager

Public Constants

	Constant		Defined By
		NO_CURSOR : int = 0 [static] Constant that is the value of currentCursorID property when there is no cursor managed by the CursorManager and therefore the system cursor is being displayed.	CursorManager

Property Detail

Method Detail

Constant Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

	`cursorClass:Class` — Class of the cursor to display.

	`priority:int` (default = `2`) — Integer that specifies the priority level of the cursor. Possible values are `CursorManagerPriority.HIGH`, `CursorManagerPriority.MEDIUM`, and `CursorManagerPriority.LOW`.

	`xOffset:Number` (default = `0`) — Number that specifies the x offset of the cursor, in pixels, relative to the mouse pointer.

	`yOffset:Number` (default = `0`) — Number that specifies the y offset of the cursor, in pixels, relative to the mouse pointer.

CursorManager - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.managers

currentCursorID

currentCursorXOffset

currentCursorYOffset

getInstance

hideCursor

removeAllCursors

removeBusyCursor

removeCursor

setBusyCursor

setCursor

showCursor

NO_CURSOR