Класс MaskFormatter

Обычно символы соответствуют одному символу, но в некоторых языках это не так. Маска применяется к каждому символу, поэтому она будет подстраиваться, чтобы вместить необходимое количество символов.

Можно дополнительно ограничить вводимые символы с помощью методов setInvalidCharacters и setValidCharacters. Метод setInvalidCharacters позволяет указать недопустимые символы. Метод setValidCharacters позволяет указать допустимые символы. Например, следующий фрагмент кода эквивалентен маске '0xHHH' без указания недопустимых или допустимых символов:

MaskFormatter formatter = new MaskFormatter("0x***");
formatter.setValidCharacters("0123456789abcdefABCDEF");

При первоначальном форматировании значения, если длина строки меньше длины маски, возможно два варианта. Будет использована либо строка-заполнитель, либо символ-заполнитель. Приоритет отдается строке-заполнителю. Например:

  MaskFormatter formatter = new MaskFormatter("###-####");
  formatter.setPlaceholderCharacter('_');
  System.out.println(formatter.valueToString("123"));

В результате получится строка '123-____'. Если вызвать setPlaceholder("555-1212"), результатом будет '123-1212'. Строка-заполнитель используется только при первоначальном форматировании, при последующих форматированиях используется только символ-заполнитель.

Если MaskFormatter настроен так, чтобы допускать только допустимые символы (setAllowsInvalid(false)), при редактировании буквальные символы будут пропускаться по мере необходимости. Рассмотрим MaskFormatter с маской "###-####" и текущим значением "555-1212". Перемещение по полю клавишей со стрелкой вправо приведет к следующему результату (| обозначает положение курсора):

  |555-1212
  5|55-1212
  55|5-1212
  555-|1212
  555-1|212

При редактировании действует аналогичное поведение. Рассмотрим вставку строк '123-45' и '12345' в MaskFormatter из предыдущего примера. В обоих случаях получится одна и та же строка: '123-45__'. При обработке MaskFormatter вставки в позицию символа 3 ('-') возможно два варианта:

1. Если вставляемый символ — '-', он принимается.
2. Если вставляемый символ соответствует маске для следующего небуквального символа, он принимается в новой позиции.
3. В противном случае редактирование считается недопустимым.

По умолчанию MaskFormatter не допускает недопустимые изменения. Это поведение можно изменить методом setAllowsInvalid. Допустимые изменения фиксируются (изменить это поведение можно с помощью setCommitsOnValidEdit).

По умолчанию MaskFormatter работает в режиме перезаписи. То есть при вводе символов новый символ не вставляется, а заменяет символ в текущей позиции. Это поведение можно изменить с помощью метода setOverwriteMode.

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