将 JTextField 输入限制为整数 [重复]

Posted 2023-02-26

【中文标题】将 JTextField 输入限制为整数 [重复]

【英文标题】：Restricting JTextField input to Integers [duplicate]

【发布时间】：2012-06-21 00:59:30

【问题描述】：

我知道这个问题肯定被问过并回答了一百万次，但我就是找不到简单的解决方案。我有一个 JTextField，它只接受正整数作为输入。我需要一种方法来确保这里没有其他输入。

我已经有一个 keyListener 附加到这个控件。删除此侦听器要处理的其他代码，我有这个：

       txtAnswer.addKeyListener(new KeyAdapter() 
        @Override
        public void keyPressed(KeyEvent e) 

            int key = e.getKeyCode();

            /* Restrict input to only integers */
            if (key < 96 && key > 105) e.setKeyChar('');
        ;
    );

如您所见，我正在尝试使用 KeyCode 来检查刚刚按下的键是否在整数范围内。这似乎有效。但我想做的是如果条目超出此范围，则简单地忽略它。代码e.setKeyChar('') 旨在处理此问题，但它不起作用。代码会编译，但没有可见效果。

谁能告诉我我是否在正确的轨道上？我可以用什么替换 e.setKeyChar('') 来完成这项工作？还是我完全走错了方向？

谢谢。

【问题讨论】：

@Randy : 请也看看这个example

【参考方案1】：

不要为此使用 KeyListener，因为您会错过很多内容，包括粘贴文本。此外，KeyListener 是一个非常低级的构造，因此在 Swing 应用程序中应避免使用。

解决方案已在 SO 上多次描述：使用DocumentFilter。这个网站上有几个这样的例子，有些是我写的。

例如：using-documentfilter-filterbypass

还有教程帮助请看：Implementing a DocumentFilter。

编辑

例如：

import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.text.AttributeSet;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.DocumentFilter;
import javax.swing.text.PlainDocument;

public class DocFilter 
   public static void main(String[] args) 
      JTextField textField = new JTextField(10);

      JPanel panel = new JPanel();
      panel.add(textField);

      PlainDocument doc = (PlainDocument) textField.getDocument();
      doc.setDocumentFilter(new MyIntFilter());


      JOptionPane.showMessageDialog(null, panel);
   


class MyIntFilter extends DocumentFilter 
   @Override
   public void insertString(FilterBypass fb, int offset, String string,
         AttributeSet attr) throws BadLocationException 

      Document doc = fb.getDocument();
      StringBuilder sb = new StringBuilder();
      sb.append(doc.getText(0, doc.getLength()));
      sb.insert(offset, string);

      if (test(sb.toString())) 
         super.insertString(fb, offset, string, attr);
       else 
         // warn the user and don't allow the insert
      
   

   private boolean test(String text) 
      try 
         Integer.parseInt(text);
         return true;
       catch (NumberFormatException e) 
         return false;
      
   

   @Override
   public void replace(FilterBypass fb, int offset, int length, String text,
         AttributeSet attrs) throws BadLocationException 

      Document doc = fb.getDocument();
      StringBuilder sb = new StringBuilder();
      sb.append(doc.getText(0, doc.getLength()));
      sb.replace(offset, offset + length, text);

      if (test(sb.toString())) 
         super.replace(fb, offset, length, text, attrs);
       else 
         // warn the user and don't allow the insert
      

   

   @Override
   public void remove(FilterBypass fb, int offset, int length)
         throws BadLocationException 
      Document doc = fb.getDocument();
      StringBuilder sb = new StringBuilder();
      sb.append(doc.getText(0, doc.getLength()));
      sb.delete(offset, offset + length);

      if (test(sb.toString())) 
         super.remove(fb, offset, length);
       else 
         // warn the user and don't allow the insert
      

   

为什么这很重要？

如果用户使用复制和粘贴将数据插入到文本组件中怎么办？ KeyListener 会错过这个吗？ 您似乎希望检查数据是否可以表示 int。如果他们输入的数字数据不合适怎么办？ 如果您想允许用户稍后输入双重数据怎么办？用科学计数法？

【讨论】：

+1 也可以考虑InputVerifier。

这很酷。我已经盯着很长一段时间了，并在一个简化的应用程序中对其进行了测试。我或多或少地了解它的作用和原因（或多或少！）。不过，它给我带来了一个问题。在我的 JTextBox 上，用户按下回车键后，我调用了一些方法，我仍然使用 KeyListener 来完成这些方法。这似乎有效。但是我需要对这个文本框做的最后一件事是清除它，以便可以输入新文本。我是用 txtAnswer.setText("");但现在看来，此文档过滤器正在阻止此操作。有人可以建议吗？谢谢

@Randy：改变 test(String text) 方法。如果text.trim().isEmpty() 为真，则返回真。

感谢您的样品。它非常有用。您的示例似乎将输入限制为最多 10 位数字。你能告诉我如何增加这个吗？

我遇到了不能擦除最后一位的问题，如果你有同样的问题可以在remove函数中使用这段代码。 if(sb.toString().length() == 0) super.replace(fb, offset, length, "0", null); else if (test(sb.toString())) super.remove(fb, offset, length); else // warn the user and don't allow the insert 在我的示例中，我将其替换为 "0"，但您可以将其替换为 ""

【参考方案2】：

这是使用 keylistener 的一种方法，但使用 keyChar（而不是 keyCode）：

http://edenti.deis.unibo.it/utils/Java-tips/Validating%20numerical%20input%20in%20a%20JTextField.txt

 keyText.addKeyListener(new KeyAdapter() 
    public void keyTyped(KeyEvent e) 
      char c = e.getKeyChar();
      if (!((c >= '0') && (c <= '9') ||
         (c == KeyEvent.VK_BACK_SPACE) ||
         (c == KeyEvent.VK_DELETE))) 
        getToolkit().beep();
        e.consume();
      
    
  );

另一种方法（我个人认为这几乎与 Swing 的 JTree 模型一样过于复杂）是使用格式化文本字段：

http://docs.oracle.com/javase/tutorial/uiswing/components/formattedtextfield.html

【参考方案3】：

我曾经为此使用 Key Listener，但这种方法失败了。推荐的最佳方法是使用 DocumentFilter。下面是我创建的一种实用方法，用于构建仅输入数字的文本字段。请注意，它也需要单个“。”字符也是如此，因为它可用于十进制输入。

public static void installNumberCharacters(AbstractDocument document) 
        document.setDocumentFilter(new DocumentFilter() 
            @Override
            public void insertString(FilterBypass fb, int offset,
                    String string, AttributeSet attr)
                    throws BadLocationException 
                try 
                    if (string.equals(".")
                            && !fb.getDocument()
                                    .getText(0, fb.getDocument().getLength())
                                    .contains(".")) 
                        super.insertString(fb, offset, string, attr);
                        return;
                    
                    Double.parseDouble(string);
                    super.insertString(fb, offset, string, attr);
                 catch (Exception e) 
                    Toolkit.getDefaultToolkit().beep();
                

            

            @Override
            public void replace(FilterBypass fb, int offset, int length,
                    String text, AttributeSet attrs)
                    throws BadLocationException 
                try 
                    if (text.equals(".")
                            && !fb.getDocument()
                                    .getText(0, fb.getDocument().getLength())
                                    .contains(".")) 
                        super.insertString(fb, offset, text, attrs);
                        return;
                    
                    Double.parseDouble(text);
                    super.replace(fb, offset, length, text, attrs);
                 catch (Exception e) 
                    Toolkit.getDefaultToolkit().beep();
                
            
        );
    

【参考方案4】：

您也可以使用JFormattedTextField，使用起来要简单得多。示例：

public static void main(String[] args) 
    NumberFormat format = NumberFormat.getInstance();
    NumberFormatter formatter = new NumberFormatter(format);
    formatter.setValueClass(Integer.class);
    formatter.setMinimum(0);
    formatter.setMaximum(Integer.MAX_VALUE);
    formatter.setAllowsInvalid(false);
    // If you want the value to be committed on each keystroke instead of focus lost
    formatter.setCommitsOnValidEdit(true);
    JFormattedTextField field = new JFormattedTextField(formatter);

    JOptionPane.showMessageDialog(null, field);

    // getValue() always returns something valid
    System.out.println(field.getValue());

【讨论】：

有了这个，用户可以在字段中插入字母。

这个方法很好用，除了一件事：一旦你输入了一个数字，第一个数字就不能用退格键删除了。

@cesAR ：我通过编码自己的实现来修复它，你可以参考 Hovercraft Full Of Eels 的答案，我还在最后添加了一条评论来解决这个问题。问题在于它没有将"" 视为有效的整数/双精度..

field.setColumns(..) //对于1000以上的宽度数不能解析为整数。 （通常的方式）

我尝试了这种方法，但需要最小值=100 和最大值=300，并且设置这些会阻止字段被编辑，因为没有办法修改文本而不使其成为无效值.我进入了后处理阶段，我检查了值，如果超出范围，我会发牢骚。

【参考方案5】：

我不敢相信我还没有在堆栈溢出的任何地方找到这个简单的解决方案，它是迄今为止最有用的。更改 Document 或 DocumentFilter 不适用于 JFormattedTextField。 Peter Tseng 的回答非常接近。

NumberFormat longFormat = NumberFormat.getIntegerInstance();

NumberFormatter numberFormatter = new NumberFormatter(longFormat);
numberFormatter.setValueClass(Long.class); //optional, ensures you will always get a long value
numberFormatter.setAllowsInvalid(false); //this is the key!!
numberFormatter.setMinimum(0l); //Optional

JFormattedTextField field = new JFormattedTextField(numberFormatter);

【讨论】：

在您开始在其中输入内容后，该字段也永远不会为空（即，如果我输入 1234 并决定“实际上，我不想在此字段中输入数字”，至少 1字符将保留）。

@LeeCambl 可以通过创建 NumberFormatter 的子类来解决该问题，该子类覆盖 stringToValue(String text) 以返回空字符串的 null。

【参考方案6】：

当您在释放键后向 JtextField1 键入整数时，它将进入 try 内部，对于任何其他字符，它将抛出 NumberFormatException。如果在 catch 内将空字符串设置为 jTextField1，则用户无法键入除正数以外的任何其他键，因为每次错误尝试都会清除 JTextField1。

 //Fields 
int x;
JTextField jTextField1;

 //Gui Code Here

private void jTextField1KeyReleased(java.awt.event.KeyEvent evt)                                         
    try 
        x = Integer.parseInt(jTextField1.getText());
     catch (NumberFormatException nfe) 
        jTextField1.setText("");