TITLE:JTreeのすべてのノードにJCheckBoxを追加する
#navi(../)
#tags(JTree, JCheckBox, TreeCellRenderer, TreeCellEditor, TreeModelListener)
RIGHT:Posted by &author(aterai); at 2012-02-06
* JTreeのすべてのノードにJCheckBoxを追加する [#v2eb0f91]
`JTree`のすべてのノードに編集可能な`JCheckBox`を追加します。

#download
#ref(https://lh4.googleusercontent.com/-DK6aW3VNikg/TygxL3j8UoI/AAAAAAAABIw/6_9FyPe4v7U/s800/CheckBoxNodeEditor.png)

** サンプルコード [#pdf0395c]
#code(link){{
class CheckBoxNodeEditor extends TriStateCheckBox implements TreeCellEditor {
  private DefaultTreeCellRenderer renderer = new DefaultTreeCellRenderer();
  private final JPanel panel = new JPanel(new BorderLayout());
  private String str = null;
  public CheckBoxNodeEditor() {
    super();
    this.addActionListener(new ActionListener() {
      @Override public void actionPerformed(ActionEvent e) {
        //System.out.println("actionPerformed: stopCellEditing");
        stopCellEditing();
      }
    });
    panel.setFocusable(false);
    panel.setRequestFocusEnabled(false);
    panel.setOpaque(false);
    panel.add(this, BorderLayout.WEST);
    this.setOpaque(false);
  }
  @Override public Component getTreeCellEditorComponent(
      JTree tree, Object value, boolean isSelected,
      boolean expanded, boolean leaf, int row) {
    JLabel l = (JLabel)renderer.getTreeCellRendererComponent(
        tree, value, true, expanded, leaf, row, true);
    l.setFont(tree.getFont());
    if(value instanceof DefaultMutableTreeNode) {
      this.setEnabled(tree.isEnabled());
      this.setFont(tree.getFont());
      Object userObject = ((DefaultMutableTreeNode)value).getUserObject();
      if(userObject instanceof CheckBoxNode) {
        CheckBoxNode node = (CheckBoxNode)userObject;
        if(node.status==Status.INDETERMINATE) {
          setIcon(new IndeterminateIcon());
        }else{
          setIcon(null);
        }
        l.setText(node.label);
        setSelected(node.status==Status.SELECTED);
        str = node.label;
      }
      //panel.add(this, BorderLayout.WEST);
      panel.add(l);
      return panel;
    }
    return l;
  }
  @Override public Object getCellEditorValue() {
    return new CheckBoxNode(str, isSelected()?Status.SELECTED:Status.DESELECTED);
  }
  @Override public boolean isCellEditable(EventObject e) {
    if(e instanceof MouseEvent && e.getSource() instanceof JTree) {
      MouseEvent me = (MouseEvent)e;
      JTree tree = (JTree)e.getSource();
      TreePath path = tree.getPathForLocation(me.getX(), me.getY());
      Rectangle r = tree.getPathBounds(path);
      if (r == null) {
        return false;
      }
      Dimension d = getPreferredSize();
      r.setSize(new Dimension(d.width, r.height));
      if (r.contains(me.getPoint())) {
        return true;
      }
    }
    return false;
  }
  @Override public void updateUI() {
    super.updateUI();
    setName("Tree.cellEditor");
    if(panel!=null) {
      //panel.removeAll(); //??? Change to Nimbus LnF, JDK 1.6.0
      panel.updateUI();
      //panel.add(this, BorderLayout.WEST);
    }
    //???#1: JDK 1.6.0 bug??? @see 1.7.0 DefaultTreeCellRenderer#updateUI()
    //if(System.getProperty("java.version").startsWith("1.6.0")) {
    //  renderer = new DefaultTreeCellRenderer();
    //}
  }
//...
}}

** 解説 [#a6fcfbcf]
上記のサンプルでは、`JCheckBox`を継承する`TreeCellEditor`、`TreeCellRenderer`を作成し、`TreeCellEditor#getTreeCellEditorComponent(...)`などは、この`JCheckBox`、`JLabel`(文字列、アイコン)などを含む`JPanel`を生成して返しています。

`JPanel`を継承する`TreeCellEditor`、`TreeCellRenderer`でも、`JDK 1.7.0`、`JDK 1.6.0_30`などでは、問題なく動作するようです。

#code{{
class CheckBoxNodeRenderer extends JPanel implements TreeCellRenderer {
  private DefaultTreeCellRenderer renderer = new DefaultTreeCellRenderer();
  private final TriStateCheckBox check = new TriStateCheckBox();
  public CheckBoxNodeRenderer() {
    super(new BorderLayout());
    String uiName = getUI().getClass().getName();
    if(uiName.contains("Synth") && System.getProperty("java.version").startsWith("1.7.0")) {
      System.out.println("XXX: FocusBorder bug?, JDK 1.7.0, Nimbus start LnF");
      renderer.setBackgroundSelectionColor(new Color(0,0,0,0));
    }
    setFocusable(false);
    setRequestFocusEnabled(false);
    setOpaque(false);
    add(check, BorderLayout.WEST);
    check.setOpaque(false);
  }
  @Override public Component getTreeCellRendererComponent(
      JTree tree, Object value, boolean selected,
      boolean expanded, boolean leaf, int row, boolean hasFocus) {
    JLabel l = (JLabel)renderer.getTreeCellRendererComponent(
        tree, value, selected, expanded, leaf, row, hasFocus);
    l.setFont(tree.getFont());
    if(value instanceof DefaultMutableTreeNode) {
      check.setEnabled(tree.isEnabled());
      check.setFont(tree.getFont());
      Object userObject = ((DefaultMutableTreeNode)value).getUserObject();
      if(userObject instanceof CheckBoxNode) {
        CheckBoxNode node = (CheckBoxNode)userObject;
        if(node.status==Status.INDETERMINATE) {
          check.setIcon(new IndeterminateIcon());
        }else{
          check.setIcon(null);
        }
        l.setText(node.label);
        check.setSelected(node.status==Status.SELECTED);
      }
      add(l);
      return this;
    }
    return l;
  }
  @Override public void updateUI() {
    super.updateUI();
    if(check!=null) {
      //removeAll(); //??? Change to Nimbus LnF, JDK 1.6.0
      check.updateUI();
      //add(check, BorderLayout.WEST);
    }
    setName("Tree.cellRenderer");
    //???#1: JDK 1.6.0 bug??? @see 1.7.0 DefaultTreeCellRenderer#updateUI()
    //if(System.getProperty("java.version").startsWith("1.6.0")) {
    //  renderer = new DefaultTreeCellRenderer();
    //}
  }
}
}}

----
ノードのチェック変更で、子ノードのチェックをすべて揃えたり、親ノードの状態変更は、`TreeModelListener`を追加して行なっています。

----
- `JDK 1.6.0`で、`LookAndFeel`を`Nimbus`などに変更すると、セルエディタなどが更新されず?表示がおかしくなる場合があるので、`JTree#updateUI()`を以下のようにオーバーライドして回避

#code{{
JTree tree = new JTree() {
  @Override public void updateUI() {
    setCellRenderer(null);
    setCellEditor(null);
    super.updateUI();
    //???#1: JDK 1.6.0 bug??? Nimbus LnF
    setCellRenderer(new CheckBoxNodeRenderer());
    setCellEditor(new CheckBoxNodeEditor());
  }
};
}}

- `JDK 1.7.0`で、初期`LookAndFeel`を`Nimbus`にすると、ノードにフォーカスがある場合のグラデーション描画がノードの背景色で塗りつぶされてしまう?のを、以下のようにして回避
-- https://lh3.googleusercontent.com/-DQgyx52YcsQ/T6sfFSWGIpI/AAAAAAAABMc/jAx8XeuMeWI/s800/CheckBoxNodeEditor1.png

#code{{
public CheckBoxNodeRenderer() {
  super();
  String uiName = getUI().getClass().getName();
  if(uiName.contains("Synth") &&
     System.getProperty("java.version").startsWith("1.7.0")) {
    System.out.println("XXX: FocusBorder bug?, JDK 1.7.0, Nimbus start LnF");
    renderer.setBackgroundSelectionColor(new Color(0,0,0,0));
  }
//...
}}

- %%`JDK 1.7.0`で、ノードのチェックボックスをクリックしても、初回だけ反応しない%% `1.7.0_60`で修正されている
-- `JDK 1.6.0_30`などは問題なし
-- `TreeCellEditor#isCellEditable()`をオーバーライドして、初回のみセルエディタのサイズを以下のように設定
-- `JDK 1.8.0`では、修正されている
-- [http://bugs.java.com/bugdatabase/view_bug.do?bug_id=8023474 Bug ID: JDK-8023474 First mousepress doesn't start editing in JTree]

#code{{
if(isFirstTime && System.getProperty("java.version").startsWith("1.7.0")) {
  System.out.println("XXX: Java 7, only on first run\n"+getBounds());
  setBounds(new Rectangle(0,0,d.width,r.height));
}
}}

** 参考リンク [#ab7883bf]
- [[JTreeの葉ノードをJCheckBoxにする>Swing/CheckBoxNodeTree]]
- [[JCheckBoxに不定状態のアイコンを追加する>Swing/TriStateCheckBox]]

** コメント [#nbcaf27c]
- 親ノードまでではなく、ルートノードまで不定状態の変更を行うように修正。 -- [[aterai]] &new{2012-03-23 (金) 17:43:32};

#comment