Swing框架之Renderer

Swing组件根据其所操作的数据类型分为两种，一种是标量数据类型的组件，一类是复合数据类型的组件。标量数据类型的组件操作的是基本类型的数据，如字符串、布尔、数字等，此类型组件包括JTextField、JCheckBox、JLabel、JButton等。复合数据类型的组件操作的是诸如向量、矩形和非线形等类型的数据。向量数据类型的组件有JComboBox、JList，矩形数据类型的组件有JTable，非线形数据类型的组件如JTree。

       为更形象地展现各种类型的数据，复合数据类型的组件往往采用标量数据类型组件来表现每种数据元素。比如JTable的某一列数据是字符串类型，那么该列的单元格往往用JLabel方式展现每个字符串；如果一列数据是布尔类型，那么该列的单元格往往用JCheckBox方式展现每个布尔值。

       如何实现复合数据类型的组件的渲染呢？最直接的是在paint方法中一个一个地根据数据类型画出每一个组件，但这种方法很显然代码复用率很低，大量重复了相应标量型组件的代码，代码的维护和同步会非常困难，也不容易实现皮肤切换。

       为解决此问题，Swing体系中提出了所谓渲染器(Renderer)的概念，其核心思想是使用接口，封装和复用已有标量型组件的渲染代码，降低代码重复率，提高组件的可扩展性。

       渲染器是如何工作的呢？我们以JTable的渲染代码来演示渲染器的工作原理。下面代码是从JTable的UI类javax.swing.plaf.basic.BasicTableUI中摘出的部分代码(JDK6)：

       paintCells实现所有单元格的渲染过程：

        渲染单元格的方法paintCell的实现：

       如何使用渲染器返回的组件渲染当前的单元格呢？JTable在自己内部隐藏了一个所谓的CellRendererPane组件，该组件是一个“零实现”的容器组件。虽然被添加到JTable上，但它是不可见的，其paint和update方法都为空，仅仅作为临时容纳渲染组件的容器，目的是将渲染组件粘合到JTable组件树上，使得渲染组件有效化，以便使它们达到渲染前的正确状态。下面代码演示了CellRendererPane的概要结构：

       渲染器的核心思想都体现在上面红色代码标注的部分。将JTable的图形对象传递给组件的paint的方法，产生的结果是将组件画到了JTable上。其实Swing打印的原理也大抵如此，只不过这儿的图形对象变成了打印机的图形对象。虽然大部分Swing组件都专门对打印进行了专门的处理（主要是因为有一些图形元素不希望被打印的，比如填充的内容往往不希望打印，可能是太耗墨了），但基本过程是一样的。

       渲染器的思想很像是摄像机、镜子等成像原理。作个比喻，如果你想获取某人的图像，一种方法是将此人一点点用笔画出来。另种方法是通过光线将此人照到镜子里或用照相机拍摄下来。其好处是不管是什么物体，都可以映射出来，具有很强的可扩展性。比如JTable中，表格中不仅可以使用JLabel、JCheckBox、JComboBox等简单组件作为渲染器，而且可以使用其它任何的Swing组件进行渲染，包括复杂的组件JTable（比如实现表格套表的风格）、自定义的组件（比如嵌入图片）。渲染器方法带来的好处不仅仅是组件代码的复用，更带来了无限的可扩展性！

       渲染器思想在Swing中有着广泛的应用。除利用它们实现JTable、JList、JTree和JComboBox等标准组件，还可以实现界面设计工具中属性页、类似UML设计图、类似于MSExcel风格的电子表格等更为复杂的界面组件，甚至IDE中常见的界面设计工具也是利用了渲染器的思想，它把整个组件树当作一个大渲染器，渲染出当前图形用户界面的设计效果。

       渲染器是Swing展现复杂数据结构的利器。但是Swing组件不仅仅被用作展现数据，通常还是编辑数据的地方。实际上纯粹展现数据的Swing组件很少，标准组件中也许只有JLabel。复合数据类型的组件往往使用渲染器原理实现组件的渲染，使用所谓in-placeeditor实现组件的编辑。渲染器Renderer和Editor的结合赋予了Swing强大的灵活性，JTable、等组件这两种原理结合的代表。

Swing的API具有很强的灵活性和可扩展性，比如标准复合数据型组件一般不需要进行渲染器扩展，就可以实现许多应用，但是当遇到需要自定义扩展的需求时，Swing的高度抽象灵活的MVC框架也可以优雅从容的完成。Swing的这一特色典型的体现在其渲染器扩展思想上。那么如何使用渲染器呢？如何自定义渲染器来扩展组件呢？如何将渲染器思想应用到自定义组件上呢？

  复合数据类型的组件如JTable、JTree、JList以及JComboBox都定义适合自己类型的渲染器接口，它们与渲染器接口之间的映射关系如下表所示：

  TableCellRenderer接口定义了JTable渲染器接口：

public interface TableCellRenderer{
/*返回渲染表格的组件，使用该方法在渲染之前配置渲染器。
 *参数table：请求渲染器渲染的表，可以为空。
 *参数value：要渲染的单元格的值，由渲染器来决定如何解释和渲染该值。比如如果value的值为字符串“true”，渲染器可以渲染成字符串，也可以渲染成一个checkbox。该值可以为空。
 *参数isSelected：当前表格是否被选中，渲染器应据此决定是否应该高亮显示。
 *参数hasFocus：当前表格是否拥有焦点，渲染器应据此进行特殊渲染，比如画一个虚线框。
 *参数row：当前表格的行号。如果渲染的是表头，该值为－1。
 *参数column：当前表格的列号。
 */
    ComponentgetTableCellRendererComponent(JTable table, Object value,
        boolean isSelected, boolean hasFocus,
        int row, int column);
}

  TreeCellRenderer定义了JTree的渲染器接口。

   

 在CSDN上有人问如何实现表套表，实际如果清楚了渲染器的工作原理可以很容易实现这个功能，下面是一个很短的代码，它实现了在表的2,3表格中插入一表：

public class TableOfTable extendsJTable{
   public TableOfTable() {
       //添加一个缺省model，实际中可以根据自己需求定制。
       setModel(new DefaultTableModel(...... ));
       //将第二行高度设置宽一些，使嵌入的表格显示起来好看些。
       setRowHeight(1,super.getRowHeight()*4);
   }
   //重载getCellRenderer提供自己的TableCellRenderer
   public TableCellRenderer getCellRenderer(int row, int column){
       if(row == 1 &&column==2){//在第二行、第三列提供一个子表的渲染器
           return new TableCellRenderer(){
               //子表，可以自己定制子表的内容。
               JTable subTable=new JTable(newDefaultTableModel(......));
               //实现TableCellRenderer的方法，提供该子表作为渲染器
               public Component getTableCellRendererComponent(JTable table, Objectvalue, boolean isSelected, boolean hasFocus, int row, int column){
                   return subTable;
               }
           };
       }else//如果是其他地方的表格，沿用父类中提供的渲染器
           return super.getCellRenderer(row, column);
   }
}

  短短几行代码就可以实现如下图所示的界面：

   

  当然你可以根据需求具体定制更为复杂表格的实现，但大体原理就是这样的。

  Jtable、JList、JTree以及JComboBox可以接受的渲染组件不仅仅可以是标准组件，也可以是自定义的组件。比如想实现如下所示的颜色选择器：

   

  图中的渲染器可以从基本的BasicComboBoxRenderer继承，它实际上是继承JLabel的一个类，你可以设置该JLabel的图标，让它显示当前的颜色。为了提供这样一个显示颜色的图标，可以实现这样一个ColorIcon：

public class ColorIcon implementsIcon{

前面文章提到过，许多复合数据型组件不仅仅需要展现数据，还需要编辑数据。比如JTable的某些单元格可能需要编辑，JComboBox除了选择外还可以直接编辑数据，有些JTree有时也需要直接编辑节点。Swing中解决此类问题的方案叫做所谓的in-placeeditor。Swing综合in-placeeditor和Renderer原理赋予了Swing扩展复杂组件功能的能力。注意in-placeeditor其实只是普通的Swing组件，并不是新的Swing元素，它们往往结合Renderer完成组件的扩展，所以我把它们和Renderer放在一起讲了。

  Swing可以使用In-placeeditor的两个前提条件是：

1. Swing组件需要能脱离容器组件独立存在；
2. Swing组件树能在运行时动态地被修改，包括添加和删除。

  Swing组件树就像浏览器的HTMLDOM树一样，可以通过脚本语言JavaScript进行动态修改，从而达到浏览器页面的局部更新的功能，Swing通过动态的往容器组件中添加或者删除编辑组件实现复合类型组件的in-placeeditor功能。

 所有Swing组件都是直接或者间接继承自JComponent，而JComponent是Container类的一个子类，因此所有的Swing组件都可看作一个容器组件。复合数据类型的组件也是如此，它们内部往往拥有自己的子结构、布局管理器、为实现某种功能而隐藏了的子组件（比如前篇文章中所提到的CellRendererPane）等。复合数据类型的组件通过动态修改自己内部组件树结构实现in-placeeditor。

  In-placeeditor的生命周期包括激活、编辑、停止编辑、取消编辑、删除编辑器等。下面以JTable为例详细了解In-placeeditor的工作过程。

  首先要了解JTable的in-placeeditor接口TableCellEditor的定义：

public interface TableCellEditor extendsCellEditor {
   /*该方法返回JTable当前表格的编辑组件，该组件根据提供的参数table、value、isSelected、row、column进行配置。注意，对该组件的调用有可能会导致停止编辑，丢失尚未编辑完的数据。该组件将作为JTable的子组件添加到组件树上，之后就可以接受用户的输入了。*/
    ComponentgetTableCellEditorComponent(JTable table, Object value,
      boolean isSelected,
      int row, int column);
}

  再看一下CellEditorListener的定义：

  当鼠标双击之类引起编辑的事件发生时，JTable的激活编辑器的过程可用下面的图来示意：

 首先检查当前是否正在编辑。如果正在编辑，则调用TableCellEditor的stopCellEditing来结束编辑。stopCellEditing如果不能正常结束，则返回false，这时便把焦点重新定位给该编辑器，并结束。如果当前不是正在编辑，或者虽然正在编辑，但是stopCellEditing正常结束了，则判断当前的鼠标事件是否是鼠标拖动行为。如果是则调用mousePressedDND方法处理。否则说明该事件有可能引发编辑功能。接着调用TableModel.isCellEditable判断该当前单元格是否允许编辑。如果允许编辑，则获得当前单元格的TableCellEditor，调用其isCellEditable判断当前鼠标事件是否意味着激活编辑（比如规定双击意味着激活编辑、单击并不激活等）。如果是激活编辑事件，则从TableCellEditor.getTableCellEditorComponent获取编辑组件，最后将该组件添加到组件树上，添加适当的处理器、有效化之后等待用户输入。

 TableCellEditor的stopCellEditing方法通常会删除当前编辑器。上面过程中，如果JTable正在处于编辑中，鼠标的点击则会导致调用TableCellEditor的stopCellEditing方法删除编辑器，并开始新的编辑器的安装过程。stopCellEditing在这个过程中获取编辑器的值并把它赋予JTable。其工作过程如下：

 tableCellEditing的stopCellEditing（左边示意图）先检查目前编辑组件的值是否有效（比如输入的整数是否越界）。如无效则（有时需要提示用户）返回false。如果有效则将该值作为editor的最终值存储起来，以备JTable通过editor.getCellEditorValue调用。然后触发编辑停止事件fireEditingStopped。由于JTable在安装编辑器时，总把自己注册为它的CellEditorListener处理器，因此当JTable能接到该通知。之后JTable就在其editingStopped（右边示意图）方法中处理该事件。JTable首先使用editor.getCellEditorValue获得该editor编辑好的值，并调用setValueAt将该值更新到当前单元格，最后调用removeEditor删除该编辑器。控制返回到TableCellEditor的stopCellEditing(左边示意图图）后，stopCellEditing返回true结束整个过程。

   TableCellEditor还会发出另一个事件fireEditingCanceled。这经常出现在编辑器本身有所谓取消功能编辑组件上。比如想在按下ESC键时取消当前正在编辑的值，就可以调用TableCellEditor的cancelEditing来取消。cancelEditing的工作过程比较简单，往往是直接通过fireEditingCanceled触发取消动作，侦听的JTable会在其editingCanceled方法中简单将编辑器删除去，继续保留以前的值。

 理解TableCellEditor接口的方法之间的关系对于编写自己的Editor很重要，它们之间除了上面注释所描述的含义外，还有一些暗示的关系编写程序时需要注意：

1.在自定义编辑器的stopCellEditing中要检查编辑组件正在编辑数据的有效性。如有效，要通过fireEditingStopped之类方法通知注册在此编辑器上的接口。如果没有触发，JTable将不能正常工作，编辑的值也会被丢失。最后要返回true作为成功的标识；如果数据没有效，一般做法是提示用户错误，用户确认错误提示后要要把焦点重新定位到编辑组件上，并返回false作为失败的标识。

2.注意在fireEditingStopped调用之前，getCellEditorValue返回的值一定要是当前有效的值。因为JTable会紧跟其后，调用该方法将编辑好的值填入表中并删除当前编辑器。

3.cancelCellEditing一般什么都不做，简单的fireEditingCanceled就行了。JTable响应该事件仅仅是简单的删除编辑器。

4.要实现方法addCellEditorListener和removeCellEditorListener，而不能空着它们，并且要定义fireEditingStopped和fireEditingCanceled两个方法以便在stopCellEditing和cancelCellEditing方法中使用它们触发事件。

5.getTableCellEditorComponent返回的组件需要添加适当的事件处理器，该处理器在用户编辑确认时（比如JTextField在敲回车引发ActionPerformed时），应该stopCellEditing以此来通知这次编辑过程已经完成，需要更新到JTable中。

 TableCellEditor接口暗含许多内部关系，如果不能正确建立它们之间的关系，实现往往并不能复合你的需求。

    JTree的TreeCellEditor接口和TableCellEditor除了获取编辑组件的方法的参数有所不同外，其他完全相同，其工作过程也类似。

  除了JTable和JTree外，JComboBox也有in-placeeditor，它的editor接口相对简单一些：

 由于JComboBox只有一处可以编辑，因此的编辑过程相当简单。JComboBox将ComboBoxEditor 提供组件作为编辑器添加到组件树上，自己注册为该ComboBoxEditor的ActionListener。当编辑组件的值发生变化，或用户确认编辑结果时，通知JComboBox。JComboBox发出适当的事件通知JComboBox的外部事件侦听者。

 当用户从列表中选择某项进行编辑时，JComboBox使用ComboBoxEditor.setItem设置编辑器的初始值。当用户请求JComboBox获取当前编辑值时，JComboBox调用ComboBoxEditor.getItem获取正在编辑的值，另外JComboBox可以通过ComboBoxEditor的selectAll来请求全选操作，这时允许如JTextField为编辑组件的编辑器实现全选。

 ComboBoxEditor接口的方法也暗含几个关系：

1.setItem、getItem、selectAll的操作对象应该是getEditorComponent返回的同一组件。

2.同样要实现addActionListener和removeActionListener，一般要实现fireActionPerformed，要侦听编辑组件的事件，使用fireActionPerformed通知JComboBox做出响应。

 编辑器工作过程相对比Renderer要复杂一些，主要是因为编辑过程是和用户进行交互的过程，不像Renderer那样只是简单的渲染过程。这个过程是非过程性的，所以它们的接口也就复杂的多，接口方法之间也暗含这一定的关系。

  但要正确理解也不难，关键要清楚JTable、JTree和JComboBox编辑器工作的过程。知道这些过程并根据以及前所学的事件及事件器处理模型知识，就应该很容易理解各个接口方法的含义以及它们之间暗含的关系，也就不会在实现自己的Editor时一头雾水，无所适从。由于篇幅的原因，今天文章就到此为止了。明天的文章将举一些具体例子加深对in-placeeditor的理解。

本文举一例子，实现如下图所示、类似于IDE界面设计工具的属性表。此例将向你演示如何自定义扩展TableCellEditor、TableCellRenderer以及TableModel，以便将这几天讲的知识串一下。

  TableCellSupport实现了TableCellEditor和TableCellRenderer两个接口，是扩展自定义渲染器及编辑器的基类。该类实现了TableCellEditor和TableCellRenderer的所有方法，封装了TableCellEditor所暗含的关系，并假定负责渲染的组件和负责编辑的组件为同一组件。org.dyno.test.impl包下的类继承该TableCellSupport类，分别实现了CheckBox、ComboBox、Spinner以及TextField常见类型的渲染器编辑器。要实现其他类型的自定义渲染器编辑器，可继承TableCellSupport进行扩展。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
我们仅举CheckBoxCell这个类的例子简单说明一下如何使用TableCellSupport进行自定义扩展。CheckBoxCell就是定义一个JCheckBox为编辑器和渲染器的实现：
public class CheckBoxCell extends TableCellSupport{
public CheckBoxCell(JCheckBox cb){
super(cb);
cb.addActionListener(new ActionListener(){
public void actionPerformed(ActionEvent e) {
//被选中时需要触发编辑停止事件，一般直接调用父类的stopCellEditing即可，那儿已经负责了有效性检查，事件触发。
stopCellEditing();
}
});
}
protected void setValueTo(JCheckBox component, Object value) {
//认为value值是Boolean类型的，注意空值的处理
component.setSelected(value==null?false:((Boolean)value).booleanValue());
}
protected Object getValueFrom(JCheckBox component) {
//返回当前选中状态的布尔值，用Boolean封装
return new Boolean(component.isSelected());
}
}
BeanProperty是一个简单的封装类，目的是打包一个属性的描述，包括它的名称、值、渲染器和编辑器。它的代码如下：
public class BeanProperty {
//属性显示名称，属性表格第一列显示名
private String displayName;
//属性的值，属性表格第二列的值
private Object value;
//渲染和编辑属性值用的渲染编辑器（Support类）
private TableCellSupport support;
public BeanProperty(String displayName, TableCellSupport support) {
this.displayName=displayName;
this.support=support;
}
public String getDisplayName() {...}
public Object getValue() {...}
public void setValue(Object value) {...}
public TableCellSupport getSupport() {...}
}
BeanPropertyTable继承了JTable类，它覆盖了JTable的两方法getCellRenderer和getCellEditor来提供自定义的渲染器和编辑器，并使用基于BeanProperty数组的数据模型BeanModel：
public class BeanPropertyTable extends JTable {
...
private ArrayList properties;
public BeanPropertyTable() {
properties=new ArrayList();
...
}
public void setProperties(ArrayList properties){
if(properties!=null){
this.properties=properties;
setModel(new BeanModel());
}
}
//自定义的TableModel
private class BeanModel extends AbstractTableModel{
public int getRowCount() {
//属性表的行数
return properties.size();
}
public int getColumnCount() {
//属性表的列数
return 2;
}
public String getColumnName(int columnIndex) {
//属性表的列名：property, value
return columnIndex==0?"property":"value";
}
public boolean isCellEditable(int rowIndex, int columnIndex) {
//第二列属性值可编辑
return columnIndex==1;
}
public Object getValueAt(int rowIndex, int columnIndex) {
//获取值，第一列用属性显示名，第二列用属性值
BeanProperty property=properties.get(rowIndex);
return columnIndex==0?property.getDisplayName():property.getValue();
}
public void setValueAt(Object aValue, int rowIndex, int columnIndex) {
if(columnIndex==1)//只有第二列可编辑，设置第二列到属性值
properties.get(rowIndex).setValue(aValue);
}
}
//覆盖父类的getCellRenderer提供个性化的渲染器
public TableCellRenderer getCellRenderer(int row, int column) {
if(column==0)//第一列使用继承的渲染器
return super.getCellRenderer(row, column);
else//第二列使用属性对象自己提供的渲染器，注意Support类实现了TableCellRenderer
return properties.get(row).getSupport();
}
//覆盖父类的getCellEditor提供个性化的编辑器
public TableCellEditor getCellEditor(int row, int column) {
if(column==0)//第一列使用继承的编辑器
return super.getCellEditor(row,column);
else//第二列使用属性对象自己提供的编辑器，注意Support类实现了TableCellEditor
return properties.get(row).getSupport();
}
}
最后看看主类PropertyDemo.java的实现，非常简单，非常直接：
public class PropertyDemo extends JFrame{
public PropertyDemo() {
setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
BeanPropertyTable table=new BeanPropertyTable();
ArrayList props=new ArrayList();
for(int i=0;i<2;i++){
//添加一个textfield属性，其渲染编辑组件是JTextField
props.add(new BeanProperty("textfield"+i,new TextFieldCell(new JTextField())));
//添加一个combo属性，其渲染编辑组件是JComboBox
JComboBox cb=new JComboBox();
cb.addItem("true");
cb.addItem("false");
props.add(new BeanProperty("combobox"+i,new ComboBoxCell(cb)));
//添加一个checkbox属性，其渲染编辑组件是 JCheckBox
props.add(new BeanProperty("checkbox"+i,new CheckBoxCell(new JcheckBox())));
//添加一个spinner属性，其渲染编辑组件是 JSpinner
props.add(new BeanProperty("spinner"+i, new SpinnerCell(new JSpinner())));
}
//设置这些属性数组到属性表
table.setProperties(props);
add(new JScrollPane(table), BorderLayout.CENTER);
}
public static void main(String args[]) {
try {
//设置外观，这儿设置成系统的，也可以设置成其他的外观
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
} catch (Exception ex) {
ex.printStackTrace();
}
EventQueue.invokeLater(new Runnable() {
public void run() {
//显示属性表的窗口
PropertyDemo demo=new PropertyDemo();
demo.setSize(200,300);
demo.setVisible(true);
}
});
}
}
另外，在SpinnerCell类中继承并覆盖了checkComponentValue，检查整型值是否小于零，小于零就报错：
public class SpinnerCell extends TableCellSupport {
...
protected void checkComponentValue(JSpinner component) throws Exception {
Integer i=(Integer)component.getValue();
if(i.intValue()<0)
throw new Exception("Cannot be negative!");
}
}
当编辑spinner属性时，如果输入值小于零，便会提示用户出错，要求用户重新输入：
 本例中的TableCellSupport封装了最常见的渲染和编辑逻辑，它把暗含的接口关系都已经实现了，用户的自定义扩展只需要实现上文提到的四个方法便可满足大部分需求，因此TableCellSupport类可以作为一个比较通用的基类，来简化自定义JTable的开发。

来源：http://blog.sina.com.cn/s/blog_4b6047bc010007qz.html

最后

以上就是激动水蜜桃最近收集整理的关于Swing框架之Renderer的全部内容，更多相关Swing框架之Renderer内容请搜索靠谱客的其他文章。