クラスToolTipManager

java.lang.Object
java.awt.event.MouseAdapter
javax.swing.ToolTipManager
すべての実装されたインタフェース:
MouseListener, MouseMotionListener, MouseWheelListener, EventListener
public final class ToolTipManager extends MouseAdapter implements MouseMotionListener
システム内のすべてのToolTipsを管理します。

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

導入されたバージョン:
1.2
関連項目:

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    クラス
    説明
    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)
    ツールヒント制御からコンポーネントを削除します。

    クラスで宣言されたメソッド MouseAdapter

    mouseClicked, mouseReleased, mouseWheelMoved
    修飾子と型
    メソッド
    説明
    void
    mouseClicked(MouseEvent e)
    コンポーネント上でマウス・ボタンをクリック(押してから離す)したときに呼び出されます。
    void
    mouseReleased(MouseEvent e)
    コンポーネント上でマウス・ボタンが離されると呼び出されます。
    void
    mouseWheelMoved(MouseWheelEvent e)
    マウス・ホイールが回転すると呼び出されます。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • 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

      public int getInitialDelay()
      初期遅延値を返します。
      戻り値:
      初期遅延値を表すint値(ミリ秒単位)
      関連項目:

    • setDismissDelay

      public void setDismissDelay(int milliseconds)
      消去までの遅延時間を設定します。
      パラメータ:
      milliseconds - ツールヒントが消去されるまでの遅延時間(ミリ秒単位)
      関連項目:

    • getDismissDelay

      public int getDismissDelay()
      消去までの遅延時間を返します。
      戻り値:
      消去までの遅延時間値を表すint値(ミリ秒単位)
      関連項目:

    • setReshowDelay

      public void setReshowDelay(int milliseconds)
      ツールヒントの表示前にユーザーがinitialDelayの時間(ミリ秒単位)を待機する必要が生じるまでの時間を指定します。 つまり、有効なツールヒントを持つ同じComponentの領域にユーザーがmilliseconds (ミリ秒単位)の時間内に移動した場合、ツールヒントは即時に表示されます。 有効なツールヒントを持つ領域にユーザーがmillisecondsの時間を経過したあとに移動した場合、ツールヒントが再表示されるまでにユーザーはさらにinitialDelayの時間だけ待機する必要があります。
      パラメータ:
      milliseconds - 時間(ミリ秒単位)
      関連項目:

    • getReshowDelay

      public int getReshowDelay()
      再表示遅延プロパティを返します。
      戻り値:
      reshow delayプロパティ
      関連項目:

    • sharedInstance

      public static ToolTipManager sharedInstance()
      ToolTipManagerの共有インスタンスを返します。
      戻り値:
      共有ToolTipManagerオブジェクト

    • registerComponent

      public void registerComponent(JComponent component)
      コンポーネントをツールヒント管理用に登録します。

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

      パラメータ:
      component - 追加するJComponentオブジェクト
      関連項目:

    • unregisterComponent

      public void unregisterComponent(JComponent component)
      ツールヒント制御からコンポーネントを削除します。
      パラメータ:
      component - 削除するJComponentオブジェクト

    • mouseEntered

      public void mouseEntered(MouseEvent event)
      コンポーネントの領域にマウスが入ったときに呼び出されます。 ツールヒントを表示するか表示しないかを指定します。
      定義:
      mouseEntered、インタフェースMouseListener
      パラメータ:
      event - 該当のイベント

    • mouseExited

      public void mouseExited(MouseEvent event)
      コンポーネントの領域からマウスが出たときに呼び出されます。 表示されているツールヒントはすべて消去されます。
      定義:
      mouseExited、インタフェースMouseListener
      パラメータ:
      event - 該当のイベント

    • mousePressed

      public void mousePressed(MouseEvent event)
      マウスが押されたときに呼び出されます。 表示されているツールヒントはすべて消去されます。
      定義:
      mousePressed、インタフェースMouseListener
      パラメータ:
      event - 該当のイベント

    • mouseDragged

      public void mouseDragged(MouseEvent event)
      マウスが押され、ドラッグされたときに呼び出されます。 何も行いません。
      定義:
      mouseDragged、インタフェースMouseMotionListener
      オーバーライド:
      mouseDragged、クラスMouseAdapter
      パラメータ:
      event - 該当のイベント

    • mouseMoved

      public void mouseMoved(MouseEvent event)
      マウスが移動したときに呼び出されます。 ツールヒントを表示するか表示しないかを指定します。
      定義:
      mouseMoved、インタフェースMouseMotionListener
      オーバーライド:
      mouseMoved、クラスMouseAdapter
      パラメータ:
      event - 該当のイベント