Класс 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.