Zum Hauptinhalt springen

MaskedTextField

ChatGPT öffnen
Shadow dwc-textfield 24.10
Java API

Die MaskedTextField-Komponente zielt darauf ab, eine konfigurierbare und einfach validierbare Texteingabe bereitzustellen. Sie eignet sich gut für Apps, die formatierten Input benötigen, wie z. B. Finanz-, E-Commerce- und Gesundheitsanwendungen.

Grundlagen

Die MaskedTextField kann mit oder ohne Parameter instanziiert werden. Sie können einen Anfangswert, eine Beschriftung, einen Platzhaltertext und einen Listener definieren, falls sich der Wert ändert.

MaskedTextField field = new MaskedTextField("Konto-ID");
field.setMask("ZZZZ-0000")
.setHelperText("Maske: ZZZZ-0000 - zum Beispiel: SAVE-2025")

Maskenregeln

Die MaskedTextField formatiert die Texteingabe mit Hilfe einer Maske - einer Zeichenkette, die definiert, welche Zeichen an jeder Position erlaubt sind. Dies gewährleistet eine konsistente, strukturierte Eingabe für Dinge wie Telefonnummern, Postleitzahlen und ID-Formate.

Unterstützte Maskenzeichen

ZeichenBeschreibung
XJedes druckbare Zeichen
aJedes alphabetische Zeichen (Groß- oder Kleinbuchstaben)
AJedes alphabetische Zeichen; Kleinbuchstaben werden in Großbuchstaben umgewandelt
0Jede Ziffer (0–9)
zJede Ziffer oder Buchstabe (Groß- oder Kleinbuchstaben)
ZJede Ziffer oder Buchstabe; Kleinbuchstaben werden in Großbuchstaben umgewandelt

Alle anderen Zeichen in der Maske werden als Literale behandelt und müssen genau eingegeben werden. Zum Beispiel erfordert eine Maske wie XX@XX, dass der Benutzer ein @ in der Mitte eingibt.

  • Ungültige Zeichen werden stillschweigend ignoriert.
  • Kurze Eingaben werden mit Leerzeichen aufgefüllt.
  • Lange Eingaben werden gekürzt, um in die Maske zu passen.

Beispiele

field.setMask("(000) 000-0000");     // Beispiel: (123) 456-7890
field.setMask("A00 000"); // Beispiel: A1B 2C3 (kanadische Postleitzahl)
field.setMask("ZZZZ-0000"); // Beispiel: ABCD-1234
field.setMask("0000-0000-0000-0000");// Beispiel: 1234-5678-9012-3456
Vollständige Eingabe erlaubt

Wenn die Maske nur X enthält, verhält sich das Feld wie ein Standard-TextField und erlaubt jede druckbare Eingabe. Dies ist nützlich, wenn Sie die Möglichkeit der Formatierung reservieren möchten, ohne strenge Zeichenregeln anzuwenden.

Code anzeigen

Validierungsmuster

Während Masken die Struktur der Eingabe definieren, können Sie sie mit Validierungsmustern kombinieren, um spezifischere Eingaberegeln zu erzwingen. Dies fügt eine zusätzliche Schicht der clientseitigen Validierung mithilfe von regulären Ausdrücken hinzu.

Verwenden Sie die Methode setPattern(), um einen benutzerdefinierten regulären Ausdruck anzuwenden:

field.setPattern("[A-Za-z0-9]{10}"); // Erzwingt einen 10-stelligen alphanumerischen Code

Dies stellt sicher, dass die Eingabe nicht nur mit der Maske übereinstimmt, sondern auch einer definierten Struktur, wie Länge oder erlaubte Zeichen, entspricht.

Dies ist besonders nützlich, wenn:

  • Die Maske zu viel Flexibilität zulässt
  • Sie eine exakte Länge oder ein bestimmtes Format (z. B. Hex, Base64, UUID) erzwingen möchten
Format des regulären Ausdrucks

Das Muster muss ein gültiger JavaScript-regulärer Ausdruck sein, wie er vom Typ RegExp verwendet wird. Weitere Details finden Sie in der Dokumentation zum HTML-Musterattribut.

Wiederherstellung des Wertes

Die MaskedTextField umfasst eine Wiederherstellungsfunktion, die den Wert des Feldes auf einen vordefinierten oder ursprünglichen Zustand zurücksetzt. Dies kann nützlich sein, um Benutzeränderungen rückgängig zu machen oder zu einer Standard eingabe zurückzukehren.

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

Möglichkeiten, den Wert wiederherzustellen

  • Programmgesteuert, durch Aufruf von restoreValue()
  • Über die Tastatur, indem ESC gedrückt wird (dies ist die Standard-Wiederherstelltaste, es sei denn, sie wird von einem Ereignis-Listener überschrieben)

Sie können den Wert, der wiederhergestellt werden soll, mit setRestoreValue() festlegen. Wenn kein Wiederherstellungswert festgelegt ist, wird das Feld auf den Anfangswert zum Zeitpunkt der Darstellung zurückgesetzt.

Code anzeigen

MaskedTextFieldSpinner

Die MaskedTextFieldSpinner erweitert MaskedTextField um Spinner-Steuerelemente, die es Benutzern ermöglichen, durch eine Liste vordefinierter Werte zu blättern. Dies verbessert die Benutzererfahrung in Situationen, in denen die Eingabe auf eine feste Menge gültiger Optionen beschränkt sein sollte.

Code anzeigen

Hauptmerkmale

  • Unterstützung der Optionsliste
    Füllen Sie den Spinner mit einer Liste gültiger Zeichenfolgenwerte mithilfe von setOptions():

    spinner.setOptions(List.of("Option A", "Option B", "Option C"));
  • Programmgesteuertes Drehen
    Verwenden Sie spinUp() und spinDown(), um durch die Optionen zu navigieren:

    spinner.spinUp();   // Wählt die nächste Option aus
    spinner.spinDown(); // Wählt die vorherige Option aus
  • Indexkontrolle
    Setzen oder rufen Sie den aktuellen Auswahlindex mit:

    spinner.setOptionIndex(1);
    int current = spinner.getOptionIndex();
  • Maskenkompatibilität
    Übernimmt alle Formatierungs-, Maskenregeln und Mustervalidierungen von MaskedTextField.

Styling

Loading...