Класс MaskFormatter

public class MaskFormatter
extends DefaultFormatter

Класс MaskFormatter используется для форматирования и редактирования строк. Поведение MaskFormatter контролируется с помощью маски-строки, которая определяет допустимые символы, которые могут быть содержаться в определенной позиции в модели Document. Доступные символы:

Символ	Описание
#	Любая цифра, используется Character.isDigit.
'	Символ экранирования, используется для экранирования специальных символов форматирования.
U	Любой символ (Character.isLetter). Все строчные буквы преобразуются в заглавные.
L	Любой символ (Character.isLetter). Все заглавные буквы преобразуются в строчные.
A	Любой символ или цифра (Character.isLetter или Character.isDigit).
?	Любой символ (Character.isLetter).
*	Любой символ.
H	Любой шестнадцатеричный символ (0-9, a-f или A-F).

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

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

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

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

MaskFormatter formatter = new MaskFormatter("###-####");
   formatter.setPlaceholderCharacter('_');
   formatter.getDisplayValue(tf, "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, поддержка долгосрочного хранения всех JavaBeans™ была добавлена в пакет java.beans. См. XMLEncoder.