MaskedTextField

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

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

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

Reglas de máscara

El MaskedTextField formatea la entrada de texto utilizando una máscara, que es una cadena que define qué caracteres son 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 identificación.

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 de utilidad MaskDecorator.

Caracteres de máscara soportados

Carácter	Descripción
`X`	Cualquier carácter imprimible
`a`	Cualquier carácter alfabético (mayúsculas o minúsculas)
`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úsculas o minúsculas)
`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 escribirse exactamente. Por ejemplo, una máscara como XX@XX requiere que el usuario ingrese un @ en el medio.

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

Ejemplos

field.setMask("(000) 000-0000");     // Ejemplo: (123) 456-7890
field.setMask("A0A 0A0");            // 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

Entrada completa permitida

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.

Patrones de validación

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 se utiliza en el tipo RegExp. Puedes encontrar más detalles en la documentación del atributo de patrón de HTML.

Restaurando el valor

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();

Maneras de restaurar el valor

Programáticamente, llamando a restoreValue()
Vía teclado, presionando ESC (esta es la tecla de restauración predeterminada a menos que se sobreescriba mediante un oyente de eventos)

Puedes establecer el valor a restaurar con setRestoreValue(). Si no se establece un valor de restauración, tanto restoreValue() como ESC establecen el valor del campo en null.