让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

相关文章

IDEA自动生成注释模板的配置教程

《IDEA自动生成注释模板的配置教程》本文介绍了如何在IntelliJIDEA中配置类和方法的注释模板,包括自动生成项目名称、包名、日期和时间等内容,以及如何定制参数和返回值的注释格式,需要的朋友可以... 目录项目场景配置方法类注释模板定义类开头的注释步骤类注释效果方法注释模板定义方法开头的注释步骤方法注

pytorch自动求梯度autograd的实现

《pytorch自动求梯度autograd的实现》autograd是一个自动微分引擎,它可以自动计算张量的梯度,本文主要介绍了pytorch自动求梯度autograd的实现,具有一定的参考价值,感兴趣... autograd是pytorch构建神经网络的核心。在 PyTorch 中,结合以下代码例子,当你

SpringBoot集成Milvus实现数据增删改查功能

《SpringBoot集成Milvus实现数据增删改查功能》milvus支持的语言比较多,支持python,Java,Go,node等开发语言,本文主要介绍如何使用Java语言,采用springboo... 目录1、Milvus基本概念2、添加maven依赖3、配置yml文件4、创建MilvusClient

Python如何自动生成环境依赖包requirements

《Python如何自动生成环境依赖包requirements》:本文主要介绍Python如何自动生成环境依赖包requirements问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录生成当前 python 环境 安装的所有依赖包1、命令2、常见问题只生成当前 项目 的所有依赖包1、

使用Python开发一个带EPUB转换功能的Markdown编辑器

《使用Python开发一个带EPUB转换功能的Markdown编辑器》Markdown因其简单易用和强大的格式支持,成为了写作者、开发者及内容创作者的首选格式,本文将通过Python开发一个Markd... 目录应用概览代码结构与核心组件1. 初始化与布局 (__init__)2. 工具栏 (setup_t

SpringBoot实现微信小程序支付功能

《SpringBoot实现微信小程序支付功能》小程序支付功能已成为众多应用的核心需求之一,本文主要介绍了SpringBoot实现微信小程序支付功能,文中通过示例代码介绍的非常详细,对大家的学习或者工作... 目录一、引言二、准备工作(一)微信支付商户平台配置(二)Spring Boot项目搭建(三)配置文件

在Android平台上实现消息推送功能

《在Android平台上实现消息推送功能》随着移动互联网应用的飞速发展,消息推送已成为移动应用中不可或缺的功能,在Android平台上,实现消息推送涉及到服务端的消息发送、客户端的消息接收、通知渠道(... 目录一、项目概述二、相关知识介绍2.1 消息推送的基本原理2.2 Firebase Cloud Me

Spring Boot项目中结合MyBatis实现MySQL的自动主从切换功能

《SpringBoot项目中结合MyBatis实现MySQL的自动主从切换功能》:本文主要介绍SpringBoot项目中结合MyBatis实现MySQL的自动主从切换功能,本文分步骤给大家介绍的... 目录原理解析1. mysql主从复制(Master-Slave Replication)2. 读写分离3.

Mybatis 传参与排序模糊查询功能实现

《Mybatis传参与排序模糊查询功能实现》:本文主要介绍Mybatis传参与排序模糊查询功能实现,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧... 目录一、#{ }和${ }传参的区别二、排序三、like查询四、数据库连接池五、mysql 开发企业规范一、#{ }和${ }传参的

微信公众号脚本-获取热搜自动新建草稿并发布文章

《微信公众号脚本-获取热搜自动新建草稿并发布文章》本来想写一个自动化发布微信公众号的小绿书的脚本,但是微信公众号官网没有小绿书的接口,那就写一个获取热搜微信普通文章的脚本吧,:本文主要介绍微信公众... 目录介绍思路前期准备环境要求获取接口token获取热搜获取热搜数据下载热搜图片给图片加上标题文字上传图片