MaskedTextField

El componente MaskedTextField proporciona un campo de texto configurable que impone reglas de formato y validación. Es ideal para aplicaciones que requieren entradas estructuradas, como sistemas financieros, de comercio electrónico y de salud.

Basics

El MaskedTextField se puede instanciar con o sin parámetros. Puedes definir un valor inicial, una etiqueta, un texto de marcador de posición y un listener en caso de que cambie el valor.

MaskedTextField field = new MaskedTextField("ID de Cuenta");
field.setMask("ZZZZ-0000")
  .setHelperText("Máscara: ZZZZ-0000 - por ejemplo: SAVE-2025")

Mask rules

El MaskedTextField formatea las entradas de texto utilizando una máscara: una cadena que define qué caracteres están permitidos en cada posición. Esto garantiza una entrada consistente y estructurada para cosas como números de teléfono, códigos postales y formatos de ID.

Aplicando máscaras programáticamente

Para formatear cadenas con la misma sintaxis de máscara fuera de un campo, por ejemplo, al renderizar datos en una Table, utiliza la clase utilitaria MaskDecorator.

Supported mask characters

Character	Description
`X`	Cualquier carácter imprimible
`a`	Cualquier carácter alfabético (mayúscula o minúscula)
`A`	Cualquier carácter alfabético; las letras minúsculas se convierten a mayúsculas
`0`	Cualquier dígito (0–9)
`z`	Cualquier dígito o letra (mayúscula o minúscula)
`Z`	Cualquier dígito o letra; las letras minúsculas se convierten a mayúsculas

Todos los demás caracteres en la máscara se tratan como literales y deben ser escritos exactamente. Por ejemplo, una máscara como XX@XX requiere que el usuario ingresen un @ en el medio.

Los caracteres no válidos se ignoran silenciosamente.
La entrada corta se completa con espacios.
La entrada larga se trunca para ajustarse a la máscara.

Examples

field.setMask("(000) 000-0000");     // Ejemplo: (123) 456-7890
field.setMask("A00 000");            // Ejemplo: A1B 2C3 (código postal canadiense)
field.setMask("ZZZZ-0000");          // Ejemplo: ABCD-1234
field.setMask("0000-0000-0000-0000");// Ejemplo: 1234-5678-9012-3456

Se Permite Entrada Completa

Si la máscara solo contiene X, el campo se comporta como un TextField estándar, permitiendo cualquier entrada imprimible. Esto es útil cuando deseas reservar la capacidad de formatear sin aplicar reglas estrictas de caracteres.

Mostrar Código

MaskedTextFieldView.java

Validation patterns

Mientras que las máscaras definen la estructura de la entrada, puedes combinarlas con patrones de validación para imponer reglas de entrada más específicas. Esto agrega una capa adicional de validación del lado del cliente utilizando expresiones regulares.

Utiliza el método setPattern() para aplicar una expresión regular personalizada:

field.setPattern("[A-Za-z0-9]{10}"); // Impone un código alfanumérico de 10 caracteres

Esto asegura que la entrada no solo coincida con la máscara, sino que también se ajuste a una estructura definida, como longitud o caracteres permitidos.

Esto es especialmente útil cuando:

La máscara permite demasiada flexibilidad
Quieres imponer una longitud exacta o un formato específico (por ejemplo, hex, Base64, UUID)

Formato de Expresión Regular

El patrón debe ser una expresión regular válida de JavaScript, como las utilizadas por el tipo RegExp. Puedes encontrar más detalles en la documentación del atributo pattern de HTML.

Restoring the value

El MaskedTextField incluye una función de restauración que restablece el valor del campo a un estado predefinido u original. Esto puede ser útil para deshacer cambios realizados por el usuario o volver a una entrada predeterminada.

field.setRestoreValue("ABC123");
field.restoreValue();

Ways to restore the value

Programáticamente, llamando a restoreValue()
A través del teclado, presionando ESC (esta es la tecla de restauración predeterminada a menos que se sobrescriba por un listener de eventos)

Puedes establecer el valor a restaurar con setRestoreValue(). Si no se establece ningún valor de restauración, el campo volverá al valor inicial en el momento en que se renderizó.

Mostrar Código

MaskedTextFieldRestoreView.java