mx.managers.CursorManager - Adobe® Flex® 4 Language Reference (Flex 4)

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.

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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

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 The skin for the busy cursor The default value is `mx.skins.halo.BusyCursor`.	CursorManager
		busyCursorBackground	Type: Class CSS Inheritance: no 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

currentCursorID

property

currentCursorID:int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

ID of the current custom cursor, or NO_CURSOR if the system cursor is showing.

Implementation
public static function get currentCursorID():int
public static function set currentCursorID(value:int):void

currentCursorXOffset

property

currentCursorXOffset:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The x offset of the custom cursor, in pixels, relative to the mouse pointer.

The default value is 0.

Implementation
public static function get currentCursorXOffset():Number
public static function set currentCursorXOffset(value:Number):void

currentCursorYOffset

property

currentCursorYOffset:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The y offset of the custom cursor, in pixels, relative to the mouse pointer.

The default value is 0.

Implementation
public static function get currentCursorYOffset():Number
public static function set currentCursorYOffset(value:Number):void

Method Detail

getInstance

()

method

public static function getInstance():ICursorManager

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Each mx.core.Window instance in an AIR application has its own CursorManager instance. This method returns the CursorManager instance for the main Window instance.

Returns

ICursorManager — The CursorManager instance for the main Window instance in an AIR application.

hideCursor

()

method

public static function hideCursor():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Makes the cursor invisible. Cursor visibility is not reference-counted. A single call to the hideCursor() method always hides the cursor regardless of how many calls to the showCursor() method were made.

Calling this method does not affect the system cursor. Use the Mouse.show() and Mouse.hide() methods to directly control the system cursor.

removeAllCursors

()

method

public static function removeAllCursors():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Removes all of the cursors from the cursor list and restores the system cursor.

removeBusyCursor

()

method

public static function removeBusyCursor():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Removes the busy cursor from the cursor list. If other busy cursor requests are still active in the cursor list, which means you called the setBusyCursor() method more than once, a busy cursor does not disappear until you remove all busy cursors from the list.

removeCursor

()

method

public static function removeCursor(cursorID:int):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Removes a cursor from the cursor list. If the cursor being removed is the currently displayed cursor, the CursorManager displays the next cursor in the list, if one exists. If the list becomes empty, the CursorManager displays the default system cursor.

Parameters

cursorID:int — ID of cursor to remove.

setBusyCursor

()

method

public static function setBusyCursor():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Displays the busy cursor. The busy cursor has a priority of CursorManagerPriority.LOW. Therefore, if the cursor list contains a cursor with a higher priority, the busy cursor is not displayed until you remove the higher priority cursor. To create a busy cursor at a higher priority level, use the setCursor() method.

setCursor

()

method

public static function setCursor(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a new cursor and sets an optional priority for the cursor. Adds the new cursor to the cursor list.

Parameters

	`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.

Returns

int — The ID of the cursor.

showCursor

()

method

public static function showCursor():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Makes the cursor visible. Cursor visibility is not reference-counted. A single call to the showCursor() method always shows the cursor regardless of how many calls to the hideCursor() method were made.

Calling this method does not affect the system cursor. Use the Mouse.show() and Mouse.hide() methods to directly control the system cursor.

Constant Detail

NO_CURSOR

Constant

public static const NO_CURSOR:int = 0

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.