如何在JTable的JTableHeader中添加控件?

36

给定一个带有Boolean.class类型列的JTable默认渲染器JCheckBox。根据用户选择选择单个单元格很容易,但也可能方便地选择所有或没有复选框。这些recent examples提到在表头中使用JCheckBox,但实现起来很笨拙且不吸引人。如果我不需要对该列进行排序,我如何在JTableHeader中放置一个行为良好的控件?

附加说明:为了方便起见,我已将我的sscce添加为answer,但我很乐意接受解决问题的良好行为方面的答案。


嗯...问题是什么,特别是你所说的良好行为是什么意思呢?我们都知道标题中没有对“实时”组件的支持,所有需要自己完成 :-) 至于使用切换按钮,不知道用户是否理解它的作用以及何时使用 - 不小心点击单元格将会丢失该列中的所有当前数据。 - kleopatra
@kleopatra:很好的观点;我推断首先应该质疑是否需要这样的设备。 - trashgod
3个回答

25

这篇文章 如何使用表格:使用自定义渲染器TableSorter 为例,展示了如何在列标题上检测鼠标事件。在下面的示例中,使用类似的方法,SelectAllHeader extends JToggleButton 并实现了 TableCellRenderer 以达到类似的效果。当所有复选框处于统一状态时,使用 TableModelListener 条件化切换按钮。

enter image description here

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.TableModelEvent;
import javax.swing.event.TableModelListener;
import javax.swing.table.*;

/**
 * @see https://dev59.com/Y2w05IYBdhLWcg3wnjAk
 * @see http://stackoverflow.com/questions/7092219
 * @see http://stackoverflow.com/questions/7093213
 */
public class SelectAllHeaderTest {

    private static final int BOOLEAN_COL = 2;
    private static final Object colNames[] = {"Column 1", "Column 2", ""};
    private DefaultTableModel model = new DefaultTableModel(null, colNames) {

        @Override
        public Class<?> getColumnClass(int columnIndex) {
            if (columnIndex == BOOLEAN_COL) {
                return Boolean.class;
            } else {
                return String.class;
            }
        }
    };
    private JTable table = new JTable(model);

    public void create() {
        for (int x = 1; x < 6; x++) {
            model.addRow(new Object[]{
                    "Row " + x + ", Col 1", "Row " + x + ", Col 2", false
                });
        }
        table.setAutoCreateRowSorter(true);
        table.setPreferredScrollableViewportSize(new Dimension(320, 160));
        TableColumn tc = table.getColumnModel().getColumn(BOOLEAN_COL);
        tc.setHeaderRenderer(new SelectAllHeader(table, BOOLEAN_COL));
        JFrame f = new JFrame();
        f.add(new JScrollPane(table));
        f.pack();
        f.setLocationRelativeTo(null);
        f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        f.setVisible(true);
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(new Runnable() {

            @Override
            public void run() {
                new SelectAllHeaderTest().create();
            }
        });
    }
}

/**
 * A TableCellRenderer that selects all or none of a Boolean column.
 * 
 * @param targetColumn the Boolean column to manage
 */
class SelectAllHeader extends JToggleButton implements TableCellRenderer {

    private static final String ALL = "✓ Select all";
    private static final String NONE = "✓ Select none";
    private JTable table;
    private TableModel tableModel;
    private JTableHeader header;
    private TableColumnModel tcm;
    private int targetColumn;
    private int viewColumn;

    public SelectAllHeader(JTable table, int targetColumn) {
        super(ALL);
        this.table = table;
        this.tableModel = table.getModel();
        if (tableModel.getColumnClass(targetColumn) != Boolean.class) {
            throw new IllegalArgumentException("Boolean column required.");
        }
        this.targetColumn = targetColumn;
        this.header = table.getTableHeader();
        this.tcm = table.getColumnModel();
        this.applyUI();
        this.addItemListener(new ItemHandler());
        header.addMouseListener(new MouseHandler());
        tableModel.addTableModelListener(new ModelHandler());
    }

    @Override
    public Component getTableCellRendererComponent(
        JTable table, Object value, boolean isSelected,
        boolean hasFocus, int row, int column) {
        return this;
    }

    private class ItemHandler implements ItemListener {

        @Override
        public void itemStateChanged(ItemEvent e) {
            boolean state = e.getStateChange() == ItemEvent.SELECTED;
            setText((state) ? NONE : ALL);
            for (int r = 0; r < table.getRowCount(); r++) {
                table.setValueAt(state, r, viewColumn);
            }
        }
    }

    @Override
    public void updateUI() {
        super.updateUI();
        applyUI();
    }

    private void applyUI() {
        this.setFont(UIManager.getFont("TableHeader.font"));
        this.setBorder(UIManager.getBorder("TableHeader.cellBorder"));
        this.setBackground(UIManager.getColor("TableHeader.background"));
        this.setForeground(UIManager.getColor("TableHeader.foreground"));
    }

    private class MouseHandler extends MouseAdapter {

        @Override
        public void mouseClicked(MouseEvent e) {
            viewColumn = header.columnAtPoint(e.getPoint());
            int modelColumn = tcm.getColumn(viewColumn).getModelIndex();
            if (modelColumn == targetColumn) {
                doClick();
            }
        }
    }

    private class ModelHandler implements TableModelListener {

        @Override
        public void tableChanged(TableModelEvent e) {
            if (needsToggle()) {
                doClick();
                header.repaint();
            }
        }
    }

    // Return true if this toggle needs to match the model.
    private boolean needsToggle() {
        boolean allTrue = true;
        boolean allFalse = true;
        for (int r = 0; r < tableModel.getRowCount(); r++) {
            boolean b = (Boolean) tableModel.getValueAt(r, targetColumn);
            allTrue &= b;
            allFalse &= !b;
        }
        return allTrue && !isSelected() || allFalse && isSelected();
    }
}

1
a) 在金属上吹气 b) 不应在调整大小区域点击时进行选择/取消选择 - kleopatra
@kleopatra:这就是我想知道的事情;请考虑将其作为答案。经过进一步测试,Metal似乎拒绝了被回收的箭头;我应该自己制作。 - trashgod
如果您插入新行,触发事件fireTableRowsInserted,它将抛出itemStateChanged的无效范围错误异常,有人遇到过这种情况吗?因此,table.getRowCount()不正确,因为表格没有渲染。 - Alter Hu
@Alter.hu:DefaultTableModel 会为您触发事件;如果您有问题,请参见 [ask]。 - trashgod
@trashgod,是的,你说得对,但问题在于SelectAllHeader类将导致检查每一列数据。请看下面我更新这个类的详细注释。 - Alter Hu
@trashgod,抱歉,这是我的错,我在这里使用“AbstractTableModel”类来自定义表格模型,所以遇到了这个异常。但对于DefaultTableModel来说没问题。谢谢。 - Alter Hu

15

这个问题有两个方面(依我看来):

可用性:发明UI交互/元素容易使用户感到困惑。以下是没有特定顺序的问题:

  • 列标题的目的是描述列的内容,在用动作描述替换它时,该内容描述会丢失
  • 对于我这种地球上最愚蠢的用户来说,不立即清楚头部单元格具有切换按钮的功能。意外点击它将丢失该列中先前的所有内容状态

因此,即使交互分析得出了我们确实需要/想要它,也应该:

  • 仅在内容之外执行操作
  • 使用更清晰的小部件(例如三态复选框——全部选择/取消选择、混合内容)。同时,必须可以从混合内容进行选择和取消选择。再想一想,复选框可能也不是最佳选择,未进一步调查。
  • 尽量减少意外(仅对我而言 :-))改变整个状态的可能性(例如通过清晰的视觉分离活动区域——复选框图标——与“正常标题”区域分开)。

技术方面

  • TableHeader并不适用于“实时”组件。无论想要什么,都必须由我们自己控制
  • 有例子可供参考(例如JIDE网格支持添加组件)
  • 在不轻易改变呈现器的情况下保持外观和感觉始终如一,调整标题会让它看起来不太吸引人

13

enter image description here

使用自定义的TableCellRenderer:

    // column 1
    col = table.getColumnModel().getColumn(1);
    col.setHeaderRenderer(new EditableHeaderRenderer( new JButton("Button")));
    // column 2     
    col = table.getColumnModel().getColumn(2);
    col.setHeaderRenderer(new EditableHeaderRenderer( new JToggleButton("Toggle")));
    // column 3
    col = table.getColumnModel().getColumn(3);
    col.setHeaderRenderer(new EditableHeaderRenderer( new JCheckBox("CheckBox")));



class EditableHeaderRenderer implements TableCellRenderer {

    private JTable table = null;
    private MouseEventReposter reporter = null;
    private JComponent editor;

    EditableHeaderRenderer(JComponent editor) {
        this.editor = editor;
        this.editor.setBorder(UIManager.getBorder("TableHeader.cellBorder"));
    }

    @Override
    public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int col) {
        if (table != null && this.table != table) {
            this.table = table;
            final JTableHeader header = table.getTableHeader();   
            if (header != null) {   
                this.editor.setForeground(header.getForeground());   
                this.editor.setBackground(header.getBackground());   
                this.editor.setFont(header.getFont());
                reporter = new MouseEventReposter(header, col, this.editor);
                header.addMouseListener(reporter);
            }
        }

        if (reporter != null) reporter.setColumn(col);

        return this.editor;
    }

    static public class MouseEventReposter extends MouseAdapter {

        private Component dispatchComponent;
        private JTableHeader header;
        private int column  = -1;
        private Component editor;

        public MouseEventReposter(JTableHeader header, int column, Component editor) {
            this.header = header;
            this.column = column;
            this.editor = editor;
        }

        public void setColumn(int column) {
            this.column = column;
        }

        private void setDispatchComponent(MouseEvent e) {
            int col = header.getTable().columnAtPoint(e.getPoint());
            if (col != column || col == -1) return;

            Point p = e.getPoint();
            Point p2 = SwingUtilities.convertPoint(header, p, editor);
            dispatchComponent = SwingUtilities.getDeepestComponentAt(editor, p2.x, p2.y);
        }

        private boolean repostEvent(MouseEvent e) {
            if (dispatchComponent == null) {
                return false;
            }
            MouseEvent e2 = SwingUtilities.convertMouseEvent(header, e, dispatchComponent);
            dispatchComponent.dispatchEvent(e2);
            return true;
        }

        @Override
        public void mousePressed(MouseEvent e) {
            if (header.getResizingColumn() == null) {
                Point p = e.getPoint();

                int col = header.getTable().columnAtPoint(p);
                if (col != column || col == -1) return;

                int index = header.getColumnModel().getColumnIndexAtX(p.x);
                if (index == -1) return;

                editor.setBounds(header.getHeaderRect(index));
                header.add(editor);
                editor.validate();
                setDispatchComponent(e);
                repostEvent(e);
            }
        }

        @Override
        public void mouseReleased(MouseEvent e) {
            repostEvent(e);
            dispatchComponent = null;
            header.remove(editor);
        }
    }
}
请注意,带有弹出菜单(例如JComboBox或JMenu)的组件效果不好。请参见:JComboBox在JTable TableHeader中无法扩展)。 但是您可以在TableHeader中使用MenuButton

enter image description here

class MenuButtonTableHeaderRenderer extends JPanel implements TableCellRenderer {

    private int     column  = -1;
    private JTable  table   = null;
    private MenuButton b;

    MenuButtonTableHeaderRenderer(String name, JPopupMenu menu) {
        super(new BorderLayout());
        b = new MenuButton(ResourceManager.ARROW_BOTTOM, menu);
        b.setBorder(BorderFactory.createEmptyBorder(1,1,1,1));
        JLabel l = new JLabel(name);
        l.setFont(l.getFont().deriveFont(Font.PLAIN));
        l.setBorder(BorderFactory.createEmptyBorder(1,5,1,1));
        add(b, BorderLayout.WEST);
        add(l, BorderLayout.CENTER);
        setBorder(UIManager.getBorder("TableHeader.cellBorder"));
    }

    @Override
    public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int col) {

        if (table != null && this.table != table) {
            this.table = table;
            final JTableHeader header = table.getTableHeader();   
            if (header != null) {   
                setForeground(header.getForeground());   
                setBackground(header.getBackground());   
                setFont(header.getFont());

                header.addMouseListener(new MouseAdapter() {

                    @Override
                    public void  mouseClicked(MouseEvent e) {
                        int col = header.getTable().columnAtPoint(e.getPoint());
                        if (col != column || col == -1) return;

                        int index = header.getColumnModel().getColumnIndexAtX(e.getPoint().x);
                        if (index == -1) return;

                        setBounds(header.getHeaderRect(index));
                        header.add(MenuButtonTableHeaderRenderer.this);
                        validate();

                        b.doClick();

                        header.remove(MenuButtonTableHeaderRenderer.this);

                        header.repaint();   
                    }
                });
            }
        }
        column = col;
        return this;
    }
}

在哪里可以监听上面的JButton和JToggleButton的动作?作为第二个问题,为什么在鼠标释放后移除编辑器?这会导致在单击事件后编辑器消失。 - The_Cute_Hedgehog
这个 "ResourceManager.ARROW_BOTTOM" 的东西出错了,我该如何找到 ResourceManager 类?在哪个 jar 包里?@luca - JAVA
那是我用于图标的自定义类。您可以传递自己的图标。 - luca

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接