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

    Schnittstelle AppointmentPickerApiLifecycle

    (fortgeschritten) Stellt Funktionen bereit, die sich auf den Lebenszyklus eines Terminwählers beziehen, wie das Initialisieren eines neuen Wählers auf einem DOM-Element, das Abrufen der ID eines vorhandenen Terminwählers oder das Zerstören eines vorhandenen Terminwählers.

    Verfügbar über $.xutil.appointmentPicker.lifecycle.

    interface AppointmentPickerApiLifecycle {
        destroy: (picker: any) => void;
        getInstanceId: (picker: any) => string;
        getInstanceIds: (picker: any) => readonly string[];
        hasAnyActivePicker: (picker: any) => boolean;
        initialize: (
            element: any,
            options?: Partial<AppointmentPickerOptionsInitOptions>,
        ) => string[];
    }
    Index

    Eigenschaften

    destroy: (picker: any) => void

    Zerstört die angegebenen Terminwähler.

    Typendeklaration

      • (picker: any): void
      • Parameter

        • picker: any

          Eine Referenz auf die zu zerstörenden Terminwähler.

        Rückgabewert void

    getInstanceId: (picker: any) => string

    Ermittelt die Instanz-IDs des ersten Terminwählers aus dem angegebenen Verweis.

    Typendeklaration

      • (picker: any): string
      • Parameter

        • picker: any

          Ein Verweis auf den zu verarbeitenden Terminwähler.

        Rückgabewert string

        Die Instanz-IDs des ersten Terminwählers oder undefined, wenn der angegebene Verweis nicht zu Terminwählern auflöst.

    getInstanceIds: (picker: any) => readonly string[]

    Ermittelt alle Instanz-IDs des Terminwählers für den angegebenen Verweis.

    Wenn der Verweis auf mehrere Terminwähler auflöst, werden die IDs in der Reihenfolge der angegebenen Verweise zurückgegeben.

    Typendeklaration

      • (picker: any): readonly string[]
      • Parameter

        • picker: any

          Ein Verweis auf den zu verarbeitenden Terminwähler.

        Rückgabewert readonly string[]

        Alle Instanz-IDs der angegebenen Terminwähler.

    hasAnyActivePicker: (picker: any) => boolean

    Überprüft, ob die angegebene Referenz einen vorhandenen Terminwähler darstellt.

    Typendeklaration

      • (picker: any): boolean
      • Parameter

        • picker: any

          Eine Referenz auf den zu überprüfenden Terminwähler.

        Rückgabewert boolean

        true, wenn die angegebene Referenz mindestens einen aktiven Terminwähler darstellt, andernfalls false.

    initialize: (
        element: any,
        options?: Partial<AppointmentPickerOptionsInitOptions>,
    ) => string[]

    Initialisiert ein Element als Terminwähler und zeigt es an.

    Erstellt eine neue Wählerinstanz und bindet das angegebene Element als Ansicht für diesen Wähler.

    Die anfänglichen Einstellungen für den Terminwähler werden aus verschiedenen Quellen gelesen, wie z.B. der aktuellen Umgebung (der aktuellen Zeit), den Standard-Einstellungen des JQueryUI-Terminwählers (Datumsformat), den I18N-Variablen (lokalisierte Nachrichten), den XFC-Metadaten (Sitzung-ID und AJAX-Endpunkt-URLs); sowie aus dem angegebenen DOM-Element (vom Server bereitgestellte Daten, wie z.B. ob der Wähler schließbar ist).

    Die angegebenen Optionen haben immer Vorrang vor allen anderen Optionsquellen.

    Gibt die Instanz-ID des neu erstellten Wählers zurück. Die ID ist innerhalb des Geltungsbereichs des globalen Fensterkontexts einer Seite eindeutig. Die ID kann an die verschiedenen von diesem Modul angebotenen Methoden übergeben werden, um Operationen am Terminwähler durchzuführen.

    Wenn ein Terminwähler bereits initialisiert wurde, tut dies nichts und gibt einfach seine ID zurück.

    Typendeklaration

      • (element: any, options?: Partial<AppointmentPickerOptionsInitOptions>): string[]
      • Parameter

        • element: any

          Ein DOM-Element, das in einen Terminwähler umgewandelt werden soll. Sollte ein Container-Element wie ein div sein.

        • Optionaloptions: Partial<AppointmentPickerOptionsInitOptions>

          Optionale Einstellungen für den neu erstellten Terminwähler.

        Rückgabewert string[]

        Die Instanz-ID für jeden der neu erstellten Wähler.