Datentyp FormData
Kombinationen aus Formulardefinition und mit dieser erfassten Werte werden auch als FormData-Objekt bezeichnet. Also beispielsweise alle Eingabekomponenten einer Vorlage inklusive gespeicherter Werte.
In der Regel lassen sich die Inhalte des Variablenbezeichners name, die auf dem Formular-Register einer Vorlage definiert wird (siehe dazu auch Bereich Formulare), auf dem Vorlagensatz-Register derselben Vorlage einfach per $CMS_VALUE(...)$ oder $CMS_REF(...)$ ausgeben. Um die Inhalte eines (z. B. über FS_REFERENCE) referenzierten Objekts auszugeben, kann FormData des Objekts genutzt werden.
FormData-Objekte werden also von verschiedenen FirstSpirit-Elementen zurückgeliefert.
Von einem FormData-Objekt aus kann über die Methode get(Language, String) auf das FormField zugegriffen werden. Dabei handelt es sich um genau eine Eingabekomponente und den sprachabhängigen Inhalt des FormData-Objekts. Der Bezeichner der gewünschten Eingabekomponente wird in der Methode (in doppelten Hochkommata) angegeben, ebenso die gewünschte Sprache, z. B.
.get(#global.language, "BEZEICHNER").get
Mit folgender vereinfachter Syntax kann auf den Inhalt eines FormField in der aktuell gerenderten Sprache zugegriffen werden:
.formData.BEZEICHNER
Dabei ist BEZEICHNER der Bezeichner der Eingabekomponente, auf deren Inhalt zugegriffen werden soll.
Methoden auf FormData-Objekten
In der unten angegebenen Tabelle werden alle Methoden aufgelistet, die auf Objekten vom Datentyp FormData aufgerufen werden können:
equals(Object)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
equals(Object) | boolean |
get(Language, String)
Mithilfe der Methode .get(Language, String) kann auf das FormField in einer speziellen Sprache zugegriffen werden. Dabei handelt es sich um genau eine Eingabekomponente und den sprachabhängigen Inhalt des FormData-Objekts. Der Bezeichner der gewünschten Eingabekomponente wird in der Methode (in doppelten Hochkommata) angegeben, ebenso die gewünschte Sprache, z. B.
$CMS_VALUE(BEZEICHNER.formData.get(#global.language, "BEZEICHNER2").get)$
Mit folgender vereinfachter Syntax kann auf den Inhalt eines FormField in der aktuell gerenderten Sprache zugegriffen werden:
$CMS_VALUE(BEZEICHNER.formData.BEZEICHNER2)$
$CMS_VALUE(BEZEICHNER.formData.get("BEZEICHNER2")$
$CMS_VALUE(BEZEICHNER.formData["BEZEICHNER2"])$
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
get(Language, String) | FormField | 4.2.404 |
getClass
Die Methode .getClass() (in Bean-Syntax: .class) liefert die Klasse des aufrufendes Objektes zurück (vgl. java.lang.Class).
Aufruf:
$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$
Ausgabe:
java.lang.String
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
getClass | Class |
getForm
Provides the form definition.Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
getForm | GomEditorProvider | 4.2.404 |
isCase(Object)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
isCase(Object) | boolean |
isNull
Die Methode .isNull() (in Bean-Syntax: .isNull) prüft, ob ein Ausdruck bzw. Objekt Null ist, z. B. storeElement.isNull(). Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt, wann es null ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.
Die Methode .isNull() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt Null ist und false (=unwahr) wenn nicht.
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
isNull | boolean |
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
void |
set(String, Object)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
set(String, Object) | Object |
toJSON
Convert to a JSON-compatible string representation including necessary quotes and escaping for immediate use. Handles Maps, Collections, Arrays, Numbers, Strings, Boolean, Date, and JsonElement. A date instance will be converted to an ISO-8601 formatted date string. Any object other than above will be converted using its 'toString()' value.Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
toJSON | String | 5.2.11 |
toString
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
toString | String |
type
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
type | String |