MaskedTextField

Le composant MaskedTextField fournit une entrée de texte configurable qui impose des règles de formatage et de validation. Il est bien adapté aux applications nécessitant une saisie structurée, telles que les systèmes financiers, de commerce électronique et de santé.

Bases

Le MaskedTextField peut être instancié avec ou sans paramètres. Vous pouvez définir une valeur initiale, une étiquette, un texte d'espace réservé et un écouteur en cas de changement de valeur.

MaskedTextField field = new MaskedTextField("ID de compte");
field.setMask("ZZZZ-0000")
  .setHelperText("Masque : ZZZZ-0000 - par exemple : SAVE-2025")

Règles de masque

Le MaskedTextField formate l'entrée de texte à l'aide d'un masque - une chaîne qui définit quels caractères sont autorisés à chaque position. Cela assure une saisie cohérente et structurée pour des éléments tels que les numéros de téléphone, les codes postaux et les formats d'identification.

Application de masques par programme

Pour formater des chaînes avec la même syntaxe de masque en dehors d'un champ, par exemple lors de l'affichage de données dans un Table, utilisez la classe utilitaire MaskDecorator.

Caractères de masque pris en charge

Caractère	Description
`X`	Tout caractère imprimable
`a`	Tout caractère alphabétique (majuscule ou minuscule)
`A`	Tout caractère alphabétique ; les lettres minuscules sont converties en majuscules
`0`	Tout chiffre (0–9)
`z`	Tout chiffre ou lettre (majuscule ou minuscule)
`Z`	Tout chiffre ou lettre ; les lettres minuscules sont converties en majuscules

Tous les autres caractères dans le masque sont traités comme des littéraux et doivent être saisis exactement. Par exemple, un masque comme XX@XX exige que l'utilisateur saisisse un @ au milieu.

Les caractères invalides sont ignorés silencieusement.
Les entrées courtes sont complétées par des espaces.
Les entrées longues sont tronquées pour s'adapter au masque.

Exemples

field.setMask("(000) 000-0000");     // Exemple : (123) 456-7890
field.setMask("A00 000");            // Exemple : A1B 2C3 (code postal canadien)
field.setMask("ZZZZ-0000");          // Exemple : ABCD-1234
field.setMask("0000-0000-0000-0000");// Exemple : 1234-5678-9012-3456

Entrée complète autorisée

Si le masque ne contient que X, le champ se comporte comme un TextField standard, permettant toute entrée imprimable. Ceci est utile lorsque vous souhaitez réserver la possibilité de formater sans appliquer de règles strictes de caractères.

Afficher le code

MaskedTextFieldView.java

Modèles de validation

Bien que les masques définissent la structure de l'entrée, vous pouvez les combiner avec des modèles de validation pour imposer des règles d'entrée plus spécifiques. Cela ajoute une couche supplémentaire de validation côté client à l'aide d'expressions régulières.

Utilisez la méthode setPattern() pour appliquer une expression régulière personnalisée :

field.setPattern("[A-Za-z0-9]{10}"); // Imposera un code alphanumérique de 10 caractères

Cela garantit que l'entrée correspond non seulement au masque, mais se conforme également à une structure définie, telle que la longueur ou les caractères autorisés.

Cela est particulièrement utile lorsque :

Le masque permet trop de flexibilité
Vous souhaitez imposer une longueur exacte ou un format spécifique (ex. hex, Base64, UUID)

Format d'expression régulière

Le modèle doit être une expression régulière JavaScript valide, comme utilisé par le type RegExp. Vous pouvez trouver plus de détails dans la documentation de l'attribut HTML pattern.

Restauration de la valeur

Le MaskedTextField comprend une fonction de restauration qui réinitialise la valeur du champ à un état prédéfini ou d'origine. Cela peut être utile pour annuler des modifications utilisateur ou revenir à une entrée par défaut.

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

Façons de restaurer la valeur

Par programme, en appelant restoreValue()
Via le clavier, en appuyant sur ESC (c'est la touche de restauration par défaut à moins d'être remplacée par un écouteur d'événements)

Vous pouvez définir la valeur à restaurer avec setRestoreValue(). Si aucune valeur de restauration n'est définie, le champ revertira à la valeur initiale au moment de son rendu.

Afficher le code

MaskedTextFieldRestoreView.java