Die Schnittstelle zur Interaktion mit dem Formularvalidator. Kann etwa genutzt werden, um auf verschiedene Ereignisse während der Validationsphase zu lauschen.

Hierarchy

  • XmValidator

Index

Methods

_getVal

  • _getVal(item: JQuery, type: string): unknown
  • Findet den Wert des gegebenen Formularelements, unabhängig von seinem Typ. Der zurückgelieferte Wert hängt vom Typ des Element ab.

    deprecated

    Dies ist eine interne Methode.

    Parameters

    • item: JQuery

      Formularelement, dessen Wert ermitteln werden soll.

    • type: string

      Typ des Formularelements. In der Regel entweder der tagName oder der type des input-Elements.

    Returns unknown

findAllPotentialReferences

  • Findet alle (potentiellen) Verweise auf die angegebenen Elemente. Die angegebenen Elemente selbst werden nicht in das zurückgegebenen Ergebnis enthalten.

    Referenzen sind zum Beispiel Elemente, die eine hidden-if, read-only-if oder required-if Bedingung auf eines der gegebenen Elemente haben.

    Parameters

    • elements: string | HTMLElement | HTMLElement[] | JQuery

      Elemente, für die Referenzen gesucht werden sollen.

    • Optional opts: XmValidatorFindReferencesOptions

      Optionen für die zu suchenden Elemente. Standardmäßig werden alle bekannten Referenzen gefunden.

    Returns JQuery

    Alle gefundenen Referenzen.

off

  • off<K>(event: K, eventCallback: XmValidatorCallbacks[K]): void
  • Entfernt eine Rückruffunktion, die mittels on hinzugefügt wurde.

    typeparam

    Type des Namens des Ereignisses, auf das nicht mehr gelauscht werden soll.

    Type parameters

    • K: keyof XmValidatorCallbacks

      Type of the event name for which to remove a listener.

    Parameters

    • event: K

      Name des Ereignisses, auf das nicht mher gelauscht werden soll.

    • eventCallback: XmValidatorCallbacks[K]

      Rückruffunktion für das Ereignis, welche entfernt werden soll.

    Returns void

on

  • on<K>(event: K, eventCallback: XmValidatorCallbacks[K]): void
  • Dient der Registrierung einer Rückruffunktion für Ereignisse, die während der Formularvalidationsphase eintreten.

    Die folgenden Ereignisse stehen zur Verfügung:

    • requestBegin: Wenn eine Formularvalidierung angefragt wurce, bevor Elementzustände aktualisiert werden wie Versteckt-Wenn-Bedingungen.
    • begin: Wenn eine Validationsphase beginnt.
    • progress: Wenn die Validierung fortschreitet, d.h. immer dann, wenn ein einzelnes Formularfeld fertig validiert wurde. Eine Validationsphase besteht aus der Validierung einer Menge von Elementen, möglicherweise des ganzen Formulars.
    • finish: Wenn eine Validationsphase endet.
    • requestFinish: Wenn eine Formularvalidierungsanfrage abgearbeitet wurde.
    // Gibt ein Log-Meldung aus, wenn das entsprechende Ereignis eingetreten ist
    xm_validator.on("requestBegin", data => console.log("validate-request", data));
    xm_validator.on("begin", data => console.log("validate-start", data));
    xm_validator.on("progress", data => console.log("progress", data));
    xm_validator.on("finish", data => console.log("validate-end", data));
    xm_validator.on("requestFinish", data => console.log("validate-finish", data));

    Type parameters

    • K: keyof XmValidatorCallbacks

      Type des Namens des Ereignisses, auf das gelauscht werden soll.

    Parameters

    • event: K

      Name des Ereignisses, auf das gelauscht werden soll.

    • eventCallback: XmValidatorCallbacks[K]

      Rückruffunktion für das Ereignis.

    Returns void

setAnimateScrollToError

  • setAnimateScrollToError(animate: boolean): void
  • Wenn ein Formular abgesendet wird und das Formular nicht gültig ist, wird die Bildlaufleiste so geschoben, dass das ungültige Feld im Browser-Fenster sichtbar wird. Standardmäßig wird diese Verschiebung animiert. Mithilfe dieser Methode kann die Animation deaktiviert werden.

    Parameters

    • animate: boolean

      Ob das Verschieben der Bildlaufleiste animiert werden soll.

    Returns void

updateValidationState

  • updateValidationState(base: JQuery, forceUpdate?: boolean): void
  • Aktualisiert den Elementzustand (etwa Versteckt-Wenn-Bedingungen) für alle Elemente.

    Parameters

    • base: JQuery

      Zu aktualisierende Elemente.

    • Optional forceUpdate: boolean

      Falls true, werden Elementzustände aktualisiert auch wenn es keine Änderung gab.

    Returns void