メソッド | プロパティ フレームあり | フレームなし

mx.managers
CursorManager クラス




CursorManager クラス

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

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

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

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



メソッド
statichideCursor( )
カーソルを非表示にします。
staticremoveAllCursors( ) :  Void
カーソルリストからすべてのカーソルを削除して、システムカーソルを復元します。
staticremoveBusyCursor( ) :  Void
カーソルリストからビジーカーソルを削除します。
staticremoveCursor( cursorID:Number) :  Void
カーソルリストから 1 つのカーソルを削除します。
staticsetBusyCursor( ) :  Void
ビジーカーソルを表示します。
staticsetCursor( cursorSymbol:String, priorityLevel:Number, xOffset:Number, yOffset:Number) :  Number
新しいカーソルを作成し、必要に応じてカーソルに優先度を設定します。
staticshowCursor( )
カーソルを表示します。



プロパティ
staticBUSYCURSORSYMBOL:String
ビジーカーソルシンボルのシンボル名です。
staticcurrentCursorID:Number
現在のカーソルの ID です。システムカーソルが表示されている場合は 0 です。
staticHIGHPRIORITY:Number
カーソルの最も高い優先度を指定する読み取り専用の定数です。
staticLOWPRIORITY:Number
カーソルの最も低い優先度を指定する読み取り専用の定数です。
staticMEDIUMPRIORITY:Number
カーソルの中程度の優先度を指定する読み取り専用の定数です。



メソッドの詳細

hideCursor

static  hideCursor( )

カーソルを非表示にします。カーソルの可視性は参照カウントされません。hideCursor() メソッドが何回呼び出されていても、showCursor() メソッドを 1 回呼び出すと必ずカーソルが表示されます。


removeAllCursors

static  removeAllCursors( ) :  Void

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


removeBusyCursor

static  removeBusyCursor( ) :  Void

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


removeCursor

static  removeCursor( cursorID:Number) :  Void

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

パラメータ
    cursorID:Number - 削除するカーソルの ID です。


setBusyCursor

static  setBusyCursor( ) :  Void

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


setCursor

static  setCursor( cursorSymbol:String, priorityLevel:Number, xOffset:Number, yOffset:Number) :  Number

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

パラメータ
    cursorSymbol:String - 表示するカーソルのシンボル名を示すストリングです。
    priorityLevel:Number - カーソルの優先度レベルを示す数値です。有効な値は、CursorManager.HIGHPRIORITY、CursorManager.MEDIUMPRIORITY、および CursorManager.LOWPRIORITY です。デフォルト値は CursorManager.MEDIUMPRIORITY です。
    xOffset:Number - マウスポインタに対する cursorSymbol の x オフセットを示す数値です。デフォルト値は 0 です。
    yOffset:Number - マウスポインタに対する cursorSymbol の y オフセットを示す数値です。デフォルト値は 0 です。

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


showCursor

static  showCursor( )

カーソルを表示します。カーソルの可視性は参照カウントされません。hideCursor() メソッドが何回呼び出されていても、showCursor() メソッドを 1 回呼び出すと必ずカーソルが表示されます。



プロパティの詳細

BUSYCURSORSYMBOL

static  BUSYCURSORSYMBOL:String  

ビジーカーソルシンボルのシンボル名です。デフォルト値は "mx.skins.cursor.BusyCursor" です。


currentCursorID

static  currentCursorID:Number  

現在のカーソルの ID です。システムカーソルが表示されている場合は 0 です。


HIGHPRIORITY

static  HIGHPRIORITY:Number  

カーソルの最も高い優先度を指定する読み取り専用の定数です。


LOWPRIORITY

static  LOWPRIORITY:Number  

カーソルの最も低い優先度を指定する読み取り専用の定数です。


MEDIUMPRIORITY

static  MEDIUMPRIORITY:Number  

カーソルの中程度の優先度を指定する読み取り専用の定数です。