formcycle 8.3.6 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle XmValidator

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

    interface XmValidator {
        _getVal(item: JQuery, type: string): unknown;
        findAllPotentialReferences(
            elements: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[],
            opts?: XmValidatorFindReferencesOptions,
        ): JQuery;
        off<K extends keyof XmValidatorCallbacks>(
            event: K,
            eventCallback: XmValidatorCallbacks[K],
        ): void;
        on<K extends keyof XmValidatorCallbacks>(
            event: K,
            eventCallback: XmValidatorCallbacks[K],
        ): void;
        setAnimateScrollToError(animate: boolean): void;
        updateValidationState(base: JQuery, forceUpdate?: boolean): void;
    }
    Index

    Methoden

    _getVal findAllPotentialReferences off on setAnimateScrollToError updateValidationState

    Methoden

    _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.

      Parameter

      • 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.

      Rückgabewert unknown

      Dies ist eine interne Methode.

    • 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.

      Parameter

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

        Elemente, für die Referenzen gesucht werden sollen.

      • Optionalopts: XmValidatorFindReferencesOptions

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

      Rückgabewert JQuery

      Alle gefundenen Referenzen.

    • Entfernt eine Rückruffunktion, die mittels on hinzugefügt wurde.

      Typenparameter

      • K extends keyof XmValidatorCallbacks

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

      Parameter

      • 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.

      Rückgabewert 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));

      Typenparameter

      • K extends keyof XmValidatorCallbacks

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

      Parameter

      • event: K

        Name des Ereignisses, auf das gelauscht werden soll.

      • eventCallback: XmValidatorCallbacks[K]

        Rückruffunktion für das Ereignis.

      Rückgabewert 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.

      Parameter

      • animate: boolean

        Ob das Verschieben der Bildlaufleiste animiert werden soll.

      Rückgabewert void

    • Aktualisiert den Elementzustand (etwa Versteckt-Wenn-Bedingungen) für alle Elemente.

      Parameter

      • base: JQuery

        Zu aktualisierende Elemente.

      • OptionalforceUpdate: boolean

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

      Rückgabewert void

    Einstellungen

    Member-Sichtbarkeit

    Auf dieser Seite

    Methoden