Einfacher modaler Dialog zum Anzeigen ausstehender hochzuladender Dateien.
Hilfsmethoden für die Behandlung zum Hochladen von Dateien über AJAX.
Die API für den Terminwähler, die mehrere Funktionen zum Arbeiten mit Terminwählern enthält, wie z.B. das Abrufen des aktuell ausgewählten Datums oder der Zeit oder das Ändern des ausgewählten Datums oder der Zeit.
Die API ist über $.xutil.appointmentPicker verfügbar.
Hilfsfunktionen zum Arbeiten mit Prüfsummen.
The entry point for the character counter. It adds a simple character to input and textarea elements.
OptionalonreadyRückruffunktion, welche aufgerufen wird, sobald dass Formular vollständig dargestellt und initialisiert wurde. Über diese Eigenschaft kann nur eine einzelne Rückruffunktion gesetzt werden. Um mehere Rückruffunktionen zu registrieren, kann wie folgt vorgegangen werden:
$("form.xm-form").on("ready", myListener);
Eine Flag die angibt, ob das Formular bereits vollständig dargestellt und aktualisiert wurde. Die ist ähnlich zum zur Rückruffunktion onready, welches aufgerufen wird, wenn das Formular fertig ist, lässt einen den Status aber direkt abfragen.
Zeichnet das Vorschaubild für ein Upload-Element.
Das Datei-Eingabe-Element mit dem Formularelement zum Hochladen von Dateien.
Liste von zu zeichnenden Bildern. Wenn leer, werden die Vorschaubilder entfernt.
Führt eine Datenbankabfrage per AJAX durch. Datenbankabfragen werden im formcycle-Backend angelegt.
Wenn die Abfrage Platzhalter (Fragezeichen ?) enthält, muss genau diese Anzahl
an Parametern übergeben werden, ansonsten schlägt die Anfrage fehl.
// Rückruffunktion, wenn Abfrage erfolgreich war
function successFunc(data) {
// JSON-Daten aus Rückgabe verarbeiten
console.log(data);
if (data.result.length > 0) {
$('[name=tfName]').val(data.result[0].name);
}
}
// Rückruffunktion, wenn Abfrage nicht erfolgreich war
function errorFunc(jqXHR, textStatus, errorThrown) {
// Fehler auswerten
console.error(errorThrown);
}
function getData(paramID, paramMail) {
$.xutil.getDataQuery('BeispielAbfrageName', [paramID, paramMail],
successFunc, errorFunc);
}
// Datenbankabfrage mit Parametern aus Formularfeldern starten
getData($('[name=tfId]').val(), $('[name=tfMail]').val());
Name der Datenbankabfrage, wie er im FORMCYCL-Backend konfiguriert wurde.
Optionalparams: SingleOrArrayLike<Weitere Parameter für die Datenbankabfrage. Kann ein einzelner Wert oder ein
Feld von Werten sein, es werden alle angegebenen Wert als Parameter übertragen. Bei undefined wird
ein leerer Wert übertragen. Bei einem String wird der String selbst übertragen. Bei Zahlen und
Wahrheitswerden wird die String-Repräsentation der Zahl beziehungsweise des Wahrheitswerts übertragen.
Bei einer JQuery-Instanz werden die Werte aller HTML-Elemente in der JQuery-Selektion übertragen. Bei einem
HTMLElement: (1) wenn es ein Checkbox- oder Radio-Input-Element ist, wird der Wert der Checkbox oder des Radiobuttons
übertragen, falls selektiert, (2) wenn es ein File-Input-Element ist, werden die Namen aller Dateien übertragen oder
der leere String, falls keine Datei ausgewählt ist, (3) bei anderen Input-Elementen wird der Wert des Input-Elements übertragen,
(4) wenn es ein Select- oder Textarea-Element ist, wird der Wert via $.fn.val ermittelt und übertragen, (5) bei anderen
Elementen wird nach Kinderelementen vom Type input, textarea und select gesucht und deren Werte übertragen.
Optionalsuccess: TypeOrArray<SuccessCallback<any>>Rückruffunktion, wenn die Datenbankabfrage erfolgreich war.
Optionalerror: TypeOrArray<ErrorCallback<any>>Rückruffunktion, wenn die Datenbankabfrage fehlschlug.
Ein Promise, das mit dem Ergebnis der Datenbankabfrage erfüllt wird. Jeder Eintrag in dem Array entspricht einer Zeile im Ergebnis der Datenbankabfrage.
Ermittelt den Wert des URL-Parameters mit dem gegebenen Namen. Falls solch ein Parameter nicht existiert, wird der gegebene Rückfallwert zurückgegeben.
Kommt ein URL-Parametername mehrfach vor, werden alle Wert kommagetrennt (,) zurückgegeben.
Ist die URL etwa:
https://formcloud.de/formcycle/form/provide/9999?name=Max&preview&mode=&name=Tom
Dann verhält sich diese Funktion wie folgt:
$.xutil.getFormParam("name") // => "Max,Tom"
$.xutil.getFormParam("preview"); // => undefined
$.xutil.getFormParam("mode"); // => undefined
$.xutil.getFormParam("owner", "anonymous"); // => "anonymous"
Name des zu ermittelnden URL-Parameters.
OptionaldefaultValue: stringRückfallwert, falls der URL-Parameter nicht gesetzt ist.
Der Wert des gegebenen URL-Parameters oder der Rückfallwert, falls kein solcher Parameter existiert.
Liefert die formcycle-spezifische URL eines bestimmten Typen zurück. Diese Funktion sollte benutzt werden, da sich die konkreten URLs ändern können.
Die folgenden Arten von URLs gibt es derzeit:
/formcycle.dataquery_db genutzt werden.ping.// Gibt zurück: "/formcycle/datenquellecsv/"
$.xutil.getFormUrl("datasource_csv", undefined);
Art von URL, die gesucht wird.
OptionaldefaultValue: stringRückfallwert, falls die gesuchte URL-Art nicht existiert.
Die URL der gesuchten Art. Wenn keine solche Art existiert, der Rückfallwert.
Führt eine LDAP-Abfrage per AJAX durch. LDAP-Abfragen werden im formcycle-Backend angelegt.
Wenn die Abfrage Platzhalter (Fragezeichen ?) enthält, muss genau diese Anzahl
an Parametern übergeben werden, ansonsten schlägt die Anfrage fehl.
// Rückruffunktion, wenn Abfrage erfolgreich war
function successFunc(data) {
// JSON-Daten aus Rückgabe verarbeiten
console.log(data);
if (data.length > 0) {
$('[name=tfName]').val(data[0].name);
}
}
// Rückruffunktion, wenn Abfrage nicht erfolgreich war
function errorFunc(jqXHR, textStatus, errorThrown) {
// Fehler auswerten
console.error(errorThrown);
}
function getData(paramID, paramMail) {
$.xutil.getLdapQuery('BeispielAbfrageName', [paramID, paramMail],
successFunc, errorFunc);
}
// LDAP-Abfrage mit Parametern aus Formularfeldern starten
getData($('[name=tfId]').val(), $('[name=tfMail]').val());
Name der LDAP-Abfrage, wie er im FORMCYCL-BAckend konfiguriert wurde.
Optionalparams: SingleOrArrayLike<Weitere Parameter für die LDAP-Abfrage. Kann ein einzelner Wert oder ein
Feld von Werten sein, es werden alle angegebenen Wert als Parameter übertragen. Bei undefined wird
ein leerer Wert übertragen. Bei einem String wird der String selbst übertragen. Bei Zahlen und
Wahrheitswerden wird die String-Repräsentation der Zahl beziehungsweise des Wahrheitswerts übertragen.
Bei einer JQuery-Instanz werden die Werte aller HTML-Elemente in der JQuery-Selektion übertragen. Bei einem
HTMLElement: (1) wenn es ein Checkbox- oder Radio-Input-Element ist, wird der Wert der Checkbox oder des Radiobuttons
übertragen, falls selektiert, (2) wenn es ein File-Input-Element ist, werden die Namen aller Dateien übertragen oder
der leere String, falls keine Datei ausgewählt ist, (3) bei anderen Input-Elementen wird der Wert des Input-Elements übertragen,
(4) wenn es ein Select- oder Textarea-Element ist, wird der Wert via $.fn.val ermittelt und übertragen, (5) bei anderen
Elementen wird nach Kinderelementen vom Type input, textarea und select gesucht und deren Werte übertragen.
Optionalsuccess: TypeOrArray<SuccessCallback<any>>Rückruffunktion, wenn die LDAP-Abfrage erfolgreich war.
Optionalerror: TypeOrArray<ErrorCallback<any>>Rückruffunktion, wenn die LDAP-Abfrage fehlschlug.
Ein Promise, das mit dem Ergebnis der LDAP-Abfrage erfüllt wird. Jeder Eintrag in dem Array entspricht einem Eintrag, der vom Active Directoy zurückgeliefert wird.
Hilfsfunktion, um den aktuellen Status des Formulars zu überprüfen. Status können in der Verarbeitung des Formulars angelegt und konfiguriert werden.
// Wird das Formular zum ersten Mal geöffnet (kein Status gesetzt),
// setze den Default-Wert für das Formularelement "tfMail"
if ($.xutil.isStatus(undefined)) {
$("[data-name='tfMail']").val("default@mail.com");
}
// Auf einen bestimmten Status prüfen
var isArchived = $.xutil.isStatus("Archiv");
Name des Status, gegen den der aktuelle Status verglichen wird. undefined kann übergeben
werden, um zu prüfen, ob kein Status gesetzt ist, das Formular also noch nicht abgesendet wurde.
true, falls der aktuelle Status des Formular mit dem übergebenen übereinstimmt, ansonsten false.
Lädt gespeicherte Daten in das Formular und füllt alle Formularelemente mit den gespeicherten Werten.
Im Vergleich zu loadFromString verwendet diese Methode das Objekt anstelle eines serialisierten Strings.
Gespeicherte Daten, wie von save zurückgegeben.
Lädt gespeicherte Daten in das Formular und füllt alle Formularelemente mit den gespeicherten Werten.
Im Vergleich zu load verwendet diese Methode die serialisierte Zeichenkette anstelle eines Objekts.
Gespeicherte Daten, wie sie von saveAsString zurückgegeben werden.
Lädt den aktuellen Navigationszustand des Formulars, z. B. welche Seiten derzeit angezeigt werden, aus dem angegebenen Navigationszustand. Verwenden Sie saveNavigation, um den Navigationszustand zu speichern.
Hinweis: Sie können benutzerdefinierten Navigationszustand speichern und wiederherstellen, indem Sie einen Listener
für die Ereignisse saveNavigation und loadNavigation registrieren.
Der Navigationszustand, der wiederhergestellt werden soll, wie von saveNavigation zurückgegeben.
Removes an event callback previously added via on.
Type of the event name for which to remove a listener.
Name of the event to for which to remove a listener.
Listener to remove.
Entfernt eine Rückruffunktion die per onSubmit hinzugefügt wurde.
Rückruffunktion zum Entfernen.
Register a callback function for one of the events issued during the lifecycle of a form.
Uncaught errors in callbacks are caught, logged, and ignored otherwise.
Type of the event name for which to register a listener.
Name of the event to listen to.
Listener that is invoked when the event occurs.
A disposable that can be used to remove the listener.
Registriert eine Rückruffunktion für den Druckdienst. Die Rückruffunktion wird durch den Druckdienst gerufen, bevor das Formular gedruckt wird. Diese Rückruffunktion kann verwendet werden, um das Formular für den Druck vorzubereiten. Wenn die Rückruffunktion ein Versprechen zurückliefert, wartet der Druckdienst mit dem Drucken, bis das Versprechen erfüllt wurde. Wird das Versprechen gebrochen, so wird der Fehler protokolliert, verhindert aber das Drucken nicht.
Rückruffunktion, die registriert werden soll.
Ruft die gegebene Rückruffunktion, sobald Document.readyState sich
zu complete ändert. Falls der Bereitschaftszustand bereits complete ist,
wird die Rückruffunktion unverzüglich ausgeführt (aber immer noch asynchron
in einer der nächsten Zyklen der Ereignisschleife).
Diese Funktion ist ählich zu der Bereitsschaftszustandsfunktion von JQuery
($(function() { })). Diese Funktion verwendet aber DOMContentLoaded und
führt daher die Rückruffunktion möglicherweise bereits aus, wenn der
Bereitschaftszustand noch loading ist. Wenn es erforderlich, zu warten, bis
das Dokument vollständig geladen ist, sollte diese Funktion verwendet werden.
Falls beispielsweise eine Berechnung ausgeführt werden soll, die von der
Höhe oder Breite eines Elements Gebrauch macht, kann das Resultat sich
unterscheiden, wenn der Bereitschaftszustand des Dokuments noch loading
ist, da zu diesem Zeitpunkt Gestaltungsbögen oder Schriftarten noch nicht
geladen sein können.
Rückruffunktion, welche ausgeführt wird,
sobald der Bereitschaftszustand des Dokuments sich zu complete ändert.
Hilfsfunktion, um Code auszuführen, wenn sich das Formular in einem bestimmten Status befindet. Status können in der Verarbeitung des Formulars angelegt und konfiguriert werden.
// Wird das Formular zum ersten Mal geöffnet (kein Status gesetzt),
// setze den Default-Wert für das Formularelement tfMail
$.xutil.onStatus(undefined, function() {
$("[data-name='tfMail']").val("default@mail.com");
});
$.xutil.onStatus('Archiv', function() {
// Etwa tun, wenn Formular archiviert ist
});
Name des Status, gegen den der aktuelle Status verglichen wird. undefined kann übergeben
werden, um zu prüfen, ob kein Status gesetzt ist, das Formular also noch nicht abgesendet wurde.
Funktion, die unmittelbar (synchron zum Aufruf) ausgeführt wird, falls der übergebene Statusname dem aktuellen Status des Formulars entspricht.
Hilfsfunktion, um Code auszuführen, wenn das Formular noch keinen Status hat, also noch nicht abgesendet wurde. Status können in der Verarbeitung des Formulars angelegt und konfiguriert werden.
// Wird das Formular zum ersten Mal geöffnet (kein Status gesetzt), setze den Default-Wert für das
// Formularelement tfMail
$.xutil.onStatus(function() { $("[data-name='tfMail']").val("default@mail.com"); });
Funktion, die unmittelbar (synchron zum Aufruf) ausgeführt wird, falls der übergebene Statusname dem aktuellen Status des Formulars entspricht.
Eine Funktion, welche aufgerufen wird, bevor das Formular abgesendet wird. Die Standardimplementierung dieser
Funktion liefert einfach nur true zurück. Diese Funktion kann also überschrieben werden, ohne die
ursprüngliche Funktion aufzurufen. Um das Absenden des Formulars zu verhindern, kann in dieser Funktion der
Wert false zurückgegeben werden.
$.xutil.onsubmit = function(isFormValid) {
// Eigener Code vor dem Absenden.
// ...
// Eigene Logik zum Prüfen, ob das Absenden verhindert werden soll.
return isFormValid;
};
Ob das Formular derzeit valide ist (z.B. ob alle Mussfelder ausgefüllt sind).
true um mit dem Absenden fortzufahren, false oder undefined um das Absenden abzubrechen.
Registriert eine Rückruffunktion, wenn das Formular abgeschickt wird. Kann z.B. verwendet werden, um zusätzliche Aktionen auszuführen oder das Absenden zu verhindern.
Die Rückruffunktion wird aufgerufen, nachdem das Formular validiert wurde, wenn der Submit-Button eine Validierung erfordert.
$.xutil.onSubmit(() => doSomething())
$.xutil.onSubmit(({submissionBlocked}) => {
// Check if the submission is already blocked
if (submissionBlocked) {
return;
}
// Benutzerdefinierter Code, der bei der Übermittlung ausgeführt wird
// Benutzerdefinierte Logik, um zu prüfen, ob die Formularübermittlung abgebrochen werden soll.
const preventSubmission = customLogic();
return { preventSubmission };
});
Rückruffunktion, die aufgerufen wird, wenn das Formular abgeschickt werden soll.
Ein Disposable, das zum Entfernen der Rückruffunktion verwendet werden kann. Dies ist gleichbedeutend mit dem Aufruf von offSubmit mit der Rückruffunktion, die an diese Methode übergeben wird.
Interpretiert die Zeichenketter als Kommazahl und liefert diese zurück. Akzeptiert sowohl einen Punkt als auch ein Komma als Dezimaltrennzeichen.
Zeichenkette, die als Zahl interpretiert werden soll.
Die Zeichenkette interpretiert als Zahl, 0 falls
undefined übergeben wurde.
Erzeugt ein Objekt mit allen Daten aus dem aktuellen Formular, einschließlich aller wiederholten Formularfelder und aller hochgeladenen Dateien.
Im Vergleich zu save wird hier ein Objekt statt einer serialisierten Zeichenkette zurückgegeben.
Ein Objekt mit den Formulardaten.
Erzeugt eine Zeichenkette mit einer serialisierten Darstellung aller Daten aus dem aktuellen Formular, einschließlich aller wiederholten Formularfelder und aller hochgeladenen Dateien.
Im Vergleich zu save wird hier eine serialisierte Zeichenkette anstelle eines Objekts zurückgegeben.
Eine serialisierte Zeichenkette mit den Formulardaten.
Saves the current navigation state of the form, e.g. which pages are currently shown. The returned value can be serialized as JSON, or passed later to loadNavigation.
Note: You can store and restore custom navigation state by registering a listener for the saveNavigation and
loadNavigation events.
The navigation state for the current form.
Fires an event of the given types, invoking all listeners that were registered via on.
Type of the event name to trigger.
Name of the event.
Data to pass to the event listeners.
Dieses Objekt enthält formcycle-spezifische Hilfsfunktionen.