11.3 列の制御

JTable クラスのオブジェクトを JScrollPane コンテナに追加したときに、上部に列名を描画するヘッダが表示されていました。なぜ、JScrollPane コンテナ上に表示したときにヘッダが表示されたのかというと、コンテナが JTable クラスが提供するテーブルヘッダコンポーネントを表示していたためです。

JScrollPane コンテナに追加しない場合でも、明示的にテーブルヘッダコンポーネントを追加すれば、任意の場所にヘッダを表示することができます。テーブルヘッダは、JTable クラスの setTableHeader() メソッドでテーブルに設定することができ、getTableHeader() メソッドから取得することができます。

public void setTableHeader(JTableHeader tableHeader)

public JTableHeader getTableHeader()

これらのメソッドから設定したり、取得したりするオブジェクトは javax.swing.table.JTableHeader クラスのオブジェクトです。 このクラスは JComponent クラスを継承する軽量コンポーネントなので、コンテナに追加して表示することができます。

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.table.JTableHeader

public class JTableHeader extends JComponent implements TableColumnModelListener, Accessible

このクラスは、デフォルトで列を移動させたり、列のサイズを変更することができます。JScrollPnae コンテナで表示したときは、実際に列をドラッグして移動するということができたはずです。しかし、JTableHeader クラスのメソッドから設定を変更することができます。

JTableHeader クラスは新たにインスタンスを生成して設定することもできますが、通常は JTable クラスのデフォルトのテーブルヘッダで十分でしょう。

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

public class Test {
	public static void main(String args[]) {
		JTable table = new JTable(10 , 5);
		for(int c = 0 ; c < table.getColumnCount() ; c++) {
			for(int r = 0 ; r < table.getRowCount() ; r++) {
				table.setValueAt("行" + r + ":列" + c , r , c);
			}
		}

		JFrame win = new JFrame();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.getContentPane().add(table , BorderLayout.CENTER);
		win.getContentPane().add(table.getTableHeader() , BorderLayout.SOUTH);
		win.show();
	}
}

実行結果

コード1は、JTable コンポーネントを JScrollPane に追加するのではなく、ウィンドウのコンテンツペインに直接追加しています。この状態ではテーブルヘッダが表示されないので、getTableHeader() メソッドから JTable に設定されているテーブルヘッダコンポーネントを取得し、このコンポーネントをコンテンツペインの下部に表示しています。

JTable クラスでは、列を初期化する方法の 1 つに、列の情報を提供する javax.swing.table.TableColumnModel インタフェースを実装するオブジェクトを受け取るコンストラクタがありました。TableColumnModel は列モデルと呼ばれ、列の情報を提供するメソッドを宣言しています。

いくつか重要なメソッドがありますが、この中で最も重要なのは列を追加したり、削除したりすることができる addColumn() メソッドと removeColumn() メソッドでしょう。これらのメソッドを使えば、プログラムが任意のタイミングで列を変更することができます。moveColumn() メソッドを使えば、列の位置をプログラムから移動することができます。列は移動可能なので getColumnIndexAtX() メソッドの存在からも想像できるように、実際に表示されている列の視覚表現とインデックスが異なる可能性があります。

addColumn() メソッドや removeColumn() メソッドの対象となる列を表すオブジェクトは javax.swing.table.TableColumn クラスのオブジェクトです。このクラスは、列に関する様々なプロパティを提供します。

java.lang.Object
  |
  +--javax.swing.table.TableColumn

public class TableColumn extends Object implements Serializable

TableColumn クラスを用いれば、列のインデックスや幅などを指定することができます。

表3は、TableColumn クラスの主なコンストラクタとメソッドです。TableCellRenderer 型と TableCellEditor 型というオブジェクト設定するコンストラクタがありますが、これは TableColumn クラスの列の描画や編集に関する強力なオブジェクトも提供するためのものです。これに関しては「セルのレンダラとエディタ」で詳しく解説したいと思います。

TableColumn クラスは、列の幅に関する情報と、列の値に関する情報を設定したり取得することができます。テーブルヘッダに描画される列の値は setHeaderValue() メソッドで設定し、getHeaderValue() メソッドから取得することができます。列の識別子を設定する setIdentifier() メソッドと、取得する getIdentifier() メソッドは、実際に表示される値とは関係のない内部の識別用オブジェクトを管理します。列の識別子は、JTable クラスでは利用されず、列を検索ときの検索情報などとして利用することができます。

列の幅は、setWidth() メソッドから設定することができますが、レイアウトマネージャが状況に応じて最適なサイズを設定するため、長期的な意味を持つことはできません。通常は、setPreferredWidth() メソッドから列の最適幅を指定します。ただし、列の幅は常に最小幅と最大幅の影響を受けます。デフォルトの最小値は 15、最大値は Integer.MAX_VALUE が設定されています。

JTable のデフォルトの設定では javax.swing.table.DefaultTableColumnModel クラスのオブジェクトが設定されています。 DefaultTableColumnModel クラスは、ほぼ TableColumnHeader インタフェースの単純な実装だと考えてよいでしょう。特別な事情がない限り、列モデルは JTable クラスがデフォルトで設定しているオブジェクトで十分です。

java.lang.Object
  |
  +--javax.swing.table.DefaultTableColumnModel

public class DefaultTableColumnModel extends Object implements TableColumnModel,
	PropertyChangeListener, ListSelectionListener, Serializable

このクラスのコンストラクタは、引数を受け取らない単純なコンストラクタだけが公開されてます。

JTable クラスのオブジェクトに新しい列モデルを設定するには JTable クラスの setColumnModel() メソッドを使います。同様に、設定されている列モデルを取得したければ getColumnModel() メソッドから得ることができます。

public void setColumnModel(TableColumnModel columnModel)

public TableColumnModel getColumnModel()

何らかの動的な関係データを簡易表示するテーブルなどでは、列を動的に挿入したり、削除したりする必要があるかもしれません。そのような場合は、テーブルの列モデルを所得し、列を制御することができるのです。

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

public class Test extends JFrame implements ActionListener {
	public static void main(String args[]) {
		JFrame win = new Test();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.show();
	}

	JTable table = new JTable();
	private JButton addButton = new JButton("列を追加");
	private JButton removeButton = new JButton("列を削除");

	public Test() {
		JPanel panel = new JPanel();
		panel.setLayout(new FlowLayout());
		panel.add(addButton);
		panel.add(removeButton);

		addButton.addActionListener(this);
		removeButton.addActionListener(this);

		table.getColumnModel().setColumnSelectionAllowed(true);
		JScrollPane pane = new JScrollPane(table);

		getContentPane().add(pane);
		getContentPane().add(panel , BorderLayout.SOUTH);
	}

	public void actionPerformed(ActionEvent e) {
		TableColumnModel model = table.getColumnModel();

		if (e.getSource() == addButton) {
			TableColumn column = new TableColumn();
			column.setHeaderValue("列:" + model.getColumnCount());
			model.addColumn(column);
		}
		else if (e.getSource() == removeButton) {
			if (model.getColumnCount() == 0) return;
			model.removeColumn(model.getColumn(
				model.getColumnCount() - 1
			));
		}
	}
}

実行結果

このプログラムは、ウィンドウ下部のボタンを押すことで、中央に表示されているテーブルの列を、任意のタイミングで追加したり削除したりすることができます。追加ボタンを押せば新しい列が末尾に挿入され、削除ボタンを押せば末尾の列が削除されます。プログラムの actionPerformed() メソッドでは、テーブルに設定されている列モデルを取得し、押されたボタンに応じて TableColumn オブジェクトを追加したり、削除したりしているのです。

列に対する変更は、列モデルに設定されているリスナ javax.swing.event.TableColumnModelListener インタフェースに報告されます。このインタフェースには、表 11_03_03 に示す 5 つのメソッドが宣言されています。

列の状態が変化したタイミングで何らかの処理が必要である場合や、列の数を常に監視したい場合などは、TableColumnModelListener インタフェースを実装し、TableColumnModel クラスの addColumnModelListener() から追加すれば良いでしょう。