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

ToolTipManager を使用すると、表示の遅延時間やツールヒントの無効化など、ツールヒントやエラーヒントの基本的な機能を設定できます。

関連項目

mx.controls.ToolTip
mx.validators.Validator
ツールヒントマネージャの使用
ダイナミックツールヒントテキストの使用

パブリックプロパティ
 プロパティ定義
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  currentTarget : DisplayObject
[static] 現在ツールヒントを表示している UIComponent です。表示されているツールヒントがない場合は null になります。
ToolTipManager
  currentToolTip : IToolTip
[static] 現在表示されている ToolTip オブジェクトです。表示されている ToolTip オブジェクトがない場合は null になります。
ToolTipManager
  enabled : Boolean
[static] true の場合、ユーザーがマウスポインタをコンポーネント上に移動すると、ToolTipManager が自動的にツールヒントを表示します。
ToolTipManager
  hideDelay : Number
[static] 表示されたツールヒントを非表示にするまでに Flex が待機する時間 (ミリ秒) です。
ToolTipManager
  hideEffect : Effect
[static] ツールヒントを非表示にするときに再生するエフェクトです。エフェクトを使用せずにツールヒントを非表示にする場合は null になります。
ToolTipManager
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  scrubDelay : Number
[static] ユーザーがコントロール間でマウスポインタを移動したときに、Flex が次のツールヒントを表示するまでの時間 (showDelay で指定された時間) を再度待機するまでの時間 (ミリ秒) です。
ToolTipManager
  showDelay : Number
[static] ツールヒントを持つコンポーネント上にマウスを移動したとき、ツールヒントボックスを表示させるまでに Flex が待機する時間 (ミリ秒) です。
ToolTipManager
  showEffect : Effect
[static] ツールヒントを表示するときに再生するエフェクトです。エフェクトを使用せずにツールヒントを表示する場合は null になります。
ToolTipManager
  toolTipClass : Class
[static] ツールヒントの作成に使用するクラスです。
ToolTipManager
パブリック Methods
 メソッド定義
 Inherited
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):IToolTip
[static] 指定されたテキストを使用した ToolTip クラスのインスタンスを作成し、ステージ座標の指定された位置に表示します。
ToolTipManager
  
destroyToolTip(toolTip:IToolTip):void
[static] createToolTip() メソッドで作成された特定の ToolTip を破棄します。
ToolTipManager
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント一覧定義
 Inherited
activate
Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited
deactivate
Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
プロパティの詳細
currentTargetプロパティ
currentTarget:DisplayObject  [read-write]

現在ツールヒントを表示している UIComponent です。表示されているツールヒントがない場合は null になります。

実装
    public static function get currentTarget():DisplayObject
    public function set currentTarget(value:DisplayObject):void
currentToolTipプロパティ 
currentToolTip:IToolTip  [read-write]

現在表示されている ToolTip オブジェクトです。表示されている ToolTip オブジェクトがない場合は null になります。

実装
    public static function get currentToolTip():IToolTip
    public function set currentToolTip(value:IToolTip):void
enabledプロパティ 
enabled:Boolean  [read-write]

true の場合、ユーザーがマウスポインタをコンポーネント上に移動すると、ToolTipManager が自動的にツールヒントを表示します。false の場合、ツールヒントは表示されません。

デフォルト値true.

実装
    public static function get enabled():Boolean
    public function set enabled(value:Boolean):void
hideDelayプロパティ 
hideDelay:Number  [read-write]

表示されたツールヒントを非表示にするまでに Flex が待機する時間 (ミリ秒) です。ツールヒントが非表示になった後、再びツールヒントを表示するには、いったんコンポーネントの外側にマウスを移動し、再度そのコンポーネントにマウスを重ねる必要があります。hideDelay プロパティを Infinity に設定した場合、マウスをコンポーネントの外側に移動するなど、ユーザーが何らかのイベントをトリガするまでツールヒントは表示されたままになります。

デフォルト値10000.

実装
    public static function get hideDelay():Number
    public function set hideDelay(value:Number):void
hideEffectプロパティ 
hideEffect:Effect  [read-write]

ツールヒントを非表示にするときに再生するエフェクトです。エフェクトを使用せずにツールヒントを非表示にする場合は null になります。

デフォルト値ヌル (null).

実装
    public static function get hideEffect():Effect
    public function set hideEffect(value:Effect):void
scrubDelayプロパティ 
scrubDelay:Number  [read-write]

ユーザーがコントロール間でマウスポインタを移動したときに、Flex が次のツールヒントを表示するまでの時間 (showDelay で指定された時間) を再度待機するまでの時間 (ミリ秒) です。

この設定は、ユーザーがコントロール間でマウスを素早く移動した場合に役立ちます。たとえば、Flex が最初のツールヒントを表示した後、待機せずにすぐに別のツールヒントを表示するようにできます。scrubDelay の設定が短いほど、ユーザーが次のツールヒントが表示されるまでに showDelay に指定された時間を待機する必要性が高くなります。このプロパティは、ツールバーに複数のボタンがあり、ユーザーがそれぞれの簡潔な説明を見てすばやくそれらの機能を把握する場合に有効です。

デフォルト値100.

実装
    public static function get scrubDelay():Number
    public function set scrubDelay(value:Number):void
showDelayプロパティ 
showDelay:Number  [read-write]

ツールヒントを持つコンポーネント上にマウスを移動したとき、ツールヒントボックスを表示させるまでに Flex が待機する時間 (ミリ秒) です。ツールヒントを即時に表示するには、showDelay を 0 に設定します。

デフォルト値500.

実装
    public static function get showDelay():Number
    public function set showDelay(value:Number):void
showEffectプロパティ 
showEffect:Effect  [read-write]

ツールヒントを表示するときに再生するエフェクトです。エフェクトを使用せずにツールヒントを表示する場合は null になります。

デフォルト値ヌル (null).

実装
    public static function get showEffect():Effect
    public function set showEffect(value:Effect):void
toolTipClassプロパティ 
toolTipClass:Class  [read-write]

ツールヒントの作成に使用するクラスです。

デフォルト値mx.controls.ToolTip.

実装
    public static function get toolTipClass():Class
    public function set toolTipClass(value:Class):void
メソッドの詳細
createToolTip()メソッド
public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):IToolTip

指定されたテキストを使用した ToolTip クラスのインスタンスを作成し、ステージ座標の指定された位置に表示します。

ツールヒントは、カーソルを除いたすべてのエレメントの上部に独自の層で表示されます。

ツールヒントの標準的な使用方法は、toolTip プロパティが設定されたオブジェクト上にユーザーがマウスを移動したときに、ToolTipManager によって自動的にツールヒントが表示および非表示されるようにすることです。ToolTipManager の enabled プロパティを false に設定すると、この自動ツールヒント管理を無効にできます。

一方、このメソッド (hideToolTip()) を使用すると、ツールヒントをプログラムで制御できます。ツールヒントをいつ、どこに表示するかを選択することが可能で、さらに必要に応じて複数のツールヒントを表示することもできます。(ToolTipManager でこのような操作を行うことはありません。これを行うと、通常はユーザーを混乱させることになるためです)。

このメソッドはツールヒントの新しいインスタンスを作成してから、addChild() メソッドを呼び出して、このインスタンスを SystemManager の toolTips 層に配置します。エラーヒントを表示する場合は、このメソッドが適切なスタイルを設定します。次に、ツールヒントのテキストを設定し、そのテキストに基づいてツールヒントのサイズを設定して、指定された場所に配置します。

このメソッドが返すツールヒントへの参照を保存して、hideToolTip() メソッドに渡せるようにする必要があります。

パラメータ
text:String — ツールヒントのインスタンスに表示するテキストです。
 
x:Number — ツールヒントのステージ座標での水平座標。複数の段階がある場合は、context 引数から現在関連している段階を判別できます。
 
y:Number — ツールヒントのステージ座標での垂直座標。複数の段階がある場合は、context 引数から現在関連している段階を判別できます。
 
errorTipBorderStyle:String (default = null) — エラーヒントの境界線スタイル。このメソッドのパラメータは、null、"errorTipRight"、"errorTipAbove"、または "errorTipBelow" のいずれかになります。null の場合、createToolTip() メソッドは標準ツールヒントを作成します。"errorTipRight"、"errorTipAbove"、または "errorTipBelow" の場合、createToolTip() メソッドはエラーヒントを作成し、このパラメータによってエラーヒントの矢印がどこを指すかが決定されます (エラーのターゲット)。たとえば、"errorTipRight" を渡すと、Flex ではエラーヒントをエラーターゲットの右側に配置します (x および y パラメータを使用)。矢印は、エラーヒントの左端にあります。
 
context:IUIComponent (default = null) — このプロパティは現在使用されていません。

戻り値
IToolTip — 新しく作成されたツールヒントです。
destroyToolTip()メソッド 
public static function destroyToolTip(toolTip:IToolTip):void

createToolTip() メソッドで作成された特定の ToolTip を破棄します。

このメソッドは removeChild() メソッドを呼び出して、指定されたツールヒントを SystemManager の ToolTips 層から削除します。このツールヒントへの参照を維持しない限り、ツールヒントはガベージコレクションされます。

このメソッドは、ToolTipManager の currentToolTip で使用してはなりません。

パラメータ
toolTip:IToolTip — 破棄するツールチップのインスタンスです。



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
2007.04.26, 午前 9:17, GMT-07:00