| パッケージ | mx.managers |
| クラス | public class ToolTipManager |
| 継承 | ToolTipManager  EventDispatcher Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
さらに例を参照
ToolTip objects in multi-versioned applications
Using the ToolTip Manager
Creating custom ToolTips
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| currentTarget : DisplayObject [静的]
現在ツールヒントを表示している UIComponent です。表示されているツールヒントがない場合は null になります。 | ToolTipManager | ||
| currentToolTip : mx.core:IToolTip [静的]
現在表示されている ToolTip オブジェクトです。表示されている ToolTip オブジェクトがない場合は null になります。 | ToolTipManager | ||
| enabled : Boolean [静的]
true の場合、ユーザーがマウスポインターをコンポーネント上に移動すると、ToolTipManager が自動的にツールヒントを表示します。 | ToolTipManager | ||
| hideDelay : Number [静的]
表示されたツールヒントを非表示にするまでに Flex が待機する時間（ミリ秒）です。 | ToolTipManager | ||
| hideEffect : IAbstractEffect [静的]
ツールヒントを非表示にするときに再生するエフェクトです。エフェクトを使用せずにツールヒントを非表示にする場合は null になります。 | ToolTipManager | ||
| scrubDelay : Number [静的]
ユーザーがコントロール間でマウスポインターを移動したときに、Flex が次のツールヒントを表示するまでの時間（showDelay で指定された時間）を再度待機するまでの時間（ミリ秒）です。 | ToolTipManager | ||
| showDelay : Number [静的]
ツールヒントを持つコンポーネント上にマウスを移動したとき、ツールヒントボックスを表示させるまでに Flex が待機する時間（ミリ秒）です。 | ToolTipManager | ||
| showEffect : IAbstractEffect [静的]
ツールヒントを表示するときに再生するエフェクトです。エフェクトを使用せずにツールヒントを表示する場合は null になります。 | ToolTipManager | ||
| toolTipClass : Class [静的]
ツールヒントの作成に使用するクラスです。 | 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):mx.core:IToolTip [静的]
指定されたテキストを使用した ToolTip クラスのインスタンスを作成し、ステージ座標の指定された位置に表示します。 | ToolTipManager | ||
[静的]
createToolTip() メソッドで作成された特定の ToolTip を破棄します。 | ToolTipManager | ||
|
イベントをイベントフローに送出します。 | EventDispatcher | |
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
currentTarget | プロパティ |
currentTarget:DisplayObject| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
現在ツールヒントを表示している UIComponent です。表示されているツールヒントがない場合は null になります。
実装
public static function get currentTarget():DisplayObject public static function set currentTarget(value:DisplayObject):voidcurrentToolTip | プロパティ |
currentToolTip:mx.core:IToolTip| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
現在表示されている ToolTip オブジェクトです。表示されている ToolTip オブジェクトがない場合は null になります。
実装
public static function get currentToolTip():mx.core:IToolTip public static function set currentToolTip(value:mx.core:IToolTip):voidenabled | プロパティ |
enabled:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
true の場合、ユーザーがマウスポインターをコンポーネント上に移動すると、ToolTipManager が自動的にツールヒントを表示します。 false の場合、ツールヒントは表示されません。
デフォルト値： true。
実装
public static function get enabled():Boolean public static function set enabled(value:Boolean):voidhideDelay | プロパティ |
hideDelay:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
表示されたツールヒントを非表示にするまでに Flex が待機する時間（ミリ秒）です。 非表示になったツールヒントを再び表示するには、いったんコンポーネントの外側にマウスを移動してから、再度そのコンポーネント上にマウスを移動する必要があります。 hideDelay プロパティを Infinity に設定した場合、マウスをコンポーネントの外側に移動するなど、ユーザーが何らかのイベントをトリガーするまでツールヒントは表示されたままになります。
デフォルト値： 10000。
実装
public static function get hideDelay():Number public static function set hideDelay(value:Number):voidhideEffect | プロパティ |
hideEffect:IAbstractEffect| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ツールヒントを非表示にするときに再生するエフェクトです。エフェクトを使用せずにツールヒントを非表示にする場合は null になります。
デフォルト値： null。
実装
public static function get hideEffect():IAbstractEffect public static function set hideEffect(value:IAbstractEffect):voidscrubDelay | プロパティ |
scrubDelay:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ユーザーがコントロール間でマウスポインターを移動したときに、Flex が次のツールヒントを表示するまでの時間（showDelay で指定された時間）を再度待機するまでの時間（ミリ秒）です。
この設定は、ユーザーがコントロール間でマウスを素早く移動した場合に役立ちます。例えば、Flex が最初のツールヒントを表示した後、待機せずにすぐに別のツールヒントを表示するようにできます。 scrubDelay の設定が短いほど、ユーザーが、次のツールヒントが表示されるまでに showDelay に指定された時間を待機する必要性が高くなります。 このプロパティは、ツールバーに複数のボタンがあり、ユーザーがそれぞれの簡潔な説明を見てすばやくそれらの機能を把握する場合に有効です。
デフォルト値： 100。
実装
public static function get scrubDelay():Number public static function set scrubDelay(value:Number):voidshowDelay | プロパティ |
showDelay:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ツールヒントを持つコンポーネント上にマウスを移動したとき、ツールヒントボックスを表示させるまでに Flex が待機する時間（ミリ秒）です。 ツールヒントを即時に表示するには、showDelay を 0 に設定します。
デフォルト値： 500。
実装
public static function get showDelay():Number public static function set showDelay(value:Number):voidshowEffect | プロパティ |
showEffect:IAbstractEffect| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ツールヒントを表示するときに再生するエフェクトです。エフェクトを使用せずにツールヒントを表示する場合は null になります。
デフォルト値： null。
実装
public static function get showEffect():IAbstractEffect public static function set showEffect(value:IAbstractEffect):voidtoolTipClass | プロパティ |
createToolTip | () | メソッド |
public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定されたテキストを使用した ToolTip クラスのインスタンスを作成し、ステージ座標の指定された位置に表示します。
ツールヒントは、カーソルを除いたすべてのエレメントの上部に独自の層で表示されます。
ツールヒントの標準的な使用方法は、toolTip プロパティが設定されたオブジェクト上にユーザーがマウスを移動したときに、ツールヒントの表示と非表示を ToolTipManager によって自動的に切り替えるようにすることです。 ToolTipManager の enabled プロパティを false に設定すると、この自動ツールヒント管理を無効にできます。
一方、このメソッド（および destroyToolTip()）を使用すると、ツールヒントをプログラムで制御できます。 ツールヒントをいつ、どこに表示するかを選択することが可能で、さらに必要に応じて複数のツールヒントを同時に表示することもできます （ToolTipManager でこのような操作を行うことはありません。これを行うと、通常はユーザーを混乱させることになるためです）。
このメソッドは ToolTip の新しいインスタンスを作成してから、addChild() メソッドを呼び出して、このインスタンスを SystemManager のツールヒントレイヤーに配置します。 エラーヒントを表示する場合は、このメソッドによって適切なスタイルが設定されます。 次に、このメソッドは、ツールヒントのテキストを設定し、そのテキストに基づいてツールヒントのサイズを設定して、指定された場所に配置します。
このメソッドが返すツールヒントへの参照を保存して、destroyToolTip() メソッドに渡せるようにする必要があります。
パラメーター
text:String — ツールヒントのインスタンスに表示するテキストです。
| |
x:Number — ツールヒントのステージ座標での水平座標。 複数のステージがある場合は、context 引数から、関連するステージを判別します。
| |
y:Number — ツールヒントのステージ座標での垂直座標。 複数のステージがある場合は、context 引数から、関連するステージを判別します。
| |
errorTipBorderStyle:String (default = null)createToolTip() メソッドは標準ツールヒントを作成します。 「errorTipRight」、「errorTipAbove」、または「errorTipBelow」の場合、createToolTip() メソッドはエラーヒントを作成し、このパラメーターによってエラーヒントの矢印がどこを指すかが決定されます（エラーのターゲット）。 例えば、「errorTipRight」を渡すと、エラーヒントは（x および y パラメーターを使用して）エラーターゲットの右側に配置されます。矢印は、エラーヒントの左端にあります。
| |
context:IUIComponent (default = null) |
mx.core:IToolTip — 新しく作成されたツールヒントです。
|
destroyToolTip | () | メソッド |
public static function destroyToolTip(toolTip:mx.core:IToolTip):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
createToolTip() メソッドで作成された特定の ToolTip を破棄します。
このメソッドは removeChild() メソッドを呼び出して、指定された ToolTip を SystemManager のツールヒントレイヤーから削除します。 このツールヒントへの参照を維持しない限り、ツールヒントはガベージコレクションされます。
このメソッドは、ToolTipManager の currentToolTip では使用しないでください。
パラメーター
toolTip:mx.core:IToolTip — 破棄する ToolTip のインスタンスです。
|
Tue Jun 12 2018, 10:34 AM Z