`

让JTextField添加“自动完成”功能

阅读更多

在越来越重视“用户体验”的今天,一个简单的文本框也变得越来越智能了。比如Google的搜索,当我们输入搜索关键字的过程中,文本框就会动态地下拉列出最常输入的近似文字,以便我们快速输入要查询的内容。当然一直抄袭Google的百度自然也是一样。类似的例子还有很多,例如一般的邮件客户端,在输入地址时,也会动态列出符合要求的地址,方便快速录入,也会减少出错。




那么,Swing的文本框要做到这一点是否容易呢?网上的例子也能搜索到一些,不过要么功能做的太简单,要么实现的代码太繁琐罗嗦。还有一些商业的Swing组件,则完全是要付费的。本文结合了2BizBox免费ERP软件开发中的实践,尝试了一种非常简单、有效的方法来制作这一效果。

 

首先仔细观察这种效果:它外观上、本质上,都完全是一个文本框,而不是下拉框。所以,我们不想把它做成下拉框,也就是不想从JComboBox继承。另外,下拉列表提示的出现,是完全异步、动态的,它仅仅作为提示,不能干预正常的文本框的输入。最后,那个下拉列表的外观和行为则完全是一个JComboBox的下拉列表行为。所以,这个“可自动完成的JTextField”应当是一个JTextField和JComboBox下拉列表部分的结合体。

经过以上分析,思路基本确定:它本质是一个JTextField,但是又结合利用了一个JComboBox的下拉列表。二者合而为一即可。那么是从谁继承呢?JTextField吗?

仔细想想,继承并不是最好的方法。俗话说:继承是混蛋。能不继承就不要继承。为什么呢?继承,意味着别人只能继承你的类,才能使用这一功能。假如你的项目已经写了一万多个界面,想给这里面的一些文本框增加这种智能提示功能,难道要对所有代码进行修改,让那些东西重新继承你的类吗?这无疑是个烂主意。所以,那些刚学会OO的童鞋,总是喜欢动不动就要继承的思路,并不妥当。如果我们只是提供一个Util方法,对已经存在的普通JTextField实例处理一下,就可以具有智能提示,岂不是更好?

要做到JTextField和JComboBox这两个组件的结合,这里使用了非常“怪异”的一个绝招,你绝对想不到:把一个JComboBox塞到JTextField的身体里面,并让它看不见。看一下代码:

 

 

JTextField txtInput = new JTextField();
JComboBox cbInput = new JComboBox();
txtInput.setLayout(new BorderLayout());
txtInput.add(cbInput, BorderLayout.SOUTH);

 

 

什么?把JTextField设置一个layout?并且还add一个JComboBox且放在SOUTH?我相信你绝对闻所未闻这种事情。怎么看都是怪胎啊。不要紧,把JComboBox的高度变成0,别人就看不出破绽了:

虽然combo看不见,但是它实实在在存在于文本框的身体里,且位于其下方。我们的思路是:当文本框输入内容时,我们判断下拉框中是否有符合要求的列表,如果有,就马上主动弹出下拉;否则就让下拉消失。

监控文本框输入并不难:给它的document增加listener就行了。这里我们使用了“不区分大小写”、“和输入字符串开头相同的项”的规则进行过滤。将所有备选字符串置于单独一个数组中,每次用户输入后,动态过滤出符合条件的字符串,动态添加到JComboBox中,并将其下拉列表Popup出来即可:

 

 

txtInput.getDocument().addDocumentListener(new DocumentListener() {
	public void insertUpdate(DocumentEvent e) {
		updateList();
	}

	public void removeUpdate(DocumentEvent e) {
		updateList();
	}

	public void changedUpdate(DocumentEvent e) {
		updateList();
	}

	private void updateList() {
		setAdjusting(cbInput, true);
		model.removeAllElements();
		String input = txtInput.getText();
		if (!input.isEmpty()) {
			for (String item : items) {
				if (item.toLowerCase().startsWith(input.toLowerCase())) {
					model.addElement(item);
				}
			}
		}
		cbInput.setPopupVisible(model.getSize() > 0);
		setAdjusting(cbInput, false);
	}
});

 
此外,为了更方便操作,我们再增加几个快捷键:当输入ESC,主动关掉下拉列表;当输入回车或空格,直接把第一项符合要求的字符串输入文本框:

 

txtInput.addKeyListener(new KeyAdapter() {

	@Override
	public void keyPressed(KeyEvent e) {
		setAdjusting(cbInput, true);
		if (e.getKeyCode() == KeyEvent.VK_SPACE) {
			if (cbInput.isPopupVisible()) {
				e.setKeyCode(KeyEvent.VK_ENTER);
			}
		}
		if (e.getKeyCode() == KeyEvent.VK_ENTER || e.getKeyCode() == KeyEvent.VK_UP || e.getKeyCode() == KeyEvent.VK_DOWN) {
			e.setSource(cbInput);
			cbInput.dispatchEvent(e);
			if (e.getKeyCode() == KeyEvent.VK_ENTER) {
				txtInput.setText(cbInput.getSelectedItem().toString());
				cbInput.setPopupVisible(false);
			}
		}
		if (e.getKeyCode() == KeyEvent.VK_ESCAPE) {
			cbInput.setPopupVisible(false);
		}
		setAdjusting(cbInput, false);
	}
});

 
还有一个非常重要的技术要点要进行说明。在popup列表弹出的时候,我们希望用箭头能够上下移动选择条目,但是又同时希望当前的光标和焦点不要离开文本框。这个好像非常难实现啊!请看我们是如何做到的:在监控到上下箭头输入时候,把当前的键盘事件的source动态修改为JComboBox,然后派发给JComboBox。也就是说,本来事件是输入到文本框的,我们把邮递员拦截下来,把收件人改一下,继续交给邮递员进行派发。这样,就做到“移花接木”了:

 

if (e.getKeyCode() == KeyEvent.VK_ENTER || e.getKeyCode() == KeyEvent.VK_UP || e.getKeyCode() == KeyEvent.VK_DOWN) {
	e.setSource(cbInput);
	cbInput.dispatchEvent(e);
	if (e.getKeyCode() == KeyEvent.VK_ENTER) {
		txtInput.setText(cbInput.getSelectedItem().toString());
		cbInput.setPopupVisible(false);
	}
}


最后,为了演示效果,我们放一些数据到下拉列表中。放什么呢?自己造假数据太麻烦了,干脆用Java中的“所有国家”的数据吧,简单省事:

Locale[] locales = Locale.getAvailableLocales();
for (int i = 0; i < locales.length; i++) {
	String item = locales[i].getDisplayName();
	items.add(item);
}


最后看一下效果,完全符合我们的预期:


以下是完整代码:

 

 

import java.awt.*;
import java.awt.event.*;
import java.util.*;

import javax.swing.*;
import javax.swing.event.*;

import twaver.*;

public class Test {

	public static void main(String[] args) throws Exception {
		UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
		JFrame frame = new JFrame();
		frame.setTitle("Auto Completion Test");
		frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		frame.setBounds(200, 200, 500, 400);

		ArrayList<String> items = new ArrayList<String>();
		Locale[] locales = Locale.getAvailableLocales();
		for (int i = 0; i < locales.length; i++) {
			String item = locales[i].getDisplayName();
			items.add(item);
		}
		JTextField txtInput = new JTextField();
		setupAutoComplete(txtInput, items);
		txtInput.setColumns(30);
		frame.getContentPane().setLayout(new FlowLayout());
		frame.getContentPane().add(txtInput, BorderLayout.NORTH);
		frame.setVisible(true);
	}

	private static boolean isAdjusting(JComboBox cbInput) {
		if (cbInput.getClientProperty("is_adjusting") instanceof Boolean) {
			return (Boolean) cbInput.getClientProperty("is_adjusting");
		}
		return false;
	}

	private static void setAdjusting(JComboBox cbInput, boolean adjusting) {
		cbInput.putClientProperty("is_adjusting", adjusting);
	}

	public static void setupAutoComplete(final JTextField txtInput, final ArrayList<String> items) {
		final DefaultComboBoxModel model = new DefaultComboBoxModel();
		final JComboBox cbInput = new JComboBox(model) {
			public Dimension getPreferredSize() {
				return new Dimension(super.getPreferredSize().width, 0);
			}
		};
		setAdjusting(cbInput, false);
		for (String item : items) {
			model.addElement(item);
		}
		cbInput.setSelectedItem(null);
		cbInput.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				if (!isAdjusting(cbInput)) {
					if (cbInput.getSelectedItem() != null) {
						txtInput.setText(cbInput.getSelectedItem().toString());
					}
				}
			}
		});

		txtInput.addKeyListener(new KeyAdapter() {

			@Override
			public void keyPressed(KeyEvent e) {
				setAdjusting(cbInput, true);
				if (e.getKeyCode() == KeyEvent.VK_SPACE) {
					if (cbInput.isPopupVisible()) {
						e.setKeyCode(KeyEvent.VK_ENTER);
					}
				}
				if (e.getKeyCode() == KeyEvent.VK_ENTER || e.getKeyCode() == KeyEvent.VK_UP || e.getKeyCode() == KeyEvent.VK_DOWN) {
					e.setSource(cbInput);
					cbInput.dispatchEvent(e);
					if (e.getKeyCode() == KeyEvent.VK_ENTER) {
						txtInput.setText(cbInput.getSelectedItem().toString());
						cbInput.setPopupVisible(false);
					}
				}
				if (e.getKeyCode() == KeyEvent.VK_ESCAPE) {
					cbInput.setPopupVisible(false);
				}
				setAdjusting(cbInput, false);
			}
		});
		txtInput.getDocument().addDocumentListener(new DocumentListener() {
			public void insertUpdate(DocumentEvent e) {
				updateList();
			}

			public void removeUpdate(DocumentEvent e) {
				updateList();
			}

			public void changedUpdate(DocumentEvent e) {
				updateList();
			}

			private void updateList() {
				setAdjusting(cbInput, true);
				model.removeAllElements();
				String input = txtInput.getText();
				if (!input.isEmpty()) {
					for (String item : items) {
						if (item.toLowerCase().startsWith(input.toLowerCase())) {
							model.addElement(item);
						}
					}
				}
				cbInput.setPopupVisible(model.getSize() > 0);
				setAdjusting(cbInput, false);
			}
		});
		txtInput.setLayout(new BorderLayout());
		txtInput.add(cbInput, BorderLayout.SOUTH);
	}
}
分享到:
评论

相关推荐

    JTextField添加“自动完成”

    通过这种方式,我们可以为已有的`JTextField`实例轻松添加自动完成功能,而无需修改大量代码。这种方法不仅简单,而且高效,避免了过度设计,提高了代码的可维护性。 总结来说,实现`JTextField`的自动完成功能,...

    原创:java封装了的JTextField,可以达到google输入框的效果

    在标准的`JTextField`中,虽然没有内置的自动联想或提示功能,但开发者可以通过自定义和扩展`JTextField`的功能来实现类似Google输入框的效果。 这篇原创文章描述的是如何在Java中封装`JTextField`,以实现输入时的...

    AutoText:Java Swing 库,允许将自动完成的可能性添加到文本组件(JTextComponent - JTextField - JFormattedTextField 等)

    在给定的资源“AutoText”中,我们关注的是如何为Java Swing的文本组件添加自动完成功能。这个库特别适用于JTextComponent的子类,如JTextField和JFormattedTextField,这些组件通常用于接收用户的单行文本输入。 ...

    combox 实现搜寻功能

    - 该类重写了`JComboBox`的构造方法,并在每个构造方法中调用了`addCompleter()`方法来添加自动完成的功能。 - `addCompleter()`方法设置`JComboBox`为可编辑状态,并创建了一个`AutoCompleter`实例,这个实例实现...

    swing效果点击下拉框自动填充文本框

    - 将选中的项设置为`JTextField`的内容,通过`JTextField.setText()`方法完成。 4. **数据绑定**: - 如果希望实现更复杂的逻辑,如双向数据绑定,可以使用`PropertyChangeSupport`类来实现属性变化的通知。当`...

    基于Java swing开发的预约洗车系统,可实现预约洗车的所有功能

    在本项目"基于Java Swing开发的预约洗车系统"中,我们看到这个系统主要目标是提供一个平台,让用户能够方便地进行洗车预约及相关管理操作。 1. **用户登录注册**: 用户登录注册是任何系统的基础部分。在Java ...

    netbean的使用方法

    在完成了GUI界面的设计之后,接下来是为各个按钮添加相应的功能。 - **让“Exit”按钮工作**:可以通过双击按钮,在弹出的代码编辑器中编写代码来实现退出程序的功能。具体实现可以是关闭当前窗口或整个程序。 - **...

    java自动取款机

    Java自动取款机(ATM)系统是一种模拟真实银行ATM功能的应用程序,它通常包含用户界面、账户管理、交易处理等核心模块。这个压缩包文件包含文档、代码和数据库,意味着我们可以深入学习如何用Java语言实现一个完整的...

    韩顺平学生管理系统源代码

    完成后,系统会自动更新表格中的数据。 - **修改功能**:选择表格中的一行后点击“修改”按钮,同样会弹出一个对话框让用户修改选中行的信息。修改完成后,表格数据也会随之更新。 - **删除功能**:用户可以选择表格...

    用java写的简单计算器(netbeans)

    NetBeans是一个流行的开源IDE,它提供了许多便利的功能,如代码自动完成、调试工具以及可视化组件设计,使得构建Java桌面应用变得更加简单。 1. **Java Swing基础**: - Swing库提供了许多组件,如JFrame(窗口)...

    java小程序之简单学生信息录入界面

    5. **测试与调试**:在设计完成后,运行程序进行测试,确保所有功能正常运行,界面显示无误,用户交互流畅。 在提供的压缩文件“java小程序之学生信息界面”中,包含了这个项目的源代码和资源文件。通过阅读和分析...

    学生管理系统实训报告(java语言).doc

    - **展示内容**: 与学生客户端类似,但增加了更多管理功能,如添加新学生、查看学生成绩信息等。 9. **StuInfo 类** - **功能**: 学生查询个人信息。 10. **NewStudentInfo 类** - **功能**: 教师创建新生基本...

    使用Java创建投资追踪应用程序 - 一个实战教程

    例如,创建`JFrame`作为主窗口,使用`JTable`展示投资列表,`JTextField`用于用户输入,以及`JButton`触发添加、计算和保存操作。 4. **实现功能**: - 对于添加投资,编写事件监听器,当用户点击“添加”按钮时,...

    Swing做的高仿QQ登陆界面

    最后,项目提供的"可运行jar文件"表明,开发者已经将程序打包成可独立运行的Java应用程序,这通常通过使用jar命令或集成开发环境(IDE)的打包功能完成。用户只需双击jar文件,无需安装任何额外的环境,就能启动这个...

    Java水果超市管理系统.docx

    例如,添加商品的代码可能涉及创建JFrame,添加JTextField和JButton,然后设置事件监听器来处理用户输入和点击事件。数据库操作则可能包括连接数据库、执行SQL语句(如INSERT)以及关闭连接。 通过这个项目,学生...

    Swing文本编辑器

    Swing文本编辑器还可以添加额外的功能,如自动完成、拼写检查等。这些通常需要更复杂的实现,可能涉及到额外的库或服务,但Swing提供了足够的灵活性来扩展和集成这些功能。 总的来说,Swing文本编辑器的开发是一个...

    Java实验指导书_71

    在实验的第二部分,你需要在已给出的图形程序框架中添加适当的组件,形成一个具有视觉吸引力和功能性的界面。这涉及到对组件的布局管理(例如FlowLayout、GridLayout或BorderLayout),以及可能需要处理的事件监听,...

    简单的图形界面实现数据库的增删查改

    在IT领域,数据库的增删查改(CRUD:Create, Read, Update, Delete)是基本操作,而通过图形用户界面(GUI)实现这些功能可以让用户更加直观地进行交互。本教程将聚焦于如何使用Java语言来设计一个简单的图形界面,...

    java swing计算器程序idea编程环境

    至于IntelliJ IDEA,它是JetBrains公司推出的Java开发工具,具有代码提示、自动完成、重构等多种功能,极大地提高了开发效率。在IDEA中,我们可以方便地创建Swing项目,添加所需的库,以及组织和管理源代码。 总的...

    java-课程设计-超市管理系统-报告含代码.pdf

    - 系统使用Java Swing库创建GUI组件,如JFrame、JButton、JTextField等,不少于5种,确保界面直观且功能丰富。主窗口由EventDemo类负责,提供了“物品消费”、“会员添加”、“会员信息”和“账务管理”四个主要...

Global site tag (gtag.js) - Google Analytics