【Java】JListの各項目にツールチップテキストを表示する方法を解説

JListはJComponentクラスのサブクラスであり、オブジェクトのリストを表示して、ユーザーが1つまたは複数の項目を選択できるようにするためのSwingコンポーネントです。JListはListSelectionListenerインターフェースを利用でき、その抽象メソッドであるvalueChanged()を実装する必要があります。

また、JToolTipクラスはコンポーネント上にテキストやヒント（Tip）を表示するために使用されます。リストの各項目ごとに個別のツールチップテキストを設定したい場合は、getToolTipText()メソッドをオーバーライドすることで実現できます。このメソッド内でマウスカーソルの位置から該当する項目のインデックスを取得し、その項目に応じたツールチップテキストを返すのがポイントです。

実装例

以下のコードでは、無名内部クラスを使ってJListを拡張し、getToolTipText(MouseEvent)をオーバーライドしています。locationToIndex()メソッドでマウス位置に対応するインデックスを取得し、その項目に合わせたツールチップを動的に生成します。なお、ツールチップを有効化するためにsetToolTipText("")を呼び出すことを忘れないようにしましょう。

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import java.util.*;

public class JListTooltipTest extends JFrame {
    private Vector vector;
    public JListTooltipTest() {
        setTitle("JListTooltip Test");
        setLayout(new FlowLayout());
        vector = new Vector();
        for (int i = 1; i < 15; i++) {
            vector.addElement("Item #" + i);
        }
        final JList list = new JList(vector) {
            @Override
            public String getToolTipText(MouseEvent me) {
                int index = locationToIndex(me.getPoint());
                if (index > -1) {
                    String item = (String) getModel().getElementAt(index);
                    return "Tooltip for " + item;
                }
                return null;
            }
        };
        list.setToolTipText("");
        add(new JScrollPane(list));
        setSize(375, 250);
        setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        setLocationRelativeTo(null);
        setVisible(true);
    }
    public static void main(String[] args) {
        new JListTooltipTest();
    }
}

実行結果

プログラムを実行すると、リストの各項目にマウスカーソルを合わせた際に、その項目専用のツールチップテキストが表示されます。項目ごとに異なる説明文を表示したい場合にも、この手法を応用することで柔軟に対応できます。

ポイントまとめ

• JListのgetToolTipText(MouseEvent)をオーバーライドして、マウス位置から項目インデックスを取得する
• locationToIndex()とgetModel().getElementAt()を組み合わせて、該当項目の情報を取得する
• ツールチップ機能を有効にするため、必ずsetToolTipText("")を呼び出す