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