JSpinnerで無効な値の入力を許可しない

Total: 9920, Today: 3, Yesterday: 4
Posted by at
Last-modified:

概要

JSpinnerからJFormattedTextFieldを取得し、これに無効な値の入力を許可しないように設定します。

Screenshot

screenshot

Download

サンプルコード

JSpinner spinner = new JSpinner(makeSpinnerNumberModel());
JSpinner.DefaultEditor editor =
    (JSpinner.DefaultEditor) spinner.getEditor();
JFormattedTextField.AbstractFormatter formatter =
    editor.getTextField().getFormatter();
if (formatter instanceof DefaultFormatter) {
  ((DefaultFormatter) formatter).setAllowsInvalid(false);
}
View in GitHub: Java, Kotlin

解説

上記のサンプルでは、DefaultFormatter#setAllowsInvalid(false)などを設定したDefaultFormatterFactoryを作成して、JSpinnerから取得したJFormattedTextFieldにsetFormatterFactory(...)メソッドで追加しています。

  • 上
    • SpinnerNumberModelを設定した通常のJSpinner
    • 別コンポーネントにフォーカスが移動するときに値が有効か無効かを判断
  • 中
    • SpinnerNumberModelを設定し数値以外の無効な文字入力ができないようにしたJSpinner
  • 下
    • SpinnerNumberModelを設定した通常のJSpinner
    • 別コンポーネントにフォーカスが移動するときに値が有効か無効かを判断
    • 無効な値の場合は背景色を変更
private static JSpinner makeSpinner2(SpinnerNumberModel m) {
  JSpinner s = new JSpinner(m);
  JSpinner.NumberEditor editor = (JSpinner.NumberEditor) s.getEditor();
  JFormattedTextField ftf = (JFormattedTextField) editor.getTextField();
  ftf.setFormatterFactory(makeFFactory(m));
  ftf.getDocument().addDocumentListener(new DocumentListener() {
    private final Color color = new Color(255, 200, 200);
    @Override public void changedUpdate(DocumentEvent e) {
      updateEditValid();
    }

    @Override public void insertUpdate(DocumentEvent e) {
      updateEditValid();
    }

    @Override public void removeUpdate(DocumentEvent e) {
      updateEditValid();
    }

    private void updateEditValid() {
      EventQueue.invokeLater(new Runnable() {
        @Override public void run() {
          ftf.setBackground(ftf.isEditValid() ? Color.WHITE : color);
        }
      });
    }
  });
  return s;
}

private static DefaultFormatterFactory makeFFactory(SpinnerNumberModel m) {
  NumberFormat format = new DecimalFormat("####0");
  NumberFormatter displayFormatter = new NumberFormatter(format);
  NumberFormatter editFormatter = new NumberFormatter(format) {
    @Override public Object stringToValue(String text)
        throws ParseException {
      try {
        Long.parseLong(text);
      } catch (NumberFormatException e) {
        throw (ParseException) new ParseException(
            ex.getMessage(), 0).initCause(ex);
      }
      Object o = format.parse(text);
      if (o instanceof Long) {
        Long val = (Long) format.parse(text);
        Long max = (Long) m.getMaximum();
        Long min = (Long) m.getMinimum();
        if (max.compareTo(val) < 0 || min.compareTo(val) > 0) {
          throw new ParseException("out of bounds", 0);
        }
        return val;
      }
      throw new ParseException("not Long", 0);
    }
  };
  // editFormatter.setAllowsInvalid(false);
  // editFormatter.setCommitsOnValidEdit(true);
  editFormatter.setValueClass(Long.class);
  return new DefaultFormatterFactory(
      displayFormatter, displayFormatter, editFormatter);
}
  • プリミティブ型longを使用してnew SpinnerNumberModel(10L, 0L, 99_999L, 1L)のようにSpinnerNumberModelを作成するとClassCastExceptionが発生するようになった？
java.lang.ClassCastException: class java.lang.Double cannot be cast to class java.lang.Long
(java.lang.Double and java.lang.Long are in module java.base of loader 'bootstrap')
at example.MainPanel$2.stringToValue(MainPanel.java:80)
at java.desktop/javax.swing.JFormattedTextField.commitEdit(JFormattedTextField.java:563)
  • Long型のオブジェクトを使用するよう修正
private static SpinnerNumberModel makeSpinnerNumberModel() {
  Long value = 10L;
  Long minimum = 0L;
  Long maximum = 99_999L;
  Long stepSize = 1L;
  return new SpinnerNumberModel(value, minimum, maximum, stepSize);
}

参考リンク

コメント