Eingebetteter Modus (iFrame)
Der Render kann über einen iFrame in andere Applikationen eingebettet und darüber gesteuert werden. Für die Kommunikation mit dem Renderer im iFrame kommt Window.postMessage zum Einsatz. Alle Funktionen senden ebenfalls Antworten über diesem Weg an die Anwendung, die den Renderer per iFrame einbettet.
Funktionsaufruf
Als message
Parameter wird ein serialisiertes JSON Objekt übertragen.
requestName
-
Name der aufzurufenden Funktion.
request
-
Je nach Funktion wird über dieses Attribut ein Parameterobjekt angegeben, dass weitere Daten enthält.
sourceId
-
Frei wählbare ID. Diese wird bei der Übermittlung des Funktionsergebnisses als
destinationId
übermittelt. Damit kann der Aufrufer das Ergebnis eindeutig zuordnen.
Funktionsergebnis
Das Ergenis des Funktionsaufrufes wird asynchron über Window.postMessage an die einbettende Seite übermittelt.
{
"requestName": "METHOD_NAME",
"request": {
"_comment": "optional request object"
}
}
{
"requestName" : "METHOD_NAME",
"destinationId" : "SAME_AS_SOURCE_ID",
"response" : {
"_comment": "optional response object"
}
}
Funktionen
Folgende Funktionen stehen zur Verfügung.
- setFormConfig
-
Setzen der Formularkonfiguration.
- getFormConfig
-
Auslesen der Formularkonfiguration inkl. des aktuellen Zustands (admin/formconfig.adoc#state).
- setData
-
Setzen der Daten im Zustandsobjekt.
- validateData
-
Auslösen von Validierung.
- submitData
-
Auslösen von Submit - Formularversand
- resetForm
-
Auslösen von Reset - Zurücksetzen der Eingabe
- printForm
-
Auslösen von Print - Ausdruck des Formulars in ein pdf