| パッケージ | mx.managers |
| public class ToolTipManager | |
| 継承 | ToolTipManager  EventDispatcher Object |
関連項目
| プロパティ | 定義 | ||
|---|---|---|---|
 | constructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| currentTarget : DisplayObject
[static]
現在ツールヒントを表示している UIComponent です。表示されているツールヒントがない場合は
null になります。 | ToolTipManager | ||
| currentToolTip : IToolTip
[static]
現在表示されている ToolTip オブジェクトです。表示されている ToolTip オブジェクトがない場合は
null になります。 | ToolTipManager | ||
| enabled : Boolean = true [static]
true の場合、ユーザーがマウスポインタをコンポーネント上に移動すると、ToolTipManager が自動的にツールヒントを表示します。 | ToolTipManager | ||
| hideDelay : Number = 10000 [static]
表示されたツールヒントを非表示にするまでに Flex が待機する時間 (ミリ秒) です。
| ToolTipManager | ||
| hideEffect : Effect
[static]
ツールヒントを非表示にするときに再生するエフェクトです。エフェクトを使用せずにツールヒントを非表示にする場合は
null になります。 | ToolTipManager | ||
| prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| scrubDelay : Number = 100 [static]
ユーザーがコントロール間でマウスポインタを移動したときに、Flex が次のツールヒントを表示するまでの時間 (
showDelay で指定された時間) を再度待機するまでの時間 (ミリ秒) です。 | ToolTipManager | ||
| showDelay : Number = 500 [static]
ツールヒントを持つコンポーネント上にマウスを移動したとき、ツールヒントボックスを表示させるまでに Flex が待機する時間 (ミリ秒) です。
| ToolTipManager | ||
| showEffect : Effect
[static]
ツールヒントを表示するときに再生するエフェクトです。エフェクトを使用せずにツールヒントを表示する場合は
null になります。 | ToolTipManager | ||
| toolTipClass : Class
[static]
ツールヒントの作成に使用するクラスです。
| ToolTipManager | ||
| メソッド | 定義 | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
| EventDispatcher | |
| createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):ToolTip
[static]
指定されたテキストを使用した ToolTip クラスのインスタンスを作成し、ステージ座標の指定された位置に表示します。
| ToolTipManager | ||
| destroyToolTip(toolTip:IToolTip):void
[static]
createToolTip() メソッドで作成された特定の ToolTip を破棄します。 | ToolTipManager | ||
| dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
| EventDispatcher | |
| hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
| EventDispatcher | |
| hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
| Object | |
| isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
| Object | |
| propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
| Object | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
| EventDispatcher | |
| setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
| toString():String
指定されたオブジェクトのストリング表現を返します。
| Object | |
| valueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
| Object | |
| willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
| EventDispatcher | |
| currentTarget | プロパティ |
継承されるパブリックプロパティの非表示
継承されるパブリックプロパティの表示public static var currentTarget:DisplayObject
現在ツールヒントを表示している UIComponent です。表示されているツールヒントがない場合は null になります。
| currentToolTip | プロパティ |
public static var currentToolTip:IToolTip
現在表示されている ToolTip オブジェクトです。表示されている ToolTip オブジェクトがない場合は null になります。
| enabled | プロパティ |
public static var enabled:Boolean = true
true の場合、ユーザーがマウスポインタをコンポーネント上に移動すると、ToolTipManager が自動的にツールヒントを表示します。false の場合、ツールヒントは表示されません。
デフォルト値true.
| hideDelay | プロパティ |
public static var hideDelay:Number = 10000
表示されたツールヒントを非表示にするまでに Flex が待機する時間 (ミリ秒) です。ツールヒントが非表示になった後、再びツールヒントを表示するには、いったんコンポーネントの外側にマウスを移動し、再度そのコンポーネントにマウスを重ねる必要があります。hideDelay プロパティを Infinity に設定した場合、マウスをコンポーネントの外側に移動するなど、ユーザーが何らかのイベントをトリガするまでツールヒントは表示されたままになります。
デフォルト値10000.
| hideEffect | プロパティ |
public static var hideEffect:Effect
ツールヒントを非表示にするときに再生するエフェクトです。エフェクトを使用せずにツールヒントを非表示にする場合は null になります。
デフォルト値null.
| scrubDelay | プロパティ |
public static var scrubDelay:Number = 100
ユーザーがコントロール間でマウスポインタを移動したときに、Flex が次のツールヒントを表示するまでの時間 (showDelay で指定された時間) を再度待機するまでの時間 (ミリ秒) です。
この設定は、ユーザーがコントロール間でマウスを素早く移動した場合に役立ちます。たとえば、Flex が最初のツールヒントを表示した後、待機せずにすぐに別のツールヒントを表示するようにできます。scrubDelay の設定が短いほど、ユーザーが次のツールヒントが表示されるまでに showDelay に指定された時間を待機する必要性が高くなります。このプロパティは、ツールバーに複数のボタンがあり、ユーザーがそれぞれの簡潔な説明を見てすばやくそれらの機能を把握する場合に有効です。
デフォルト値100.
| showDelay | プロパティ |
public static var showDelay:Number = 500
ツールヒントを持つコンポーネント上にマウスを移動したとき、ツールヒントボックスを表示させるまでに Flex が待機する時間 (ミリ秒) です。ツールヒントを即時に表示するには、showDelay を 0 に設定します。
デフォルト値500.
| showEffect | プロパティ |
public static var showEffect:Effect
ツールヒントを表示するときに再生するエフェクトです。エフェクトを使用せずにツールヒントを表示する場合は null になります。
デフォルト値null.
| toolTipClass | プロパティ |
| createToolTip | () | メソッド |
public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):ToolTip指定されたテキストを使用した ToolTip クラスのインスタンスを作成し、ステージ座標の指定された位置に表示します。
ツールヒントは、カーソルを除いたすべてのエレメントの上部に独自の層で表示されます。
ツールヒントの標準的な使用方法は、toolTip プロパティが設定されたオブジェクト上にユーザーがマウスを移動したときに、ToolTipManager によって自動的にツールヒントが表示および非表示されるようにすることです。ToolTipManager の enabled プロパティを false に設定すると、この自動ツールヒント管理を無効にできます。
一方、このメソッド (hideToolTip()) を使用すると、ツールヒントをプログラムで制御できます。ツールヒントをいつ、どこに表示するかを選択することが可能で、さらに必要に応じて複数のツールヒントを表示することもできます。(ToolTipManager でこのような操作を行うことはありません。これを行うと、通常はユーザーを混乱させることになるためです)。
このメソッドはツールヒントの新しいインスタンスを作成してから、addChild() メソッドを呼び出して、このインスタンスを SystemManager の toolTips 層に配置します。エラーヒントを表示する場合は、このメソッドが適切なスタイルを設定します。次に、ツールヒントのテキストを設定し、そのテキストに基づいてツールヒントのサイズを設定して、指定された場所に配置します。
このメソッドが返すツールヒントへの参照を保存して、hideToolTip() メソッドに渡せるようにする必要があります。
text:String — ツールヒントのインスタンスに表示するテキストです。
|
|
x:Number — ツールヒントのステージ座標での水平座標。複数の段階がある場合は、context 引数から現在関連している段階を判別できます。
|
|
y:Number — ツールヒントのステージ座標での垂直座標。複数の段階がある場合は、context 引数から現在関連している段階を判別できます。
|
|
errorTipBorderStyle:String (default = null)createToolTip() メソッドは標準ツールヒントを作成します。"errorTipRight"、"errorTipAbove"、または "errorTipBelow" の場合、createToolTip() メソッドはエラーヒントを作成し、このパラメータによってエラーヒントの矢印がどこを指すかが決定されます (エラーのターゲット)。たとえば、"errorTipRight" を渡すと、Flex ではエラーヒントをエラーターゲットの右側に配置します (x および y パラメータを使用)。矢印は、エラーヒントの左端にあります。
|
|
context:IUIComponent (default = null) |
ToolTip —
新しく作成されたツールヒントです。
|
| destroyToolTip | () | メソッド |
public static function destroyToolTip(toolTip:IToolTip):void
createToolTip() メソッドで作成された特定の ToolTip を破棄します。
このメソッドは removeChild() メソッドを呼び出して、指定されたツールヒントを SystemManager の ToolTips 層から削除します。このツールヒントへの参照を維持しない限り、ツールヒントはガベージコレクションされます。
このメソッドは、ToolTipManager の currentToolTip で使用してはなりません。
toolTip:IToolTip — 破棄するツールチップのインスタンスです。
|