Swing/TriStateCheckBox の変更点

---
category: swing
folder: TriStateCheckBox
title: JCheckBoxに不定状態のアイコンを追加する
tags: [JCheckBox, Icon, UIManager, JTableHeader, JTable]
author: aterai
pubdate: 2011-12-12T15:00:11+09:00
description: JCheckBoxの選択状態、非選択状態に加えて不定状態を表すアイコンを追加します。
image: https://lh6.googleusercontent.com/-Rs-vnlD35Cg/TuTNCuEvU_I/AAAAAAAABF4/IzDezx4Rq8M/s800/TriStateCheckBox.png
---
* Summary [#summary]
`JCheckBox`の選択状態、非選択状態に加えて不定状態を表すアイコンを追加します。

#download(https://lh6.googleusercontent.com/-Rs-vnlD35Cg/TuTNCuEvU_I/AAAAAAAABF4/IzDezx4Rq8M/s800/TriStateCheckBox.png)

* Source Code Examples [#sourcecode]
#code(link){{
class TriStateCheckBox extends JCheckBox {
  private transient TriStateActionListener listener;
  private transient Icon icon;

  protected TriStateCheckBox(String title) {
    super(title);
  }

  public void updateStatus(Status s) {
    switch (s) {
      case SELECTED:
        setSelected(true);
        setIcon(null);
        break;
      case DESELECTED:
        setSelected(false);
        setIcon(null);
        break;
      case INDETERMINATE:
        setSelected(false);
        setIcon(icon);
        break;
      default:
        throw new AssertionError("Unknown Status");
    }
  }

  @Override public void updateUI() {
    setIcon(null);
    removeActionListener(listener);
    super.updateUI();
    listener = new TriStateActionListener();
    icon = new IndeterminateIcon();
    listener.setIcon(icon);
    addActionListener(listener);
    if (Objects.nonNull(getIcon())) {
      setIcon(icon);
    }
  }
}

class IndeterminateIcon implements Icon {
  // private  FOREGROUND = UIManager.getColor("CheckBox.foreground");
  private static final Color FOREGROUND = Color.BLACK;
  private static final int MARGIN = 4;
  private static final int HEIGHT = 2;
  private final Icon icon = UIManager.getIcon("CheckBox.icon");

  @Override public void paintIcon(Component c, Graphics g, int x, int y) {
    Graphics2D g2 = (Graphics2D) g.create();
    g2.translate(x, y);
    icon.paintIcon(c, g2, 0, 0);
    g2.setPaint(FOREGROUND);
    g2.fillRect(
      MARGIN,
      (getIconHeight() - HEIGHT) / 2,
      getIconWidth() - MARGIN - MARGIN,
      HEIGHT);
    g2.dispose();
  }

  @Override public int getIconWidth() {
    return icon.getIconWidth();
  }

  @Override public int getIconHeight() {
    return icon.getIconHeight();
  }
}

enum Status {
  SELECTED, DESELECTED, INDETERMINATE
}
}}

* Description [#explanation]
* Description [#description]
- `UIManager.getIcon("CheckBox.icon")`で取得した非選択状態のチェックボックスアイコンの上に一本の横棒を引いて不定状態のアイコンを作成
- `JCheckBox#getIcon()`が`null`の場合、チェックボックスは不定状態であると判定して上記の不定状態のアイコンを表示
- 横棒の色は`UIManager.getColor("CheckBox.foreground")`を使用しているが`LookAndFeel`によっては無意味
- [[JTableHeaderにJCheckBoxを追加してセルの値を切り替える>Swing/TableHeaderCheckBox]]で使用すると`NimbusLookAndFeel`でアイコンと文字列のベースラインがずれる？
-- 文字列も`ImageIcon`にして回避
- `NimbusLookAndFeel`で不定状態アイコンのフォーカスやロールオーバーが表示されない

* Reference [#reference]
- [https://stackoverflow.com/questions/1263323/tristate-checkboxes-in-java swing - Tristate Checkboxes in Java - Stack Overflow]

* Comment [#comment]
#comment

#comment