为JTextField添加Auto Completion功能

转载自： http://www.javaxx.com/java/html/java_gui/swing/200902/03-380.html

应用软件常见的一个功能是输入框选项自动提示功能。比如Google的查询条件输入框。Google记录下用户经常查询的关键字。当用户输入时，它能根据 当前已经输入的字符过滤出相近的选项，放在弹出的下拉框中供选择。如果碰巧有用户想要查询的关键字，就可以

    应用软件常见的一个功能是输入框选项自动提示功能。比如Google的查询条件输入框。Google记录下用户经常查询的关键字。当用户输入时，它能根据 当前已经输入的字符过滤出相近的选项，放在弹出的下拉框中供选择。如果碰巧有用户想要查询的关键字，就可以从中直接选择，而不用继续输入。

    还有个常见的应用场景是文件选择框的文件名自动补齐提示功能。当选择文件时，如果文件夹中文件太多，可在文件名输入框中输入该文件名称头几个字符，文件对话框会自动过滤出符合条件的几个文件供选择。

  

    这是个相当贴心的功能，能极大提高软件的易用性和友好程度。不幸的是Swing JTextField并不支持这个功能。幸运的是Swing提供了实现所需的灵活框架，而且实现并不复杂。只要结合前面文章介绍的popup相关知识和对Swing事件的稍许了解，就可以实现这个功能。 

    实现这一功能的基本思想是侦听JTextField的Document事件，当输入框内的文字发生变化时，调用过滤器过滤出选项，将这些选项放在一个JList，将该JList添加到JPopupMenu显示出来。 

    这个实现要注意一下几点：

    1.显示选项下拉框时JTextField会失去焦点，因此必须在弹出选项框后，调用JTextField.requestFocus使其重新获得焦点，以便继续后面的键盘输入。

    2.为实现类似鼠标在菜单上的效果，要为JList添加鼠标处理器，动态检测鼠标位置，并设置当前选项。

    3.为使其支持键盘操作，包括上下箭头和Page Up/Down，要为JTextField添加KeyListener。注意虽然JList本身就支持键盘操作，但由于输入时焦点是在JTextField上，因此键盘操作不对JList起作用，所以需要为JTextField添加该处理器。

    4.为方便以后扩展，过滤器要使用接口的形式，以便应用程序编写自己的过滤器实现，并注册到该组件上。

    5.要提供显式激活选项下拉框的方法。本文演示的实现是用鼠标双击JTextField的方式，它根据当前JTextField的内容过滤选项并显示选项下拉框。

    本文演示程序实现该功能的组件是一个继承了JTextField的类dyno.swing.beans.AutoCompletionField。主要接口有两个： 

public void setFilter(CompletionFilter f)

    设置该输入框的过滤器。用户可以像编写Swing事件处理器一样编写实现CompletionFilter接口的过滤器。接口CompletionFilter的定义如下：

public interface CompletionFilter {     ArrayList filter(String text); }

    每次输入框内容发生变化，AutoCompletionField会调用filter方法，过滤出下拉框选项。返回的选项列表类型可以为任何引用类型。然后AutoCompletionField将这些选项添加到下拉框显示给用户。

    演示实现了一个缺省的过滤处理器，dyno.swing.beans.DefaultCompletionFilter，它使用字符串首匹配算法从一个Vector提供的选项列表中过滤所有的选项。 

public void setPopupPreferredHeight(int h)

       设置下拉框窗口的最佳高度。选项下拉框的宽度总是和输入框的宽度一致。

    使用该组件的样例代码如下：

AutoCompletionField auto = new AutoCompletionField();         Vector v=new Vector();         File file=new File(System.getProperty("user.home"));         String[]files=file.list();         for(String filename:files)             v.add(filename);         auto.setFilter(new DefaultCompletionFilter(v));         panel.add(auto);

    本文的演示使用类似上面代码模拟文件对话框的文件名过滤功能。当用户输入时，它根据输入过滤用户目录下相近文件名的列表，弹出下拉框供用户选择：

 

  本文的演示源码下载。