如何在 Java Swing 中制作带有复选框的列表？

Question

在 Java Swing 中拥有每个项目都带有复选框的列表的最佳方式是什么？

即一个 JList，其中每个项目都有一些文本和一个复选框？

Answer 1

只需实现 ListCellRenderer

public class CheckboxListCellRenderer extends JCheckBox implements ListCellRenderer {

    public Component getListCellRendererComponent(JList list, Object value, int index, 
            boolean isSelected, boolean cellHasFocus) {

        setComponentOrientation(list.getComponentOrientation());
        setFont(list.getFont());
        setBackground(list.getBackground());
        setForeground(list.getForeground());
        setSelected(isSelected);
        setEnabled(list.isEnabled());

        setText(value == null ? "" : value.toString());  

        return this;
    }
}

并设置渲染器，

JList list = new JList();
list.setCellRenderer(new CheckboxListCellRenderer());

这将导致

详细信息位于 自定义 swing 组件渲染器。

PS：如果您想要单选元素，只需将 extends JCheckbox 替换为 extends JRadioButton 即可。

Answer 2

创建自定义 ListCellRenderer 并将其分配给 JList。

此自定义 ListCellRenderer 必须在 getListCellRendererComponent(...) 方法的实现中返回一个 JCheckbox。

但是这个JCheckbox将不可编辑，只是在屏幕上进行简单的绘制，由您选择何时必须“勾选”或不“勾选”这个JCheckbox，

例如，显示当选择该行时（参数isSelected），它会打勾，但是这样，如果选择发生变化，检查状态将不会保持。 最好显示它检查了 ListModel 下面的数据，但接下来由您来实现更改数据检查状态的方法，并将更改通知 JList< /code> 重新绘制。

如果您需要的话，我稍后会发布示例代码

ListCellRenderer

Answer 3

一个很好的答案是这个 CheckBoxList。 它实现了 Telcontar 的答案（尽管是 3 年前:)...我在 Java 1.6 中使用它没有任何问题。 我还添加了一个像这样的 addCheckbox 方法（当然可以更短，有一段时间没有使用 Java）：

public void addCheckbox(JCheckBox checkBox) {
    ListModel currentList = this.getModel();
    JCheckBox[] newList = new JCheckBox[currentList.getSize() + 1];
    for (int i = 0; i < currentList.getSize(); i++) {
        newList[i] = (JCheckBox) currentList.getElementAt(i);
    }
    newList[newList.length - 1] = checkBox;
    setListData(newList);
}

我尝试了 Jidesoft 的演示，使用 CheckBoxList 我遇到了一些问题（不起作用的行为）。 如果我发现链接到的 CheckBoxList 存在问题，我将修改此答案。

Answer 4

使用 Java，很有可能有人已经实现了您需要的小部件或实用程序。 大型 OSS 社区的部分好处。 除非您真的想自己动手，否则无需重新发明轮子。 在这种情况下，这将是一次很好的 CellRenderers 和 Editor 学习练习。

我的项目在JIDE的帮助下取得了巨大的成功。 您想要的组件（复选框列表）位于 JIDE 公共层（它是 OSS，托管在 java.net 上）。 商业的东西也很好，但你不需要它。

http://www.jidesoft.com/products/oss.htm
https://jide-oss.dev.java.net/

Answer 5

Swing 中的所有聚合组件（即由其他组件组成的组件，例如 JTable、JTree 或 JComboBox）都可以高度自定义。 例如，JTable 组件通常显示 JLabel 组件的网格，但它也可以显示 JButton、JTextField 甚至其他 JTable。 然而，让这些聚合组件显示非默认对象是比较容易的部分。 由于 Swing 将组件分为“渲染器”和“编辑器”，因此使它们正确响应键盘和鼠标事件是一项艰巨的任务。 这种分离（在我看来）是一个糟糕的设计选择，并且只会在尝试扩展 Swing 组件时使问题变得复杂。

要明白我的意思，请尝试增强 Swing 的 JList 组件，以便它显示复选框而不是标签。 根据 Swing 理念，此任务需要实现两个接口：ListCellRenderer（用于绘制复选框）和 CellEditor（用于处理复选框上的键盘和鼠标事件）。 实现 ListCellRenderer 接口很容易，但 CellEditor 接口可能相当笨拙且难以理解。 在这种特殊情况下，我建议完全忘记 CellEditor 并直接处理输入事件，如以下代码所示。

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

public class CheckBoxList extends JList
{
   protected static Border noFocusBorder = new EmptyBorder(1, 1, 1, 1);

   public CheckBoxList()
   {
      setCellRenderer(new CellRenderer());

      addMouseListener(new MouseAdapter()
         {
            public void mousePressed(MouseEvent e)
            {
               int index = locationToIndex(e.getPoint());

               if (index != -1) {
                  JCheckBox checkbox = (JCheckBox)
                              getModel().getElementAt(index);
                  checkbox.setSelected(
                                     !checkbox.isSelected());
                  repaint();
               }
            }
         }
      );

      setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
   }

   protected class CellRenderer implements ListCellRenderer
   {
      public Component getListCellRendererComponent(
                    JList list, Object value, int index,
                    boolean isSelected, boolean cellHasFocus)
      {
         JCheckBox checkbox = (JCheckBox) value;
         checkbox.setBackground(isSelected ?
                 getSelectionBackground() : getBackground());
         checkbox.setForeground(isSelected ?
                 getSelectionForeground() : getForeground());
         checkbox.setEnabled(isEnabled());
         checkbox.setFont(getFont());
         checkbox.setFocusPainted(false);
         checkbox.setBorderPainted(true);
         checkbox.setBorder(isSelected ?
          UIManager.getBorder(
           "List.focusCellHighlightBorder") : noFocusBorder);
         return checkbox;
      }
   }
}

在这里，我拦截列表框中的鼠标单击并模拟相应复选框的单击。 结果是一个“CheckBoxList”组件，它比使用 CellEditor 界面的等效组件更简单、更小。 要使用该类，只需实例化它，然后通过调用 setListData 向其传递 JCheckBox 对象（或 JCheckBox 对象的子类）的数组。 请注意，此组件中的复选框不会响应按键（即空格键），但如果需要，您可以随时添加自己的按键侦听器。

来源：DevX.com

Answer 6

我建议您使用 GridLayout 为 1 列的 JPanel。 将复选框添加到 JPanel 中，并将 JPanel 设置为 JScrollPane 的数据源。 要获取选中的复选框，只需调用 JPanel 的 getComponents() 即可获取复选框。

Answer 7

我不喜欢将复选框放入模型中的解决方案。 模型应该只包含数据而不是显示元素。

我发现这个 http://www.java2s.com/Tutorials/Java /Swing_How_to/JList/Create_JList_of_CheckBox.htm

我对其进行了一些优化。 ACTIVE 标志代表复选框，SELECTED 标志显示光标所在的条目。

我的版本需要一个渲染器

import java.awt.Component;

import javax.swing.JCheckBox;
import javax.swing.JList;
import javax.swing.ListCellRenderer;

class CheckListRenderer extends JCheckBox implements ListCellRenderer<Entity> {

    @Override
    public Component getListCellRendererComponent(JList<? extends Entity> list, 
        Entity value, int index, boolean isSelected, boolean cellHasFocus) {

            setEnabled(list.isEnabled());
            setSelected(value.isActive()); // sets the checkbox
            setFont(list.getFont());
        if (isSelected) { // highlights the currently selected entry
            setBackground(list.getSelectionBackground());
            setForeground(list.getSelectionForeground());
        } else {
            setBackground(list.getBackground());
            setForeground(list.getForeground());
        }
        setText(value.toString()+" - A" + value.isActive()+" - F"+cellHasFocus+" - S"+isSelected );
        return this;
    }

}

和一个获得活动字段的实体：

public class Entity {

    private boolean active = true;

    public boolean isActive() {
        return active;
    }

    public void setActive(boolean isActive) {
        this.active = isActive;
    }

}

现在您只需将其添加到您的 JList 中：

list = new JList<Entity>();
list.setModel(new DefaultListModel<Entity>());
list.setCellRenderer(new CheckListRenderer());
list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
list.addMouseListener(new MouseAdapter() {
    @Override
    public void mouseClicked(MouseEvent event) {
        if (event.getX() < 20) { 
            // Quick and dirty: only change the tick if clicked into the leftmost pixels
            @SuppressWarnings("unchecked")
            JList<Entity> list = ((JList<Entity>) event.getSource());
            int index = list.locationToIndex(event.getPoint());// Get index of item clicked
            if (index >= 0) {
                Entity item = (Entity) list.getModel().getElementAt(index);
                item.setActive(!item.isActive()); // Toggle selected state
                list.repaint(list.getCellBounds(index, index));// Repaint cell
            }
        }
    }
});

Answer 8

这是使用复选框制作列表的另一个示例

class JCheckList<T> extends JList<T> {

    protected static Border noFocusBorder = new EmptyBorder(1, 1, 1, 1);

    public void setSelected(int index) {
        if (index != -1) {
            JCheckBox checkbox = (JCheckBox) getModel().getElementAt(index);
            checkbox.setSelected(
                    !checkbox.isSelected());
            repaint();
        }
    }

    protected static class CellListener
            extends DefaultListModel
            implements ListDataListener {

        ListModel ls;

        public CellListener(ListModel ls) {
            ls.addListDataListener(this);
            int i = ls.getSize();
            for (int v = 0; v < i; v++) {
                var r = new JCheckBox();
                r.setText(ls.getElementAt(v).toString());
                this.addElement(r);
            }
            this.ls = ls;
        }

        @Override
        public void intervalAdded(ListDataEvent e) {
            int begin = e.getIndex0();
            int end = e.getIndex1();
            for (; begin <= end; begin++) {
                var r = new JCheckBox();
                r.setText(ls.getElementAt(begin).toString());
                this.add(begin, r);
            }
        }

        @Override
        public void intervalRemoved(ListDataEvent e) {
            int begin = e.getIndex0();
            int end = e.getIndex1();
            for (; begin <= end; end--) {
                this.remove(begin);
            }
        }

        @Override
        public void contentsChanged(ListDataEvent e) {

        }
    }

    public JCheckList() {
        setCellRenderer(new CellRenderer());

        addMouseListener(new MouseAdapter() {
            public void mousePressed(MouseEvent e) {
                int index = locationToIndex(e.getPoint());

                setSelected(index);
            }
        }
        );


    addKeyListener(new KeyListener(){
        @Override
        public void keyTyped(KeyEvent e) {
            
        }

        @Override
        public void keyPressed(KeyEvent e) {
            if (e.getKeyCode() == KeyEvent.VK_SPACE){
                
            int index = JCheckList.this.getSelectedIndex();

            setSelected(index);
            }
        }

        @Override
        public void keyReleased(KeyEvent e) {
            
        }
            
    });

        setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
    }

    @Override
    public void setModel(ListModel<T> d) {
        var r = new CellListener(d);
        d.addListDataListener(r);
        super.setModel(r);
    }

    protected class CellRenderer implements ListCellRenderer {

        public Component getListCellRendererComponent(
                JList list, Object value, int index,
                boolean isSelected, boolean cellHasFocus) {
            JCheckBox checkbox = (JCheckBox) value;
            checkbox.setBackground(isSelected
                    ? getSelectionBackground() : getBackground());
            checkbox.setForeground(isSelected
                    ? getSelectionForeground() : getForeground());
            checkbox.setEnabled(isEnabled());
            checkbox.setFont(getFont());
            checkbox.setFocusPainted(false);
            checkbox.setBorderPainted(true);
            checkbox.setBorder(isSelected
                    ? UIManager.getBorder(
                            "List.focusCellHighlightBorder") : noFocusBorder);
            return checkbox;
        }
    }
}

Answer 9

我可能希望使用 JTable 而不是 JList 并且由于复选框的默认渲染相当难看，我可能希望添加一个自定义 TableModel、CellRenderer 和 CellEditor 来表示布尔值。 当然，我想这已经被做过无数次了。 Sun 有很好的例子。

Answer 10

Java 7 和更新版本的更好解决方案

我偶然发现了这个问题，并意识到一些答案非常旧且过时。 如今，JList 是通用的，因此有更好的解决方案。

我的通用 JCheckBoxList 解决方案：

import java.awt.Component;

import javax.swing.*;
import javax.swing.border.*;

import java.awt.event.*;

@SuppressWarnings("serial")
public class JCheckBoxList extends JList<JCheckBox> {
  protected static Border noFocusBorder = new EmptyBorder(1, 1, 1, 1);

  public JCheckBoxList() {
    setCellRenderer(new CellRenderer());
    setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
    addMouseListener(new MouseAdapter() {
      @Override
      public void mousePressed(MouseEvent e) {
        int index = locationToIndex(e.getPoint());
        if (index != -1) {
          JCheckBox checkbox = getModel().getElementAt(index);
          checkbox.setSelected(!checkbox.isSelected());
          repaint();
        }
      }
    });
  }

  public JCheckBoxList(ListModel<JCheckBox> model){
    this();
    setModel(model);
  }

  protected class CellRenderer implements ListCellRenderer<JCheckBox> {
    public Component getListCellRendererComponent(
        JList<? extends JCheckBox> list, JCheckBox value, int index,
        boolean isSelected, boolean cellHasFocus) {
      JCheckBox checkbox = value;

      // drawing checkbox, change the appearance here
      checkbox.setBackground(isSelected ? getSelectionBackground()
          : getBackground());
      checkbox.setForeground(isSelected ? getSelectionForeground()
          : getForeground());
      checkbox.setEnabled(isEnabled());
      checkbox.setFont(getFont());
      checkbox.setFocusPainted(false);
      checkbox.setBorderPainted(true);
      checkbox.setBorder(isSelected ? UIManager
          .getBorder("List.focusCellHighlightBorder") : noFocusBorder);
      return checkbox;
    }
  }
}

要动态添加 JCheckBox 列表，您需要创建自己的 ListModel 或添加 DefaultListModel。

DefaultListModel<JCheckBox> model = new DefaultListModel<JCheckBox>();
JCheckBoxList checkBoxList = new JCheckBoxList(model);

DefaultListModel 是通用的，因此您可以使用 JAVA 7 API 此处指定的方法像这样：

model.addElement(new JCheckBox("Checkbox1"));
model.addElement(new JCheckBox("Checkbox2"));
model.addElement(new JCheckBox("Checkbox3"));

Answer 11

这里只是 Rawa 对 JCheckBoxList 的一点补充。 这将添加使用空格键进行选择的功能。 如果选择了多个项目，则所有项目都将设置为第一个项目的反转值。

        addKeyListener(new KeyAdapter() {
        @Override
        public void keyPressed(KeyEvent e) {
            int index = getSelectedIndex();
            if (index != -1 && e.getKeyCode() == KeyEvent.VK_SPACE) {
                boolean newVal = !((JCheckBox) (getModel()
                        .getElementAt(index))).isSelected();
                for (int i : getSelectedIndices()) {
                    JCheckBox checkbox = (JCheckBox) getModel()
                            .getElementAt(i);
                    checkbox.setSelected(newVal);
                    repaint();
                }
            }
        }
        });