Aller au contenu principal

MaskedTextField

Ouvrir dans ChatGPT
Shadow dwc-textfield 24.10
Java API

Le composant MaskedTextField vise à fournir une entrée de texte configurable et facilement validable. Il est bien adapté pour les applications nécessitant une entrée formatée, telles que les applications financières, 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 du 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 garantit une entrée 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.

Caractères de masque pris en charge

CaractèreDescription
XTout caractère imprimable
aTout caractère alphabétique (majuscule ou minuscule)
ATout caractère alphabétique ; les lettres minuscules sont converties en majuscules
0Tout chiffre (0–9)
zTout chiffre ou lettre (majuscule ou minuscule)
ZTout chiffre ou lettre ; les lettres minuscules sont converties en majuscules

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

  • Les caractères invalides sont silencieusement ignorés.
  • Les entrées courtes sont complétées par des espaces.
  • Les longues entrées sont tronquées pour s'ajuster 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, permettant toute saisie imprimable. C'est utile lorsque vous souhaitez réserver la possibilité de formatage sans appliquer de règles strictes sur les caractères.

Afficher le code

Modèles de validation

Alors 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 utilisant des 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}"); // Impose un code alphanumérique de 10 caractères

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

Ceci est particulièrement utile lorsque :

  • Le masque permet trop de flexibilité
  • Vous souhaitez imposer une longueur exacte ou un format spécifique (par exemple, hex, Base64, UUID)
Format d'expression régulière

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

Restauration de la valeur

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

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

Façons de restaurer la valeur

  • Programmatique, 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 reviendra à la valeur initiale au moment où il a été rendu.

Afficher le code

MaskedTextFieldSpinner

Le MaskedTextFieldSpinner étend MaskedTextField en ajoutant des contrôles de spinner qui permettent aux utilisateurs de parcourir une liste de valeurs prédéfinies. Cela améliore l'expérience utilisateur dans les situations où l'entrée doit être contrainte à un ensemble fixe d'options valides.

Afficher le code

Fonctionnalités clés

  • Prise en charge de la liste d'options
    Remplissez le spinner avec une liste de valeurs de chaîne valides en utilisant setOptions() :

    spinner.setOptions(List.of("Option A", "Option B", "Option C"));
  • Spinning programmatique
    Utilisez spinUp() et spinDown() pour parcourir les options :

    spinner.spinUp();   // Sélectionne l'option suivante
    spinner.spinDown(); // Sélectionne l'option précédente
  • Contrôle de l'index
    Définissez ou récupérez l'index de sélection actuel avec :

    spinner.setOptionIndex(1);
    int current = spinner.getOptionIndex();
  • Compatibilité du masque
    Hérite pleinement de tout le formatage, des règles de masque et de la validation de modèle de MaskedTextField.

Style

Loading...