Swing/CheckBoxCellList のバックアップ(No.2)

TITLE:JListのセルにJCheckBoxを使用する

Posted by aterai at 2011-03-28

JListのセルにJCheckBoxを使用する

JListのセルにJCheckBoxを使用して、チェックボックスの一覧を作成します。

&jnlp;
&jar;
&zip;

サンプルコード

class CheckBoxCellRenderer extends JCheckBox
    implements ListCellRenderer, MouseListener, MouseMotionListener {
  @Override public Component getListCellRendererComponent(
    JList list,
    Object value,
    int index,
    boolean isSelected,
    boolean cellHasFocus) {
    this.setOpaque(true);
    if(isSelected) {
      this.setBackground(list.getSelectionBackground());
      this.setForeground(list.getSelectionForeground());
    }else{
      this.setBackground(list.getBackground());
      this.setForeground(list.getForeground());
    }
    if(value instanceof CheckBoxNode) {
      this.setSelected(((CheckBoxNode)value).selected);
      if(index==pressedRowIndex) {
        this.getModel().setArmed(true);
        this.getModel().setPressed(true);
      }else{
        this.getModel().setRollover(index==rollOverRowIndex);
        this.getModel().setArmed(false);
        this.getModel().setPressed(false);
      }
    }
    this.setText(value.toString());
    return this;
  }
  private int rollOverRowIndex = -1;
  private int pressedRowIndex = -3;
  @Override public void mouseExited(MouseEvent e) {
    rollOverRowIndex = -1;
    JList c = (JList)e.getSource();
    c.repaint();
  }
  @Override public void mouseClicked(MouseEvent e) {
    if(e.getButton()==MouseEvent.BUTTON1) {
      JList t = (JList)e.getComponent();
      DefaultListModel m = (DefaultListModel)t.getModel();
      Point p = e.getPoint();
      int index  = t.locationToIndex(p);
      CheckBoxNode n = (CheckBoxNode)m.get(index);
      Component c = t.getCellRenderer().getListCellRendererComponent(
          t, n, index, false, false);
      Dimension d = c.getPreferredSize();
      if(d.width>=p.x) {
        m.set(index, new CheckBoxNode(n.text, !n.selected));
        t.repaint();
        t.repaint(t.getCellBounds(index, index));
      }
    }
  }
  @Override public void mouseEntered(MouseEvent e) {}
  private int pressStartIndex = -1;
  @Override public void mousePressed(MouseEvent e) {
    if(e.getButton()==MouseEvent.BUTTON1) {
      JList c = (JList)e.getSource();
      int row = c.locationToIndex(e.getPoint());
      pressStartIndex = row;
      if(row != pressedRowIndex) {
        pressedRowIndex = row;
        c.repaint();
      }
    }
  }
  @Override public void mouseReleased(MouseEvent e) {
    pressedRowIndex = -1;
    pressStartIndex = -1;
  }
  @Override public void mouseDragged(MouseEvent e) {
    JList c = (JList)e.getSource();
    int row = c.locationToIndex(e.getPoint());
    if(row != rollOverRowIndex) {
      rollOverRowIndex = -1;
    }
    if(row != pressedRowIndex) {
      pressedRowIndex = -1;
    }
    if(row == pressStartIndex) {
      pressedRowIndex = row;
    }
    c.repaint();
  }
  @Override public void mouseMoved(MouseEvent e) {
    JList c = (JList)e.getSource();
    int row = c.locationToIndex(e.getPoint());
    if(row != rollOverRowIndex) {
      rollOverRowIndex = row;
      c.repaint();
    }
  }
}

View in GitHub: Java, Kotlin

解説

左: "JCheckBox Cell in JList"
- JCheckBoxを継承するListCellRendererを設定
- チェックボックスのロールオーバーなどは、JListにマウスリスナーを設定して表示
- JList#putClientProperty("List.isFileList", Boolean.TRUE);で、クリックが有効になる領域をチェックボックスの幅に制限
右: "JCheckBox in Box"
- Box.createVerticalBox()にJCheckBoxを追加
- JCheckBox#setAlignmentX(Component.LEFT_ALIGNMENT);で左揃えに設定

JTreeの葉ノードをJCheckBoxにするのセルレンダラーを使ったJTreeに、JTree#setRootVisible(false)を設定しても、ほぼ同様のチェックボックスの一覧を作成することができます。

import java.awt.*;
import java.awt.event.*;
import java.util.*;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.tree.*;

public class TreeCheckBoxListTest {
  public JComponent makeUI() {
    DefaultMutableTreeNode root = new DefaultMutableTreeNode("JTree");
    for(int i=0; i<16; i++) {
      root.add(new DefaultMutableTreeNode(new CheckBoxNode("No."+i, i%2==0)));
    }
    JTree tree = new JTree(new DefaultTreeModel(root));
    tree.setEditable(true);
    tree.setRootVisible(false);
    tree.setCellRenderer(new CheckBoxNodeRenderer());
    tree.setCellEditor(new CheckBoxNodeEditor(tree));
    return new JScrollPane(tree);
  }
  public static void main(String[] args) {
    EventQueue.invokeLater(new Runnable() {
      @Override public void run() {
        createAndShowGUI();
      }
    });
  }
  public static void createAndShowGUI() {
    JFrame f = new JFrame();
    f.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
    f.getContentPane().add(new TreeCheckBoxListTest().makeUI());
    f.setSize(320, 240);
    f.setLocationRelativeTo(null);
    f.setVisible(true);
  }
}
class CheckBoxNode {
  public final String text;
  public final boolean selected;
  public CheckBoxNode(String text, boolean selected) {
    this.text = text;
    this.selected = selected;
  }
  @Override public String toString() {
    return text;
  }
}

class CheckBoxNodeRenderer extends JCheckBox implements TreeCellRenderer {
  private TreeCellRenderer renderer = new DefaultTreeCellRenderer();
  @Override public Component getTreeCellRendererComponent(
      JTree tree, Object value, boolean selected, boolean expanded,
      boolean leaf, int row, boolean hasFocus) {
    if(leaf && value != null && value instanceof DefaultMutableTreeNode) {
      this.setOpaque(false);
      Object userObject = ((DefaultMutableTreeNode)value).getUserObject();
      if(userObject!=null && userObject instanceof CheckBoxNode) {
        CheckBoxNode node = (CheckBoxNode)userObject;
        this.setText(node.text);
        this.setSelected(node.selected);
      }
      return this;
    }
    return renderer.getTreeCellRendererComponent(
        tree, value, selected, expanded, leaf, row, hasFocus);
  }
}

class CheckBoxNodeEditor extends JCheckBox implements TreeCellEditor {
  private final JTree tree;
  public CheckBoxNodeEditor(JTree tree) {
    super();
    this.tree = tree;
    setOpaque(false);
    setFocusable(false);
    addActionListener(new ActionListener() {
      @Override public void actionPerformed(ActionEvent e) {
        stopCellEditing();
      }
    });
  }
  @Override public Component getTreeCellEditorComponent(
      JTree tree, Object value, boolean isSelected, boolean expanded,
      boolean leaf, int row) {
    if(leaf && value != null && value instanceof DefaultMutableTreeNode) {
      Object userObject = ((DefaultMutableTreeNode)value).getUserObject();
      if(userObject!=null && userObject instanceof CheckBoxNode) {
        this.setSelected(((CheckBoxNode)userObject).selected);
      } else {
        this.setSelected(false);
      }
      this.setText(value.toString());
    }
    return this;
  }
  @Override public Object getCellEditorValue() {
    return new CheckBoxNode(getText(), isSelected());
  }
  @Override public boolean isCellEditable(EventObject e) {
    return (e != null && e instanceof MouseEvent);
  }
  //Copid from AbstractCellEditor
  //protected EventListenerList listenerList = new EventListenerList();
  //transient protected ChangeEvent changeEvent = null;
  @Override public boolean shouldSelectCell(java.util.EventObject anEvent) {
    return true;
  }
  @Override public boolean stopCellEditing() {
    fireEditingStopped();
    return true;
  }
  @Override public void  cancelCellEditing() {
    fireEditingCanceled();
  }
  @Override public void addCellEditorListener(CellEditorListener l) {
    listenerList.add(CellEditorListener.class, l);
  }
  @Override public void removeCellEditorListener(CellEditorListener l) {
    listenerList.remove(CellEditorListener.class, l);
  }
  public CellEditorListener[] getCellEditorListeners() {
    return listenerList.getListeners(CellEditorListener.class);
  }
  protected void fireEditingStopped() {
    // Guaranteed to return a non-null array
    Object[] listeners = listenerList.getListenerList();
    // Process the listeners last to first, notifying
    // those that are interested in this event
    for(int i = listeners.length-2; i>=0; i-=2) {
      if(listeners[i]==CellEditorListener.class) {
        // Lazily create the event:
        if(changeEvent == null) changeEvent = new ChangeEvent(this);
        ((CellEditorListener)listeners[i+1]).editingStopped(changeEvent);
      }
    }
  }
  protected void fireEditingCanceled() {
    // Guaranteed to return a non-null array
    Object[] listeners = listenerList.getListenerList();
    // Process the listeners last to first, notifying
    // those that are interested in this event
    for(int i = listeners.length-2; i>=0; i-=2) {
      if(listeners[i]==CellEditorListener.class) {
        // Lazily create the event:
        if(changeEvent == null) changeEvent = new ChangeEvent(this);
        ((CellEditorListener)listeners[i+1]).editingCanceled(changeEvent);
      }
    }
  }
}

JListのセルにJCheckBoxを使用する

サンプルコード

解説

コメント