1. 问题背景与现象分析
在使用javax.swing.jformattedtextfield组件进行数据输入时，如果需要对输入内容进行格式化，例如处理货币值并添加固定的前缀（如"gs. "），通常会结合javax.swing.text.numberformatter进行自定义。然而，在实际应用中，开发者可能会遇到一个棘手的问题：当用户在jformattedtextfield中输入第一个数字时，尽管文本内容正确添加了前缀，但光标位置却错误地跳到了前缀之前，而不是停留在数字的末尾，导致后续输入体验不佳。
最初的尝试可能是在自定义NumberFormatter的install方法中设置光标位置，如下所示：
@Override
public void install(JFormattedTextField pField) {
super.install(pField);
pField.setCaretPosition(pField.getDocument().getLength()); // 尝试将光标设置到末尾
}然而，这种方法往往无法解决问题。根据NumberFormatter的API文档和实际测试，install方法仅在JFormattedTextField对象被创建并安装格式化器时调用一次，而不是在每次文本内容更新或组件获得焦点时调用。因此，当用户输入导致文本内容变化时，install方法中的光标设置逻辑并不会再次执行，从而无法动态修正光标位置。
2. 核心解决方案：DocumentListener与EventQueue.invokeLater
要解决此问题，我们需要一种机制来监听JFormattedTextField中文本内容的实时变化，并在内容更新后立即调整光标位置。javax.swing.event.DocumentListener正是为此目的设计的。同时，为了确保光标设置操作在所有Swing内部的文档监听器处理完毕之后执行，并避免线程安全问题，我们还需要借助javax.swing.EventQueue.invokeLater()。
2.1 DocumentListener的引入
DocumentListener接口提供了三个方法来响应文档内容的改变：
- insertUpdate(DocumentEvent e)：在文档中插入内容时触发。
- removeUpdate(DocumentEvent e)：在文档中删除内容时触发。
- changedUpdate(DocumentEvent e)：在文档属性或样式改变时触发（不涉及文本内容变化，通常不需要处理）。
通过在NumberFormatter的install方法中为JFormattedTextField的Document添加一个DocumentListener，我们可以在每次文本内容（插入或删除）发生变化时捕获到事件。
2.2 EventQueue.invokeLater的重要性
Swing组件的UI更新必须在事件调度线程（Event Dispatch Thread, EDT）上进行。直接在DocumentListener的事件处理方法中调用pField.setCaretPosition()可能会遇到以下问题：
- 线程安全： DocumentListener可能在非EDT线程上被触发，直接操作UI组件可能导致不可预测的行为。
- 事件顺序： Swing内部也可能为JFormattedTextField的Document添加了其他的DocumentListener。如果我们的监听器在这些内部监听器之前执行，那么光标位置可能会被后续的Swing内部逻辑再次修改。
EventQueue.invokeLater(() -> ...)的作用是将指定的操作放入EDT的事件队列中，等待EDT空闲时执行。这确保了：
- EDT执行： 所有UI更新都在EDT上安全执行。
- 延迟执行： 我们的光标设置操作会在所有当前事件（包括其他DocumentListener的事件处理）处理完毕后执行，从而保证光标最终被设置到正确的位置。
3. 实现细节与示例代码
以下是修改后的formato()方法，其中包含了解决光标错位问题的核心逻辑。
import javax.swing.JFormattedTextField;
import javax.swing.text.NumberFormatter;
import javax.swing.text.DocumentFilter;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import java.text.DecimalFormat;
import java.text.ParseException;
import java.math.BigDecimal;
import java.awt.EventQueue; // 引入 EventQueue
public class CurrencyFormattedTextFieldExample {
private JFormattedTextField textFieldMonto;
public CurrencyFormattedTextFieldExample() {
textFieldMonto = new JFormattedTextField(formato());
// ... 其他 UI 初始化代码
}
private NumberFormatter formato() {
// 定义货币格式，例如 "Gs. 1,234,567"
DecimalFormat myFormatter = new DecimalFormat("'Gs. '###,##0;'Gs. '###,##0");
NumberFormatter numberFormatter = new NumberFormatter(myFormatter) {
// 核心修改：在 install 方法中添加 DocumentListener
@Override
public void install(JFormattedTextField pField) {
super.install(pField);
// 为 JFormattedTextField 的 Document 添加监听器
pField.getDocument().addDocumentListener(new DocumentListener() {
@Override
public void insertUpdate(DocumentEvent e) {
// 在插入内容后，通过 invokeLater 将光标设置到末尾
EventQueue.invokeLater(() -> pField.setCaretPosition(pField.getDocument().getLength()));
}
@Override
public void removeUpdate(DocumentEvent e) {
// 在删除内容后，通过 invokeLater 将光标设置到末尾
EventQueue.invokeLater(() -> pField.setCaretPosition(pField.getDocument().getLength()));
}
@Override
public void changedUpdate(DocumentEvent e) {
// 属性改变，不涉及文本内容，通常无需处理
}
});
}
// 允许空文本，并阻止负数
@Override
public String valueToString(Object value) throws ParseException {
String result = super.valueToString(value);
// 如果结果以负号开头，移除它（阻止显示负数）
if (result.startsWith("-")) {
result = result.replaceFirst("-", "");
}
// 如果值为 null，返回空字符串
if (value == null) {
return "";
}
return result;
}
// 允许空文本，并阻止负数
@Override
public Object stringToValue(String text) throws ParseException {
// 如果文本为空或只包含前缀，返回 null
if (text.length() == 0 || text.equals("Gs. ")) {
return null;
}
// 移除负号（阻止输入负数）
text = text.replaceFirst("-", "");
// 如果文本不以前缀开头，则添加前缀
if (!text.startsWith("Gs. ")) {
text = "Gs. " + text;
}
return super.stringToValue(text);
}
};
numberFormatter.setAllowsInvalid(false); // 不允许无效输入
numberFormatter.setMaximum(new BigDecimal("999999999999")); // 设置最大值
numberFormatter.setCommitsOnValidEdit(true); // 每次有效编辑后提交值，而不是失去焦点时
return numberFormatter;
}
// 示例用法（略）
public static void main(String[] args) {
EventQueue.invokeLater(() -> {
// 创建一个简单的JFrame来测试
javax.swing.JFrame frame = new javax.swing.JFrame("JFormattedTextField Caret Test");
frame.setDefaultCloseOperation(javax.swing.JFrame.EXIT_ON_CLOSE);
CurrencyFormattedTextFieldExample app = new CurrencyFormattedTextFieldExample();
frame.getContentPane().add(app.textFieldMonto);
frame.pack();
frame.setLocationRelativeTo(null);
frame.setVisible(true);
});
}
}在上述代码中，关键的改动集中在NumberFormatter的install方法内部。我们不再直接设置光标，而是添加了一个DocumentListener。当JFormattedTextField的文档内容因用户输入而发生insertUpdate或removeUpdate时，监听器会捕获到这些事件，并通过EventQueue.invokeLater将pField.setCaretPosition(pField.getDocument().getLength())操作提交到EDT队列中。这样，光标就能在每次有效内容更新后，稳定地定位到文本的末尾。
4. 注意事项与总结
- install方法的生命周期： 再次强调，install方法只在JFormattedTextField初始化时调用一次。因此，任何需要响应运行时文本变化的逻辑都应通过监听器（如DocumentListener）实现。
- EDT与线程安全： 所有对Swing组件的UI操作都必须在事件调度线程（EDT）上执行。EventQueue.invokeLater()是确保这一点的标准和推荐方式。
- 监听器顺序： 当有多个DocumentListener时，它们的执行顺序不能保证。invokeLater在这里起到了关键作用，它确保了我们的光标设置操作在所有可能影响光标位置的Swing内部逻辑执行之后发生。
- 自定义格式化逻辑： 示例中的valueToString和stringToValue方法展示了如何处理前缀、空值和负数。这些是NumberFormatter自定义行为的重要部分，虽然与光标问题不直接相关，但它们共同构成了完整的货币输入格式化方案。
通过上述方法，我们成功解决了JFormattedTextField在带前缀货币格式输入时，光标定位不准确的问题，显著提升了用户输入体验。这种结合DocumentListener和EventQueue.invokeLater的模式，对于处理Swing组件中复杂的UI交互和状态管理，具有广泛的参考价值。
