Interface XmValidator

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

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.

    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

on

  • on(event: "start" | "progress" | "end", eventCallback: function): void

  • Dient der Registrierung einer Rückruffunktion für Ereignisse, die während der Formularvalidationsphase eintreten.

    Die folgenden Ereignisse stehen zur Verfügung:

    • start: 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.
    • end: Wenn eine Validationsphase endet.
    // Gibt ein Log-Meldung aus, wenn das entsprechende Ereignis eingetreten ist
xm_validator.on("start", function(data) { console.log('validate-start', data); });
xm_validator.on("progress", function(data) { console.log('progress', data); });
xm_validator.on("end", function(data) { console.log('validate-end', data); });

    Parameters

    • event: "start" | "progress" | "end"

      Name des Ereignisses, auf das gelauscht werden soll.

    • eventCallback: function

      Rückruffunktion für das Ereignis. Dem Rückrüf übergeben wird: der Index (idx) des derzeit zu validierenden Formularelements, eine Liste (items) mit allen zu validierenden Elementen, das derzeit (item) zu validierende Element und ob dieses Elemente valide ist (valid).

        • (this: undefined, data: object): void

        • Parameters

          • this: undefined
          • data: object
            • idx: number
            • item: JQuery
            • items: JQuery
            • valid: boolean

          Returns void

    Returns void