---
category: swing
folder: TableHeaderCheckBox
title: JTableHeaderにJCheckBoxを追加してセルの値を切り替える
tags: [JTable, JTableHeader, JCheckBox, TableCellRenderer, MouseListener, Icon, JLabel]
author: aterai
pubdate: 2009-02-16T20:29:54+09:00
description: JTableHeaderにJCheckBoxを追加して、同じ列のJCheckBoxで表示している値をすべて切り替えます。
image: https://lh6.googleusercontent.com/_9Z4BYR88imo/TQTUf8Li6CI/AAAAAAAAAmI/mj7-1IwK86o/s800/TableHeaderCheckBox.png
hreflang:
    href: https://java-swing-tips.blogspot.com/2009/02/jtableheader-checkbox.html
    lang: en
---
* 概要 [#summary]
`JTableHeader`に`JCheckBox`を追加して、同じ列の`JCheckBox`で表示している値をすべて切り替えます。

#download(https://lh6.googleusercontent.com/_9Z4BYR88imo/TQTUf8Li6CI/AAAAAAAAAmI/mj7-1IwK86o/s800/TableHeaderCheckBox.png)

* サンプルコード [#sourcecode]
#code(link){{
enum Status { SELECTED, DESELECTED, INDETERMINATE }
class HeaderRenderer extends JCheckBox implements TableCellRenderer {
  private final JLabel label = new JLabel("Check All");
  private final int targetColumnIndex;
  public HeaderRenderer(JTableHeader header, int index) {
    super((String) null);
    this.targetColumnIndex = index;
    setOpaque(false);
    setFont(header.getFont());
    header.addMouseListener(new MouseAdapter() {
      @Override public void mouseClicked(MouseEvent e) {
        JTableHeader header = (JTableHeader) e.getComponent();
        JTable table = header.getTable();
        TableColumnModel columnModel = table.getColumnModel();
        int vci = columnModel.getColumnIndexAtX(e.getX());
        int mci = table.convertColumnIndexToModel(vci);
        if (mci == targetColumnIndex) {
          TableColumn column = columnModel.getColumn(vci);
          boolean b = Status.DESELECTED == column.getHeaderValue();
          boolean b = column.getHeaderValue() == Status.DESELECTED;
          TableModel m = table.getModel();
          for (int i = 0; i < m.getRowCount(); i++) {
            m.setValueAt(b, i, mci);
          }
          column.setHeaderValue(b ? Status.SELECTED : Status.DESELECTED);
          // header.repaint();
        }
      }
    });
  }
  @Override public Component getTableCellRendererComponent(
        JTable tbl, Object val, boolean isS, boolean hasF, int row, int col) {
    TableCellRenderer r = tbl.getTableHeader().getDefaultRenderer();
    JLabel l = (JLabel) r.getTableCellRendererComponent(tbl, val, isS, hasF, row, col);
    if (targetColumnIndex == tbl.convertColumnIndexToModel(col)) {
      if (val instanceof Status) {
        switch ((Status) val) {
        case SELECTED:
          setSelected(true);
          setEnabled(true);
          break;
        case DESELECTED:
          setSelected(false);
          setEnabled(true);
          break;
        case INDETERMINATE:
          setSelected(true);
          setEnabled(false);
          break;
        default:
          throw new AssertionError("Unknown Status");
        }
      } else {
        setSelected(true);
        setEnabled(false);
      }
      label.setIcon(new ComponentIcon(this));
      l.setIcon(new ComponentIcon(label));
      l.setText(null);
    }
    return l;
  }
}
class ComponentIcon implements Icon {
  private final JComponent cmp;
  public ComponentIcon(JComponent cmp) {
    this.cmp = cmp;
  }
  @Override public int getIconWidth() {
    return cmp.getPreferredSize().width;
  }
  @Override public int getIconHeight() {
    return cmp.getPreferredSize().height;
  }
  @Override public void paintIcon(Component c, Graphics g, int x, int y) {
    SwingUtilities.paintComponent(g, cmp, c.getParent(), x, y, getIconWidth(), getIconHeight());
  }
}
}}

* 解説 [#explanation]
上記のサンプルでは、`JCheckBox`のアイコンを作成し、これを`TableCellRenderer`(=`JLabel`)に`setIcon(...)`メソッドで設定しています。

- `JCheckBox`をアイコン化しているので、これをクリックしてもイベントは発生しない
-- 代わりにヘッダ自体に`MouseListener`を追加し、マウスクリックイベントが発生するとアイコンの入れ替えることで、チェック状態の表示を更新する
- `LookAndFeel`によっては、`TableCellRenderer`のソートアイコンと競合する場合がある

----
- `JTable`のモデルの更新
-- `JTable`のセル中にある`JCheckBox`が全てチェックされた場合、ヘッダの`JCheckBox`もチェックされる
-- `JTable`のセル中にある`JCheckBox`のチェックが全てクリアされた場合、ヘッダの`JCheckBox`のチェックもクリアされる
-- `JTable`のセル中にある`JCheckBox`でチェックの有無が混在している場合、ヘッダの`JCheckBox`は薄くチェックされた状態(`setEnabled(false)`で`setSelected(true)`)になる
- 注:
-- このサンプルでは、行の追加、削除を考慮していない
-- 行の追加、削除に対応したサンプルは、[[JTableのモデルが変更されたことをイベントで受け取る>Swing/TableModelEvent]]に移動

* 参考リンク [#reference]
- [http://www.coderanch.com/t/343795/Swing-AWT-SWT-JFace/java/Check-Box-JTable-header Check Box in JTable header (Swing / AWT / SWT / JFace forum at JavaRanch)]
- [[JCheckBoxに不定状態のアイコンを追加する>Swing/TriStateCheckBox]]
- [[JTableのモデルが変更されたことをイベントで受け取る>Swing/TableModelEvent]]

* コメント [#comment]
#comment
- `LookAndFeel`を`Nimbus`に変更したとき、`JTableHeader`の高さがおかしい? -- &user(aterai); &new{2011-05-30 (月) 22:13:05};
-- レンダラー中で`label.setText(null);`や、`JLabel`を挟んで二重に`ImageIcon`を作成するなどして回避中。 -- &user(aterai); &new{2012-03-02 (金) 16:01:51};
- [https://java-swing-tips.blogspot.com/2009/02/jtableheader-checkbox.html Java Swing Tips: JTableHeader CheckBox]で、ヘッダクリックで全選択した後、テーブル中のチェックを外すと、ヘッダのチェックボックスもチェック外した方がよくないか?との指摘を頂いたので、(`Gmail`などのチェックボックス風の)不定状態?を導入しました。 -- &user(aterai); &new{2011-06-14 (火) 14:44:19};

#comment