TableCellRenderer以及如何在不使用JTable.repaint()的情况下刷新单元格背景。

Question

• 能够根据来自外部的值正确地刷新背景，无需强制重绘 table.repaint();

• 基于由kleopatra和Hovercraft Full Of Eels编写的优秀代码进行了测试和使用

• 适用于Java6/7，因为API没有任何更改

我的SSCCE可以通过JTable.repaint()正确重绘。

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.GridLayout;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JComboBox;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.SwingUtilities;
import javax.swing.border.EmptyBorder;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.DefaultTableModel;

public class MyTableAndRenderer {

    private JFrame frame = new JFrame();
    private JPanel panel = new JPanel();
    private String[] items = {"Item 1", "Item 2", "Item 3", "Item 4"};
    private DefaultComboBoxModel comboBoxModel = new DefaultComboBoxModel(items);
    private JComboBox combo = new JComboBox(comboBoxModel);
    private JPanel panel1 = new JPanel();
    private String[] columnNames = {"First Name", "Last Name", "Sport",
        "# of Years", "Vegetarian"};
    private Object[][] data = {
        {"Kathy", "Smith", "Item 1", new Integer(5), (false)},
        {"John", "Doe", "Item 1", new Integer(3), (true)},
        {"Sue", "Black", "Item 3", new Integer(2), (false)},
        {"Jane", "White", "Item 3", new Integer(20), (true)},
        {"Joe", "Brown", "Item 3", new Integer(10), (false)}
    };
    private DefaultTableModel model = new DefaultTableModel(data, columnNames) {
        private static final long serialVersionUID = 1L;

        @Override
        public Class getColumnClass(int column) {
            return getValueAt(0, column).getClass();
        }
    };
    private JTable table = new JTable(model);

    public MyTableAndRenderer() {
        panel.setBorder(new EmptyBorder(10, 0, 2, 0));
        panel.add(combo);
        //@HFOE
        /*table.setDefaultRenderer(Object.class, new DefaultTableCellRenderer() {
            @Override
            public Component getTableCellRendererComponent(JTable table,
                    Object value, boolean isSelected, boolean hasFocus,
                    int row, int column) {
                    super.getTableCellRendererComponent(table, value, isSelected,
                        hasFocus, row, column);
                String str = combo.getSelectedItem().toString();
                if (value.toString().equalsIgnoreCase(str)) {
                    setBackground(Color.RED);
                } else {
                    setBackground(null);
                }
                return this;
            }
        });*/
        //@kleopatra
        /*table.setDefaultRenderer(Object.class, new DefaultTableCellRenderer() {
            @Override
            public Component getTableCellRendererComponent(JTable table,
                    Object value, boolean isSelected, boolean hasFocus,
                    int row, int column) {
                String str = combo.getSelectedItem().toString();
                if (value.toString().equalsIgnoreCase(str)) {
                    setBackground(Color.RED);
                } else {
                    setBackground(null);
                }
                super.getTableCellRendererComponent(table, value, isSelected,
                        hasFocus, row, column);
                return this;
            }
        });*/
        table.setDefaultRenderer(Object.class, new DefaultTableCellRenderer() {
            @Override
            public Component getTableCellRendererComponent(JTable table,
                    Object value, boolean isSelected, boolean hasFocus,
                    int row, int column) {
                super.getTableCellRendererComponent(table, value, isSelected,
                        hasFocus, row, column);
                String str = combo.getSelectedItem().toString();
                if (value.toString().equalsIgnoreCase(str)) {
                    setBackground(Color.RED);
                    table.repaint();
                } else {
                    setBackground(null);
                    table.repaint();
                }
                return this;
            }
        });
        table.getTableHeader().setReorderingAllowed(false);
        table.setAutoCreateRowSorter(true);
        table.setPreferredScrollableViewportSize(table.getPreferredSize());
        panel1.setLayout(new GridLayout(1, 1, 10, 10));
        panel1.add(new JScrollPane(table));
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.add(panel, BorderLayout.NORTH);
        frame.add(panel1);
        frame.pack();
        frame.setVisible(true);
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                MyTableAndRenderer fs = new MyTableAndRenderer();
            }
        });
    }
}

编辑

@Devolus写道，你测试过我发布的代码了吗？我从我的工作代码中提取了这个片段，我只是删除了其中不相关的部分。我在这里使用Java 6，这对我有效。

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

    Component cell = super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);

    ... determine the color value ...

    cell.setBackground(back);
    cell.setForeground(fore);
}

• 导致

• 无论是Java6/7都没关系

来自代码（发布SSCCE的原因）

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.GridLayout;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JComboBox;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.SwingUtilities;
import javax.swing.border.EmptyBorder;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.DefaultTableModel;

public class MyTableAndRenderer {

    private JFrame frame = new JFrame();
    private JPanel panel = new JPanel();
    private String[] items = {"Item 1", "Item 2", "Item 3", "Item 4"};
    private DefaultComboBoxModel comboBoxModel = new DefaultComboBoxModel(items);
    private JComboBox combo = new JComboBox(comboBoxModel);
    private JPanel panel1 = new JPanel();
    private String[] columnNames = {"First Name", "Last Name", "Sport",
        "# of Years", "Vegetarian"};
    private Object[][] data = {
        {"Kathy", "Smith", "Item 1", new Integer(5), (false)},
        {"John", "Doe", "Item 1", new Integer(3), (true)},
        {"Sue", "Black", "Item 3", new Integer(2), (false)},
        {"Jane", "White", "Item 3", new Integer(20), (true)},
        {"Joe", "Brown", "Item 3", new Integer(10), (false)}
    };
    private DefaultTableModel model = new DefaultTableModel(data, columnNames) {
        private static final long serialVersionUID = 1L;

        @Override
        public Class getColumnClass(int column) {
            return getValueAt(0, column).getClass();
        }
    };
    private JTable table = new JTable(model);

    public MyTableAndRenderer() {
        panel.setBorder(new EmptyBorder(10, 0, 2, 0));
        panel.add(combo);
        table.setDefaultRenderer(Object.class, new DefaultTableCellRenderer() {
            @Override
            public Component getTableCellRendererComponent(JTable table,
                    Object value, boolean isSelected, boolean hasFocus,
                    int row, int column) {
                Component c = super.getTableCellRendererComponent(table, value, isSelected,
                        hasFocus, row, column);
                String str = combo.getSelectedItem().toString();
                if (value.toString().equalsIgnoreCase(str)) {
                    c.setBackground(Color.RED);
                } else {
                    c.setBackground(null);
                }
                return this;
            }
        });
        table.getTableHeader().setReorderingAllowed(false);
        table.setAutoCreateRowSorter(true);
        table.setPreferredScrollableViewportSize(table.getPreferredSize());
        panel1.setLayout(new GridLayout(1, 1, 10, 10));
        panel1.add(new JScrollPane(table));
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.add(panel, BorderLayout.NORTH);
        frame.add(panel1);
        frame.pack();
        frame.setVisible(true);
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                MyTableAndRenderer fs = new MyTableAndRenderer();
            }
        });
    }
}

编辑2

• 如果使用WinXp（所有的Win操作系统都不要使用Nimbus，渲染器非常有趣，从未见过，太棒了！这怎么可能）

编辑3：

注意，我已经尽可能简化了代码，在我的问题这里测试过，将Rendering Component转换为JComponent/JLabel也不起作用（使用JLabel.repaint()/setOpaque()）

- mKorbel

---

我们也遇到了JTable的问题，导致渲染器不能正确地绘制其内容。然后我们决定使用JXTable，它提供了使用Highlighters来突出显示单元格的概念。Highlighters。 - crusam

@ymene 是的，我同意使用SwingX（有偏见的我 :-) ）。两个小事情：a）你的参考资料已经过时了（自0.8版本以来，Highlighter API发生了许多变化），不幸的是当前的javadoc（1.6.5-1版本）不容易获得，只能通过从maven下载文档获得；b）在内部，当高亮显示器的装饰发生变化时，它会触发一个changeEvent，进而触发表格重新绘制自己 :) - kleopatra

只是强调一下你所学到的内容，并为未来的读者提供参考：初始的SSCCE做得非常错误 - 即在绘制周期中永远不要重新触发绘制，因此永远不要在getXXCellRenderer中调用repaint。 - kleopatra

Answer 1

问题发生在您更改所选项时。 您的组合框和表格之间存在一些隐式交互（组合框的选定项影响表格的绘制方式）。

当组合框弹出窗口隐藏时，它会自动触发悬停区域的重新绘制（RepaintManager仅重新绘制悬停区域，而不是整个表格）。但与此同时，您已更改了表格单元格的绘制方式（因为不再匹配选择，因此不再将第一个单元格绘制为红色）。然而，重绘管理器只强制重新绘制表格的一个小区域，无法完全覆盖红色单元格，因此您会看到这些视觉故障。

以下是我能想到的两个解决方案：

1. 向组合框添加ActionListener并调用table.repaint()（易于实现）

2. 更改您的表格模型，并为相关单元格调用fireTableCellUpdated(row, column)。

第二种解决方案的SSCCE：

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.List;

import javax.swing.DefaultComboBoxModel;
import javax.swing.JComboBox;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.SwingUtilities;
import javax.swing.border.EmptyBorder;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.DefaultTableModel;

public class MyTableAndRenderer {

    private final class DefaultTableModelExtension extends DefaultTableModel {
        private static final long serialVersionUID = 1L;

        private String selected;

        private DefaultTableModelExtension(Object[][] data, Object[] columnNames) {
            super(data, columnNames);
        }

        @Override
        public Class getColumnClass(int column) {
            return getValueAt(0, column).getClass();
        }

        public String getSelected() {
            return selected;
        }

        public void setSelected(String selected) {
            if (this.selected == null && selected == null || this.selected != null && this.selected.equalsIgnoreCase(selected)) {
                return;
            }
            class Cell {
                public final int row;
                public final int column;

                public Cell(int row, int column) {
                    super();
                    this.row = row;
                    this.column = column;
                }
            }
            List<Cell> updatedCells = new ArrayList<Cell>();
            if (this.selected != null) {
                for (int i = 0; i < data.length; i++) {
                    Object[] o = data[i];
                    for (int j = 0; j < o.length; j++) {
                        Object object = o[j];
                        if (this.selected.toString().equalsIgnoreCase(object.toString())) {
                            updatedCells.add(new Cell(i, j));
                        }
                    }
                }
            }
            this.selected = selected;
            if (this.selected != null) {
                for (int i = 0; i < data.length; i++) {
                    Object[] o = data[i];
                    for (int j = 0; j < o.length; j++) {
                        Object object = o[j];
                        if (this.selected.toString().equalsIgnoreCase(object.toString())) {
                            updatedCells.add(new Cell(i, j));
                        }
                    }
                }
            }
            for (Cell pair : updatedCells) {
                fireTableCellUpdated(pair.row, pair.column);
            }
        }
    }

    private JFrame frame = new JFrame();
    private JPanel panel = new JPanel();
    private String[] items = { "Item 1", "Item 2", "Item 3", "Item 4" };
    private DefaultComboBoxModel comboBoxModel = new DefaultComboBoxModel(items);
    private JComboBox combo = new JComboBox(comboBoxModel);
    private JPanel panel1 = new JPanel();
    private String[] columnNames = { "First Name", "Last Name", "Sport", "# of Years", "Vegetarian" };
    private Object[][] data = { { "Kathy", "Smith", "Item 1", new Integer(5), false }, { "John", "Doe", "Item 1", new Integer(3), true },
            { "Sue", "Black", "Item 3", new Integer(2), false }, { "Jane", "White", "Item 3", new Integer(20), true },
            { "Joe", "Brown", "Item 3", new Integer(10), false } };
    private DefaultTableModelExtension model = new DefaultTableModelExtension(data, columnNames);
    private JTable table = new JTable(model);

    public MyTableAndRenderer() {
        panel.setBorder(new EmptyBorder(10, 0, 2, 0));
        panel.add(combo);
        combo.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(ActionEvent e) {
                updateSelected();
            }

        });
        // Need first synch
        updateSelected();
        table.setDefaultRenderer(Object.class, new DefaultTableCellRenderer() {
            @Override
            public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row,
                    int column) {
                Component c = super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
                String str = combo.getSelectedItem().toString();
                if (value.toString().equalsIgnoreCase(str)) {
                    c.setBackground(Color.RED);
                } else {
                    c.setBackground(null);
                }
                return this;
            }
        });
        table.getTableHeader().setReorderingAllowed(false);
        table.setAutoCreateRowSorter(true);
        table.setPreferredScrollableViewportSize(table.getPreferredSize());
        panel1.setLayout(new GridLayout(1, 1, 10, 10));
        panel1.add(new JScrollPane(table));
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.add(panel, BorderLayout.NORTH);
        frame.add(panel1);
        frame.pack();
        frame.setVisible(true);
    }

    private void updateSelected() {
        model.setSelected((String) combo.getSelectedItem());
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                MyTableAndRenderer fs = new MyTableAndRenderer();
            }
        });
    }
}

- Guillaume Polet

---

+1 欢迎，关于 Listener 中重绘仅一次的正确捕获，但问题的原因是没有 JTable.repaint，顺便说一下，如果不需要 fireTableCellUpdated 来刷新自定义编辑器和渲染器，那么这个问题也不用考虑了。我看到 Camickr 和 Kleopatra 也注意到过这个问题。 - mKorbel

@mKorbel，当下拉框弹出窗口被隐藏时触发的重绘将调用具有剪裁 Graphics 的 paint 方法，它不会覆盖完整单元格（仅重新绘制表格的子区域）。问题在于，表格的 "绘制状态" 也发生了变化（自定义渲染器无法以相同的方式绘制单元格）。 - Guillaume Polet

对于选项二加一；Color.RED是视图属性，但是确定要着色的单元格是模型的一部分。 - trashgod

@Guillaume Polet，现在我明白了，已接受...感谢你基于你的真实知识给出的通知，就像你这样的疯子。 - mKorbel

+1，很好的追踪和解释 - 尽管我略微不同意@trashgod：状态影响视觉外观并不一定直接固有于模型本身（例如，在不同表格中突出显示相同模型的不同方面）。 - kleopatra

@kleopatra：我的措辞不太好，我想表达的是颜色有时可以是模型的属性，例如交通信号灯或状态指示器。 - trashgod

Answer 2

为了解决您的特定问题，您可以像下面这样添加table.repaint()。

然而，为了正确地重绘表格，您应该从外部刷新它。在这个例子中，您应该在组合框上添加一个事件监听器，然后从那里刷新它。

public Component getTableCellRendererComponent(JTable table,
        Object value,
        boolean isSelected,
        boolean hasFocus, 
        int row, int column) 
{
    Component cell = super.getTableCellRendererComponent(table, value, isSelected,
            hasFocus, row, column);
    String str = combo.getSelectedItem().toString();
    if (value.toString().equalsIgnoreCase(str))
    {
        cell.setBackground(Color.RED);
    }
    else
    {
        cell.setBackground(null);
    }

    return cell;
}

- Devolus

---

你测试了我发布的代码吗？我从自己的工作代码中提取了这个片段，只是删除了中间的内容，因为它对答案不相关。我在这里使用的是Java 6，这对我有效。 - Devolus

是的，我刚刚测试了你的示例，看到了问题所在，但不知道为什么。 - Devolus

强制在渲染器中重绘，对我来说似乎不是一个好主意。我可以确认这甚至是一个非常糟糕的主意。这将创建一个无限的绘画循环。你永远不应该使用它。 - Guillaume Polet

只是为了让你知道这有多糟糕：在 getTableCellRendererComponent 中加入一个日志输出（比如 System.out.println("painting");）。你会看到它被不断调用。 - Guillaume Polet

作为一种激励，将重新绘制功能从渲染器代码中移除 :-) 这真的很糟糕，就像@GuillaumePolet已经提到的那样... - kleopatra