JavaでJTableHeaderの各列にツールチップを設定する方法

JTableHeaderはJComponentクラスのサブクラスであり、テーブルのヘッダー部分を管理するためのコンポーネントです。
JTableオブジェクトを生成すると、そのコンストラクタが自動的に新しいJTableHeaderオブジェクトを作成し、テーブルのヘッダーを管理します。

JTableには、テーブルヘッダーコンポーネントとしてJTableHeaderオブジェクトを設定するためのsetTableHeader()メソッドと、設定済みのJTableHeaderオブジェクトへの参照を取得するgetTableHeader()メソッドが用意されています。

各列にツールチップを設定する仕組み

JTableHeaderの各列にツールチップテキストを表示するには、JTableHeaderクラスのgetToolTipText()メソッドをオーバーライドします。このメソッド内でマウスカーソルの位置から該当する列インデックスを取得し、あらかじめ用意しておいたツールチップ文字列の配列から対応するテキストを返すことで、列ごとに異なるツールチップを実現できます。

ポイントは以下の通りです。

• columnAtPoint()：マウスイベントの座標からビュー上の列インデックスを取得します。
• convertColumnIndexToModel()：ユーザーが列を移動（ドラッグ＆ドロップ）した場合でも正しいモデル上の列インデックスに変換します。
• 例外処理：NullPointerExceptionやArrayIndexOutOfBoundsExceptionをキャッチし、ツールチップが未設定の場合は空文字または親クラスのデフォルト動作にフォールバックさせます。

サンプルコード

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

public class JTableHeaderToolTipTest extends JPanel {
    private DefaultTableModel dmodel;
    private JTable table;
    private JScrollPane jsp;

    public JTableHeaderToolTipTest() {
        setLayout(new BorderLayout());
        String[] headers = {"Name", "Age", "Contact Number", "City"};
        String[] toolTips = {"Name of Emp", "Age of Emp", "Contact Number of Emp", "City of Emp"};
        dmodel = new DefaultTableModel(headers, 4);
        table = new JTable(dmodel);
        ToolTipHeader tooltipHeader = new ToolTipHeader(table.getColumnModel());
        tooltipHeader.setToolTipStrings(toolTips);
        table.setTableHeader(tooltipHeader);
        jsp = new JScrollPane(table);
        add(jsp, BorderLayout.CENTER);
    }

    public static void main(String[] args) {
        JFrame frame = new JFrame("JTableHeaderToolTip Test");
        frame.getContentPane().add(new JTableHeaderToolTipTest(), BorderLayout.CENTER);
        frame.setSize(400, 250);
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.setLocationRelativeTo(null);
        frame.setVisible(true);
    }
}

// JTableHeaderの各列にツールチップテキストを設定する実装コード
class ToolTipHeader extends JTableHeader {
    String[] toolTips;

    public ToolTipHeader(TableColumnModel model) {
        super(model);
    }

    public String getToolTipText(MouseEvent e) {
        int col = columnAtPoint(e.getPoint());
        int modelCol = getTable().convertColumnIndexToModel(col);
        String retStr;
        try {
            retStr = toolTips[modelCol];
        } catch (NullPointerException ex) {
            retStr = "";
        } catch (ArrayIndexOutOfBoundsException ex) {
            retStr = "";
        }
        if (retStr.length() < 1) {
            retStr = super.getToolTipText(e);
        }
        return retStr;
    }

    public void setToolTipStrings(String[] toolTips) {
        this.toolTips = toolTips;
    }
}

コードの解説

このサンプルでは、JTableHeaderを継承した独自クラスToolTipHeaderを定義しています。主な処理の流れは次のとおりです。

1. ヘッダー名（headers）とそれに対応するツールチップ文字列（toolTips）を配列として用意します。
2. DefaultTableModelを使ってJTableを生成し、ToolTipHeaderのインスタンスを作成します。
3. setToolTipStrings()メソッドでツールチップの配列を登録し、setTableHeader()でカスタムヘッダーをテーブルに適用します。
4. マウスがヘッダー上に乗るとgetToolTipText()が呼び出され、カーソル位置の列に対応するツールチップが表示されます。

このように、getToolTipText()をオーバーライドするだけで、JTableのヘッダー列ごとに個別の説明文を簡単に表示できるようになります。ユーザーが列を並べ替えてもconvertColumnIndexToModel()による変換処理のおかげで、常に正しいツールチップが表示される点も実用的なポイントです。

実行結果