Класс JFormattedTextField

@JavaBean public class JFormattedTextField extends JTextField

JFormattedTextField расширяет JTextField, добавляя поддержку форматирования произвольных значений, а также получения конкретного объекта после редактирования текста пользователем. Следующий пример демонстрирует конфигурацию JFormattedTextField для редактирования дат:

   JFormattedTextField ftf = new JFormattedTextField();
   ftf.setValue(new Date());
 

После создания JFormattedTextField, можно прослушивать изменения редактирования, добавив PropertyChangeListener и прослушивая PropertyChangeEvent с именем свойства value.

JFormattedTextField позволяет настроить действия при потере фокуса. Возможные конфигурации:

Возможные конфигурации JFormattedTextField и их описания

Значение	Описание
JFormattedTextField.REVERT	Возврат отображения к значению getValue, возможно с потерей текущего редактирования.
JFormattedTextField.COMMIT	Сохраняет текущее значение. Если редактируемое значение не является допустимым значением для AbstractFormatter, то есть возникает ParseException, значение не изменится, и отредактированное значение сохранится.
JFormattedTextField.COMMIT_OR_REVERT	Аналогично COMMIT, но если значение не является допустимым, ведет себя как REVERT.
JFormattedTextField.PERSIST	Не выполнять никаких действий, не получать новое значение AbstractFormatter, и не обновлять значение.

По умолчанию используется JFormattedTextField.COMMIT_OR_REVERT, см. setFocusLostBehavior(int) для получения дополнительной информации.

JFormattedTextField позволяет покинуть фокус, даже если текущее редактируемое значение некорректно. Чтобы заблокировать фокус, пока JFormattedTextField находится в состоянии некорректного редактирования, можно добавить InputVerifier. Следующий фрагмент кода показывает потенциальную реализацию такого InputVerifier:

 public class FormattedTextFieldVerifier extends InputVerifier {
     public boolean verify(JComponent input) {
         if (input instanceof JFormattedTextField) {
             JFormattedTextField ftf = (JFormattedTextField)input;
             AbstractFormatter formatter = ftf.getFormatter();
             if (formatter != null) {
                 String text = ftf.getText();
                 try {
                      formatter.stringToValue(text);
                      return true;
                  } catch (ParseException pe) {
                      return false;
                  }
              }
          }
          return true;
      }
      public boolean shouldYieldFocus(JComponent input) {
          return verify(input);
      }
  }
 

В качестве альтернативы, можно вызвать commitEdit, что также сохранит значение.

JFormattedTextField не выполняет форматирование самостоятельно, а вместо этого форматирование выполняется экземпляром JFormattedTextField.AbstractFormatter, который получается из экземпляра JFormattedTextField.AbstractFormatterFactory. Экземпляры JFormattedTextField.AbstractFormatter уведомляются о переходе в активное состояние методом install, в этот момент JFormattedTextField.AbstractFormatter может установить все необходимые компоненты, обычно это DocumentFilter. Аналогично, когда JFormattedTextField больше не нуждается в AbstractFormatter, он вызовет uninstall.

JFormattedTextField обычно запрашивает у AbstractFormatterFactory AbstractFormat при получении или потере фокуса. Хотя это может меняться в зависимости от политики потери фокуса. Если политика потери фокуса JFormattedTextField.PERSIST и JFormattedTextField был отредактирован, AbstractFormatterFactory не будет запрошен, пока значение не будет сохранено. Аналогично, если политика потери фокуса JFormattedTextField.COMMIT и stringToValue выбросил исключение, AbstractFormatterFactory не будет запрошен при потере или получении фокуса.

JFormattedTextField.AbstractFormatter также отвечает за определение момента, когда значения сохраняются в JFormattedTextField. Некоторые JFormattedTextField.AbstractFormatter делают новые значения доступными при каждом изменении, а другие никогда не сохраняют значение. Вы можете принудительно получить текущее значение из текущего JFormattedTextField.AbstractFormatter, вызвав commitEdit. commitEdit вызывается каждый раз при нажатии клавиши Enter в JFormattedTextField.

Если AbstractFormatterFactory не задан явно, он будет задан на основе типа значения Class после вызова setValue (при условии, что значение не null). Например, в приведенном коде будут созданы соответствующие AbstractFormatterFactory и AbstractFormatter для обработки форматирования чисел:

   JFormattedTextField tf = new JFormattedTextField();
   tf.setValue(100);
 

Предупреждение: Поскольку AbstractFormatter обычно устанавливает DocumentFilter на Document, и NavigationFilter на JFormattedTextField, вы не должны устанавливать свой собственный. В противном случае, вы можете столкнуться с непредсказуемым поведением, так как политика редактирования AbstractFormatter не будет соблюдаться.

Предупреждение: Swing не потокобезопасен. Для получения дополнительной информации см. Политика потоков Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans была добавлена в пакет java.beans. См. XMLEncoder.