テキストエリアにツールチップを表示する

ツールチップとはテキストフィールドなどのコンポーネントのマウスを合わせた時、どんな目的で使用しているものかなど注釈を表示する機能です。ここではテキストエリアにツールチップを表示する方法について解説します。

(2022 年 04 月 11 日公開 / 2022 年 04 月 11 日更新)

ツールチップの設定

テキストエリアにマウスを合わせた時にコンポーネントの説明として表示されるツールチップの設定を行うには JTextArea クラスの親クラスである JComponent クラスで定義されている setToolTipText メソッドを使います。

public void setToolTipText(String text)

ツールヒントに表示するテキストを登録します。 このテキストは、カーソルがコンポーネント上にあるときに表示されます。 詳細は、『The Java Tutorial』の「How to Use Tool Tips」を参照してください。

パラメータ:
text - 表示する文字列。テキストがnullの場合、このコンポーネントのツールヒントはオフ

引数にツールチップとして表示される文字列を表す String クラスのオブジェクトを指定します。

実際の使い方は次のようになります。

JTextArea textarea = new JTextArea();
textarea.setToolTipText("Please enter your profile");
サンプルコード

それでは簡単なサンプルプログラムを作って試してみます。テキストエディタで次のように記述したあと、 JSample18_1.java という名前で保存します。

import javax.swing.JFrame;
import javax.swing.JTextArea;
import javax.swing.JPanel;
import java.awt.Container;
import java.awt.BorderLayout;

class JSample18_1 extends JFrame{

  public static void main(String args[]){
    JSample18_1 frame = new JSample18_1("MyTitle");
    frame.setVisible(true);
  }

  JSample18_1(String title){
    setTitle(title);
    setBounds(100, 100, 600, 400);
    setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

    JTextArea textarea = new JTextArea(5, 40);
    textarea.setToolTipText("Please enter your profile");

    JPanel p = new JPanel();
    p.add(textarea);

    Container contentPane = getContentPane();
    contentPane.add(p, BorderLayout.CENTER);
  }
}

次のようにコンパイルを行います。

javac JSample18_1.java

ツールチップの設定(1)

コンパイルが終わりましたら実行します。

java JSample18_1

テキストエリアを追加しました。テキストエリアにはツールチップを設定してあります。

ツールチップの設定(2)

マウスをテキストエリアに合わせると、設定されたツールチップが画面に表示されます。

ツールチップの設定(3)

-- --

テキストエリアにツールチップを表示する方法について解説しました。

( Written by Tatsuo Ikura )

プロフィール画像

著者 / TATSUO IKURA

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。