パッケージmx.managers
public class CursorManager
継承CursorManager Inheritance Object

Cursor Manager クラスではカーソルの優先順位リストが制御されており、リスト内で優先度が最も高いカーソルが表示されます。カーソルリストに、同じ優先度を持つカーソルが複数ある場合、最も新しく作成されたカーソルが表示されます。

たとえば、完了するまでユーザーが待つ必要があるような処理がアプリケーションで実行される場合、カーソルを変更することで、今は待ち状態であることを表すことができます。この場合は、カーソルを砂時計などのイメージに変更します。

また、ユーザーが実行できるアクションを示すために、カーソルを変更してユーザーにフィードバックする場合もあります。たとえば、入力が有効な場合を示すカーソルイメージと、入力が無効な場合を示すカーソルイメージを変えることができます。カーソルイメージには、JPEG、GIF、PNG、または SVG イメージや、Sprite オブジェクト、SWF ファイルを使用できます。

CursorManager のメソッドとプロパティはすべて静的なので、そのインスタンスを作成する必要はありません。

関連項目

mx.managers.CursorManagerPriority


パブリックプロパティ
 プロパティ定義
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  currentCursorID : int = 0
[static] 現在のカスタムカーソルの ID です。システムカーソルが表示されている場合は NO_CURSOR になります。
CursorManager
  currentCursorXOffset : Number = 0
[static] マウスポインタを基準としたカスタムカーソルの x オフセット (ピクセル単位) です。
CursorManager
  currentCursorYOffset : Number = 0
[static] マウスポインタを基準としたカスタムカーソルの y オフセット (ピクセル単位) です。
CursorManager
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリックメソッド
 メソッド定義
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  hideCursor():void
[static] カーソルを非表示にします。
CursorManager
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
  removeAllCursors():void
[static] カーソルリストからすべてのカーソルを削除して、システムカーソルを復元します。
CursorManager
  removeBusyCursor():void
[static] カーソルリストからビジーカーソルを削除します。
CursorManager
  removeCursor(cursorID:int):void
[static] カーソルリストから 1 つのカーソルを削除します。
CursorManager
  setBusyCursor():void
[static] ビジーカーソルを表示します。
CursorManager
  setCursor(cursorClass:Class, priority:int = 2, xOffset:Number = 0, yOffset:Number = 0):int
[static] 新しいカーソルを作成し、必要に応じてカーソルに優先度を設定します。
CursorManager
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  showCursor():void
[static] カーソルを表示します。
CursorManager
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
スタイル
 スタイル説明定義
  
busyCursor
型: Class   CSS の継承: no
ビジーカーソルのスキン デフォルト値mx.skins.halo.BusyCursor.
CursorManager
パブリック定数
 定数定義
  NO_CURSOR : int = 0
[static] CursorManager で管理されているカーソルがないため、システムカーソルが表示されている場合に、currentCursorID プロパティの値となる定数です。
CursorManager
プロパティの詳細
currentCursorIDプロパティ
public static var currentCursorID:int = 0

現在のカスタムカーソルの ID です。システムカーソルが表示されている場合は NO_CURSOR になります。

currentCursorXOffsetプロパティ 
public static var currentCursorXOffset:Number = 0

マウスポインタを基準としたカスタムカーソルの x オフセット (ピクセル単位) です。

デフォルト値0.

currentCursorYOffsetプロパティ 
public static var currentCursorYOffset:Number = 0

マウスポインタを基準としたカスタムカーソルの y オフセット (ピクセル単位) です。

デフォルト値0.

メソッドの詳細
hideCursor()メソッド
public static function hideCursor():void

カーソルを非表示にします。カーソルの可視性は参照カウントされません。showCursor() メソッドの呼び出し回数にかかわらず、1 回の hideCursor() メソッドの呼び出しで、常にカーソルが非表示になります。

removeAllCursors()メソッド 
public static function removeAllCursors():void

カーソルリストからすべてのカーソルを削除して、システムカーソルを復元します。

removeBusyCursor()メソッド 
public static function removeBusyCursor():void

カーソルリストからビジーカーソルを削除します。他のビジーカーソル要求がカーソルリスト内でまだアクティブな場合、つまり setBusyCursor() メソッドを 2 回以上呼び出していた場合には、ビジーカーソルがリストからすべて削除されるまで、ビジーカーソルは消えません。

removeCursor()メソッド 
public static function removeCursor(cursorID:int):void

カーソルリストから 1 つのカーソルを削除します。削除対象のカーソルが現在表示されている場合、CursorManager は、リスト内に次のカーソルがあれば、そのカーソルを表示します。リストが空になると、CursorManager はデフォルトのシステムカーソルを表示します。

パラメータ
cursorID:int — 削除するカーソルの ID です。
setBusyCursor()メソッド 
public static function setBusyCursor():void

ビジーカーソルを表示します。ビジーカーソルの優先度は CursorManagerPriority.LOW です。このため、これより高い優先度のカーソルがカーソルリストに含まれている場合、そのカーソルが削除されるまでビジーカーソルは表示されません。より高い優先度のビジーカーソルを作成するには、setCursor() メソッドを使用します。

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

新しいカーソルを作成し、必要に応じてカーソルに優先度を設定します。新しいカーソルはカーソルリストに追加されます。

パラメータ
cursorClass:Class — 表示するカーソルのクラスです。
 
priority:int (default = 2) — カーソルの優先度レベルを指定する整数。有効な値は、CursorManagerPriority.HIGHCursorManagerPriority.MEDIUM、および CursorManagerPriority.LOW です。
 
xOffset:Number (default = 0) — マウスポインタを基準としたカーソルの x オフセットをピクセル単位で指定する数値です。
 
yOffset:Number (default = 0) — マウスポインタを基準としたカーソルの y オフセットをピクセル単位で指定する数値です。

戻り値
int — カーソルの ID です。

関連項目

showCursor()メソッド 
public static function showCursor():void

カーソルを表示します。カーソルの可視性は参照カウントされません。hideCursor() メソッドの呼び出し回数にかかわらず、1 回の showCursor() メソッドの呼び出しで、常にカーソルが表示されます。

定数の詳細
NO_CURSOR定数
public static const NO_CURSOR:int = 0

CursorManager で管理されているカーソルがないため、システムカーソルが表示されている場合に、currentCursorID プロパティの値となる定数です。