JFC/Swing活学活用系列之定制JList显示

　　引言

　　在图形用户界面方面（GUI），Java一直无法与C++、PB、Delphi之类抗衡，使用早期Java/AWT包所开发的界面实在是让人不敢恭维。随着JFC/Swing的日趋成熟，开发出与可以与C++媲美的GUI不再是"不可能完成的任务"。除了具有丰富的界面组件之外，以下优秀的特性更让Swing如虎添翼。Swing是以100%纯Java实现的，且辅以JDK 1.1 轻量级UI框架为基础，没有本地代码，独立于操作系统之外，基于MVC设计模式、采用可插入的外观感觉（PL&F），这都让我们忍不住去感受一下她的魅力。

　　完整的JFC十分巨大，Swing只是其中的一部分，本文将着重于Swing包中的JList组件以及如何定制显示。

　　JList基础知识

　　由JList类代表的Swing列表显示一个可选取对象列表，它支持三种选取模式：单选取、单间隔选取、多间隔选取。

　　基于MVC的构建思想，JList类不维护对它所显示的那些对象的引用，而是把数据管理工作委托给一个实现ListModel接口的对象；JList类不对其显示对象的选取操作进行跟踪和维护，而是把选取管理的工作委托给一个实现ListSelectionModel接口的对象；JList类不绘制其所显示的对象，而是把列表单元的绘制工作委托给一个实现ListCellRenderer接口的对象。

　　JList组件把三个主要的工作（数据处理、列表项选取、单元绘制）交给其它对对象来完成，JList的每个实例都维护对上述对象的引用，这样大大降低了各个功能模块的耦合度，易于扩展和维护。

　　JList如何显示对象列表?

　　缺省情况下，JList对象对图标和字符串对象会按照原样显示，而对于其它所有对象只显示对象toString()方法的返回值。举个例子吧，有这样一个应用程序显示java.util.Locale对象列表给用户，用户可以通过选择列表中的项目来改变应用程序所的处的语言环境。

　　想象一下，JList将如何显示一个包含了Locale对象的数据模型呢？JList委派javax.swing.ListCellRenderer来显示这些对象。正如我们所料，ListCellRenderer将把对象toString()方法的返回值显示出来。然而，Locale对象返回的是ISO代码，这样的显示肯定是不符合"界面交互友好"原则的。默认情况下JList所显示的内容让大多数用户感到莫名其妙，如下图所示：


　　再来看下面这个例子，更恰如其分地说明了JList对象的缺省显示并不能对用户提供任何有意义的数据。假设一个绘图程序提供了颜色选择列表，也许你会从中选择一种颜色用于填充，也许用于绘制线条，或者干什么都可以。尽管我们将java.awt.Color对象实例放入JList中的作法是中规中矩的，但用户却不能从中得到任何的帮助，这背离了我们的初衷。如下图所示：


　　Color对象toString()方法返回的是三原色红、绿、蓝（RGB）各分量的亮度值，而不论它所表现的具体颜色是什么。除非用户知道所选取的第六行0、255、0所代表的是绿颜色，要么我们就应该在这个位置显示一些对用户更有帮助的信息。

　　诚然，你也许可以把java.lang.String对象的实例放入JList中以替代Color对象的实例，但这么做却放弃了使用JList的目的：用户是要从列表中选用一种颜色并非是选取一段文本描述。

　　当使用Color对象时，JList的监听变化的监听器返回的是用户实际看到的颜色。如果用String对象来替代的话，JList将把String对象返回到监听器，然后监听器再去匹配与之对应的颜色来完成填充操作，有点多此一举的感觉。

 

 

寻求解决方案

　　作为用户，我们希望的应用程序应该是界面交互清晰明了的，而不是把Locale对象的ISO代码或者是颜色的RGB值显示出来，界面交互友好的软件才能吸引用户。ISO代码或者RGB值对编程的人来说或许有用，但并不适合于终端用户。

　　幸运的是，Locale对象有个displayName属性适合用来为用户显示信息。我们可用该属性来替代toString()方法用于JList的显示，这样一来就能使得JList更具可读性。比较以下代码片段中Locale对象的toString()方法和getDisplayName方法的返回值：

Locale[] locales = { new Locale("en", "US"), new Locale("fr", "FR"),
new Locale("th", "TH"), new Locale("es", "MX"),
new Locale("ja", "JP") };
System.out.printf("%-10s\t%s\n", "toString", "getDisplayName");
System.out.printf("%-10s\t%s\n", "--------", "--------------");
for (Locale l : locales)
{
　System.out.printf("%-10s\t%s\n", l.toString(), l.getDisplayName());
}
　　在将有中文Windows XP的机器上，运行结果如下所示：

toString getDisplayName
-------- --------------
en_US 英文 (美国)
fr_FR 法文 (法国)
th_TH 泰文 (泰国)
es_MX 西班牙文 (墨西哥)
ja_JP 日文 (日本)

　　Locale对象的displayName属性对用户来说更具可读性，也更贴近用户。如果应用程序里的JList使用displayName属性，那么看起来会是下面的样子：


　　那么这个效果是怎么实现的呢？为了让列表在用户界面上有更好的表现，我们要创建自己的ListCellRenderer，这样在上面的例子中就可以通过displayName属性来替代默认的toString()方法的返回值。

　　类似地，如果我们的选择颜色的应用程序，我们也可以用定制的ListCellRenderer来显示Color对象对应的名称和它们的颜色。如下图所示：


　　我们先来了解一下ListCellRenderer的工作原理，ListCellRenderer接口只定义了一个方法，该方法返回一个组件：

Public abstract Component getListCellRendererComponent(JList list,Object value,Int index,boolean isSelected
boolean cellHasFocus)
　　由getListCellRendererComponent返回的组件的作用就像一个像皮图章，它把这个组件绘制到列表中列表项所占的区域。要注意的一点是，列表单元并不包含这个组件，这个组件只是绘制到列表单元上。这是很重要的，因为不能操纵这个组件，只能使用这个组件的可见代表来绘制列表单元。  

　　缺省情况下，JList的实例配备一个绘制器，它是ListCellRenderer接口的一个简单实现，即DefaultListCellRenderer类。该类扩展了JLabel类，而且可以显示字符串或图标，但不能在一个单元中同时显示字符串和图标。

　　虽然自定义的ListCellRenderer可继承任何Component，但对于上述应用我们选取的解决方案还是使用DefaultListCellRenderer的好，因为继承了JLabel，可以方便的设置文本、颜色，甚至图片。参考下面这段代码：

public Component getListCellRendererComponent(JList list, Object value,
int index, boolean isSelected, boolean cellHasFocus)
{
　super.getListCellRendererComponent(list, value, index, isSelected,cellHasFocus);
　Locale l = (Locale) value;
　setText(l.getDisplayName());
　return this;
}
　　renderer先调用它的超类的getListCellRendererComponent()方法来绘制组件，接下来只需要进行一些简单的设置就可以了，这里我们使用被选中的Locale对象的getDisplayName()方法的返回值来设置文本。

　　有了定制的ListCellRenderer，让JList来使用这个新的renderer就更简单了，调用JList对象的setCellRenderer()方法并且把新创建的ListCellRenderer实例作为参数传递进去，就足够了。JList对象将用定制的renderer来展现列表里每个Locale对象。参考下面的代码片段：

ListCellRenderer localeRenderer = new LocaleRenderer();
localeList.setCellRenderer(localeRenderer);
　　定制Color选取器的例子与Locale的例子有点不同。不同之处在于，装饰器不仅设置了选项单元的文本内容，还设置了它的颜色与对应的背景色。因为Color对象本身里没有内建的文本名，所以我们需要在颜色名和颜色之间建立映射关系。在这里我们使用HashMap来完成映射操作。具体代码实例请见参考资料。

　　结束语

　　最后再提一下对象在JList中是如何显示的。不必非得依赖对象提供的toString()方法，因为我们可以用ListCellRenderer来显示任何想要显示的和对象相关的文本。此外，我们也可以在选取的作为ListCellRenderer的组件上选用任何颜色或图形来绘制。我们也可以将同样的绘制器应用于JComboBox。使用定制的ListCellRenderer，可以使用JList和JComboBox组件来编写用户界面更加友好的应用程式。