TableColumn.setHeaderRenderer与JTableHeader.setDefaultRenderer渲染差异咨询

问题描述 #

我在开发多行表头解决方案时，发现JTableHeader存在异常渲染行为：使用同一个自定义渲染器，通过TableColumn.setHeaderRenderer和JTableHeader.setDefaultRenderer设置后，输出效果完全不同——只有用TableColumn.setHeaderRenderer时能得到预期的多行换行效果，且已确认两种场景下渲染器均被调用。请问这两种方式为什么会有差异？是不是应该优先用TableColumn.setHeaderRenderer？我哪里考虑漏了？

运行以下代码时，传入任意参数可查看TableColumn.setHeaderRenderer的输出效果，无参数则使用JTableHeader.setDefaultRenderer：

import javax.swing.*;
import javax.swing.table.DefaultTableModel;
import javax.swing.table.TableCellRenderer;
import java.awt.*;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;

public class MultiLineHeaderExample extends JFrame
{
    public MultiLineHeaderExample( boolean addRendererToTableColumn )
    {
        super( "Multi-Line Header Example" );

        DefaultTableModel dm = new DefaultTableModel();
        dm.setDataVector( new Object[][] 
                {
                    {
                        "a", "b", "c"
                    },
                    {
                        "A", "B", "C"
                    }
                },
            new Object[] 
                {
                    "short col", "My First Column, Very Long But Space Separated", "VeryLongNoSpaceSoShouldSomeHowWrap"
                } );

        JTable table = new JTable( dm );
        MultiLineTableHeaderRenderer renderer = new MultiLineTableHeaderRenderer();

        if( addRendererToTableColumn )
        {//if renderer is set on each column, desired rendering is observed
            table.getColumnModel().getColumns().asIterator().forEachRemaining( column -> column.setHeaderRenderer( renderer ) );
        }
        else
        {
            //if set as default renderer for header, incorrect rendering is observed
            table.getTableHeader().setDefaultRenderer( renderer );
        }

        JScrollPane scroll = new JScrollPane( table );
        getContentPane().add( scroll );
        setSize( 400, 110 );
        setVisible( true );
    }


    public static final class MultiLineTableHeaderRenderer extends JTextArea implements TableCellRenderer
    {
        public MultiLineTableHeaderRenderer()
        {
            setEditable( false );
            setLineWrap( true );
            setOpaque( false );
            setFocusable( false );
            setWrapStyleWord( true );
            LookAndFeel.installBorder( this, "TableHeader.cellBorder" );
        }

        @Override
        public Component getTableCellRendererComponent( JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column )
        {
            int width = table.getColumnModel().getColumn( column ).getWidth();
            setText( ( String ) value );
            setSize( width, getPreferredSize().height );
            return this;
        }
    }


    public static void main( String[] args )
    {
        SwingUtilities.invokeLater( () ->
        {
            MultiLineHeaderExample frame = new MultiLineHeaderExample( args.length > 0 );
            frame.addWindowListener( new WindowAdapter()
            {
                public void windowClosing( WindowEvent e )
                {
                    System.exit( 0 );
                }
            } );
        } );
    }
}

差异原因 #

1. JTableHeader的默认渲染器包装机制 #

JTableHeader在使用setDefaultRenderer时，会自动将自定义渲染器包装进TableCellRendererWrapper类中。这个包装类会覆盖你在渲染器里设置的组件尺寸，导致getTableCellRendererComponent中的setSize(width, getPreferredSize().height)代码失效。而直接给TableColumn设置渲染器时，不会经过这个包装流程，你的尺寸设置能正常生效，文本也就可以按列宽换行。

2. 表头高度计算逻辑不同 #

当使用默认渲染器时，JTableHeader计算表头高度的逻辑依赖于包装后渲染器返回的首选尺寸，但这个尺寸并没有正确反映文本换行后的实际高度。而给每个列单独设置渲染器时，表头会直接读取每个列渲染器的真实尺寸，从而计算出合适的表头高度，确保多行文本完整显示。

解决方案与最佳实践 #

• 优先选择TableColumn.setHeaderRenderer：这种方式能绕过JTableHeader的包装逻辑，直接让自定义渲染器的设置生效，是实现多行表头最可靠的方式。
• 若要使用默认渲染器，需修改渲染器实现：
  调整getTableCellRendererComponent方法，先设置文本和宽度，再让组件自动计算合适的高度：

  @Override
  public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
      setText((String) value);
      int width = table.getColumnModel().getColumn(column).getWidth();
      setSize(width, Short.MAX_VALUE); // 设置足够大的高度，让文本自动换行
      return this;
  }
  

  同时确保渲染器的getPreferredSize返回正确的换行后尺寸：

  @Override
  public Dimension getPreferredSize() {
      return super.getPreferredSize();
  }
  

结论 #

两种设置方式的核心差异在于JTableHeader对默认渲染器的自动包装机制，这会干扰自定义渲染器的尺寸控制。优先使用TableColumn.setHeaderRenderer能避免这类问题，确保渲染效果符合预期。

内容的提问来源于stack exchange，提问作者colomb