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

2024-02-10 05:58

本文主要是介绍让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() {@Overridepublic 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() {@Overridepublic void actionPerformed(ActionEvent e) {if (!isAdjusting(cbInput)) {if (cbInput.getSelectedItem() != null) {txtInput.setText(cbInput.getSelectedItem().toString());}}}});txtInput.addKeyListener(new KeyAdapter() {@Overridepublic 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添加“自动完成”功能的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/696297

相关文章

Python使用FastAPI实现大文件分片上传与断点续传功能

《Python使用FastAPI实现大文件分片上传与断点续传功能》大文件直传常遇到超时、网络抖动失败、失败后只能重传的问题,分片上传+断点续传可以把大文件拆成若干小块逐个上传,并在中断后从已完成分片继... 目录一、接口设计二、服务端实现(FastAPI)2.1 运行环境2.2 目录结构建议2.3 serv

MyBatis Plus实现时间字段自动填充的完整方案

《MyBatisPlus实现时间字段自动填充的完整方案》在日常开发中,我们经常需要记录数据的创建时间和更新时间,传统的做法是在每次插入或更新操作时手动设置这些时间字段,这种方式不仅繁琐,还容易遗漏,... 目录前言解决目标技术栈实现步骤1. 实体类注解配置2. 创建元数据处理器3. 服务层代码优化填充机制详

深入浅出Spring中的@Autowired自动注入的工作原理及实践应用

《深入浅出Spring中的@Autowired自动注入的工作原理及实践应用》在Spring框架的学习旅程中,@Autowired无疑是一个高频出现却又让初学者头疼的注解,它看似简单,却蕴含着Sprin... 目录深入浅出Spring中的@Autowired:自动注入的奥秘什么是依赖注入?@Autowired

Debian 13升级后网络转发等功能异常怎么办? 并非错误而是管理机制变更

《Debian13升级后网络转发等功能异常怎么办?并非错误而是管理机制变更》很多朋友反馈,更新到Debian13后网络转发等功能异常,这并非BUG而是Debian13Trixie调整... 日前 Debian 13 Trixie 发布后已经有众多网友升级到新版本,只不过升级后发现某些功能存在异常,例如网络转

基于Redis自动过期的流处理暂停机制

《基于Redis自动过期的流处理暂停机制》基于Redis自动过期的流处理暂停机制是一种高效、可靠且易于实现的解决方案,防止延时过大的数据影响实时处理自动恢复处理,以避免积压的数据影响实时性,下面就来详... 目录核心思路代码实现1. 初始化Redis连接和键前缀2. 接收数据时检查暂停状态3. 检测到延时过

基于Java和FFmpeg实现视频压缩和剪辑功能

《基于Java和FFmpeg实现视频压缩和剪辑功能》在视频处理开发中,压缩和剪辑是常见的需求,本文将介绍如何使用Java结合FFmpeg实现视频压缩和剪辑功能,同时去除数据库操作,仅专注于视频处理,需... 目录引言1. 环境准备1.1 项目依赖1.2 安装 FFmpeg2. 视频压缩功能实现2.1 主要功

使用Python实现无损放大图片功能

《使用Python实现无损放大图片功能》本文介绍了如何使用Python的Pillow库进行无损图片放大,区分了JPEG和PNG格式在放大过程中的特点,并给出了示例代码,JPEG格式可能受压缩影响,需先... 目录一、什么是无损放大?二、实现方法步骤1:读取图片步骤2:无损放大图片步骤3:保存图片三、示php

深度解析Python yfinance的核心功能和高级用法

《深度解析Pythonyfinance的核心功能和高级用法》yfinance是一个功能强大且易于使用的Python库,用于从YahooFinance获取金融数据,本教程将深入探讨yfinance的核... 目录yfinance 深度解析教程 (python)1. 简介与安装1.1 什么是 yfinance?

Python脚本轻松实现检测麦克风功能

《Python脚本轻松实现检测麦克风功能》在进行音频处理或开发需要使用麦克风的应用程序时,确保麦克风功能正常是非常重要的,本文将介绍一个简单的Python脚本,能够帮助我们检测本地麦克风的功能,需要的... 目录轻松检测麦克风功能脚本介绍一、python环境准备二、代码解析三、使用方法四、知识扩展轻松检测麦

Java实现TXT文件导入功能的详细步骤

《Java实现TXT文件导入功能的详细步骤》在实际开发中,很多应用场景需要将用户上传的TXT文件进行解析,并将文件中的数据导入到数据库或其他存储系统中,本文将演示如何用Java实现一个基本的TXT文件... 目录前言1. 项目需求分析2. 示例文件格式3. 实现步骤3.1. 准备数据库(假设使用 mysql