javax.swing
クラス ToolTipManager

java.lang.Object
  |
  +--java.awt.event.MouseAdapter
        |
        +--javax.swing.ToolTipManager

すべての実装インタフェース:

EventListener, MouseListener, MouseMotionListener

public class ToolTipManager

extends MouseAdapter

implements MouseMotionListener

システム内のすべての ToolTips (ツールヒント) を管理します。

ToolTipManager には、ツールヒントを表示するまでの時間や表示を終了するまでの時間を設定するためのプロパティが多数含まれます。たとえば、JTree のようにマウスの位置に基づいて異なるツールヒントを表示させるコンポーネントを考えます。マウスが JTree の内部に移動し、有効なツールヒントを持つ領域の上に置かれた場合、initialDelay の時間 (ミリ秒単位) が経過した後にツールヒントが表示されます。dismissDelay の時間 (ミリ秒単位) が経過すると、ツールヒントは表示されなくなります。有効なツールヒントを持つ領域にマウスがあり、ツールヒントが表示されているときに、有効なツールヒントを持たない領域にマウスが移動すると、ツールヒントは表示されなくなります。reshowDelay の時間が経過する前に、有効なツールヒントを持つ領域にマウスが再度移動すると、ツールヒントは即時に表示されます。reshowDelay の時間が経過した後に、有効なツールヒントを持つ領域にマウスが再度移動した場合は、initialDelay の時間が経過してからツールヒントが表示されます。

関連項目:

JComponent.createToolTip()

入れ子クラスの概要

protected class	ToolTipManager.insideTimerAction
protected class	ToolTipManager.outsideTimerAction
protected class	ToolTipManager.stillInsideTimerAction

フィールドの概要

protected boolean	heavyWeightPopupEnabled
protected boolean	lightWeightPopupEnabled

メソッドの概要

int	getDismissDelay() 消去までの遅延時間を返します。
int	getInitialDelay() 初期遅延値を返します。
int	getReshowDelay() 再表示遅延プロパティを返します。
boolean	isEnabled() このオブジェクトが有効な場合に true を返します。
boolean	isLightWeightPopupEnabled() 軽量 (すべての Java) Tooltips が使用されている場合は true、重量 (ネイティブピア) Tooltips が使用されている場合は false を返します。
void	mouseDragged(MouseEvent event) マウスボタンが押され、ドラッグされたときに呼び出されます。
void	mouseEntered(MouseEvent event) コンポーネントの領域内にマウスが移動したときに呼び出されます。
void	mouseExited(MouseEvent event) コンポーネントの領域外にマウスが移動したときに呼び出されます。
void	mouseMoved(MouseEvent event) マウスが移動されたときに呼び出されます。
void	mousePressed(MouseEvent event) マウスボタンが押されたときに呼び出されます。
void	registerComponent(JComponent component) コンポーネントをツールヒント管理用に登録します。
void	setDismissDelay(int milliseconds) 消去までの遅延時間を設定します。
void	setEnabled(boolean flag) ツールヒントを有効または無効にします。
void	setInitialDelay(int milliseconds) 初期遅延値を指定します。
void	setLightWeightPopupEnabled(boolean aFlag) JToolTip を表示する場合、ToolTipManager は適当であれば軽量な JPanel を使用します。
void	setReshowDelay(int milliseconds) ツールヒントの表示前にユーザが initialDelay の時間 (ミリ秒単位) を待機する必要が生じるまでの時間を指定します。
static ToolTipManager	sharedInstance() ToolTipManager の共有インスタンスを返します。
void	unregisterComponent(JComponent component) ツールヒント制御からコンポーネントを削除します。

クラス java.awt.event.MouseAdapter から継承したメソッド

mouseClicked, mouseReleased

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

lightWeightPopupEnabled

protected boolean lightWeightPopupEnabled

heavyWeightPopupEnabled

protected boolean heavyWeightPopupEnabled

メソッドの詳細

setEnabled

public void setEnabled(boolean flag)

ツールヒントを有効または無効にします。

パラメータ:

flag - ツールヒントを有効にする場合は true、そうでない場合は false

isEnabled

public boolean isEnabled()

このオブジェクトが有効な場合に true を返します。

戻り値:

オブジェクトが有効な場合は true、そうでない場合は false

setLightWeightPopupEnabled

public void setLightWeightPopupEnabled(boolean aFlag)

JToolTip を表示する場合、ToolTipManager は適当であれば軽量な JPanel を使用します。このメソッドを使用すると、その機能を無効にできます。アプリケーションが軽量コンポーネントと重量コンポーネントを混用する場合には、使用不可にする必要があります。

パラメータ:

aFlag - 軽量パネルを使用する場合は true、そうでない場合は false

isLightWeightPopupEnabled

public boolean isLightWeightPopupEnabled()

軽量 (すべての Java) Tooltips が使用されている場合は true、重量 (ネイティブピア) Tooltips が使用されている場合は false を返します。

戻り値:

軽量 ToolTips を使用している場合は true

setInitialDelay

public void setInitialDelay(int milliseconds)

初期遅延値を指定します。

パラメータ:

milliseconds - カーソルが停止してからツールヒントを表示するまでの遅延時間 (ミリ秒単位)

関連項目:

getInitialDelay()

getInitialDelay

public int getInitialDelay()

初期遅延値を返します。

戻り値:

初期遅延値を表す int 値 (ミリ秒単位)

関連項目:

setInitialDelay(int)

setDismissDelay

public void setDismissDelay(int milliseconds)

消去までの遅延時間を設定します。

パラメータ:

milliseconds - ツールヒントを消去するまでの遅延時間 (ミリ秒単位)

関連項目:

getDismissDelay()

getDismissDelay

public int getDismissDelay()

消去までの遅延時間を返します。

戻り値:

消去までの遅延時間値を表す int 値 (ミリ秒単位)

関連項目:

setDismissDelay(int)

setReshowDelay

public void setReshowDelay(int milliseconds)

ツールヒントの表示前にユーザが initialDelay の時間 (ミリ秒単位) を待機する必要が生じるまでの時間を指定します。つまり、有効なツールヒントを持つ同じ Component の領域にユーザが milliseconds (ミリ秒単位) の時間内に移動した場合、ツールヒントは即時に表示されます。そうでない場合、有効なツールヒントを持つ領域にユーザが milliseconds の時間を経過した後に移動したときには、ツールヒントが再表示されるまでにユーザはさらに initialDelay の時間だけ待機する必要があります。

パラメータ:

milliseconds - 時間 (ミリ秒単位)

関連項目:

getReshowDelay()

getReshowDelay

public int getReshowDelay()

再表示遅延プロパティを返します。

戻り値:

再表示遅延プロパティ

関連項目:

setReshowDelay(int)

sharedInstance

public static ToolTipManager sharedInstance()

ToolTipManager の共有インスタンスを返します。

戻り値:

共有 ToolTipManager オブジェクト

registerComponent

public void registerComponent(JComponent component)

コンポーネントをツールヒント管理用に登録します。

このメソッドは、component にフォーカスバインディングが用意されている場合に限り、ツールヒントの表示および消去のためにキーバインディングを登録します。登録されると、JLabel など、通常のフォーカストラバーサルが可能ではないコンポーネントは、このメソッドを呼び出しても、フォーカストラバーサルが可能にはなりません。

パラメータ:

component - 追加する JComponent オブジェクト

関連項目:

Component.isFocusTraversable()

unregisterComponent

public void unregisterComponent(JComponent component)

ツールヒント制御からコンポーネントを削除します。

パラメータ:

component - 削除する JComponent オブジェクト

mouseEntered

public void mouseEntered(MouseEvent event)

コンポーネントの領域内にマウスが移動したときに呼び出されます。ツールヒントを表示するか表示しないかを指定します。

定義:

インタフェース MouseListener 内の mouseEntered

オーバーライド:

クラス MouseAdapter 内の mouseEntered

パラメータ:

event - 該当のイベント

mouseExited

public void mouseExited(MouseEvent event)

コンポーネントの領域外にマウスが移動したときに呼び出されます。ツールヒントを消去するか消去しないかを指定します。

定義:

インタフェース MouseListener 内の mouseExited

オーバーライド:

クラス MouseAdapter 内の mouseExited

パラメータ:

event - 該当のイベント

mousePressed

public void mousePressed(MouseEvent event)

マウスボタンが押されたときに呼び出されます。表示されているツールヒントはすべて消去されます。

定義:

インタフェース MouseListener 内の mousePressed

オーバーライド:

クラス MouseAdapter 内の mousePressed

パラメータ:

event - 該当のイベント

mouseDragged

public void mouseDragged(MouseEvent event)

マウスボタンが押され、ドラッグされたときに呼び出されます。何も行いません。

定義:

インタフェース MouseMotionListener 内の mouseDragged

パラメータ:

event - 該当のイベント

mouseMoved

public void mouseMoved(MouseEvent event)

マウスが移動されたときに呼び出されます。ツールヒントを表示するか表示しないかを指定します。

定義:

インタフェース MouseMotionListener 内の mouseMoved

パラメータ:

event - 該当のイベント