Класс 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 в пакет java.beans добавлена поддержка долгосрочного хранения всех JavaBeans. См. XMLEncoder.