Datentyp IdProvidingFormData

Wertebereich des Datentyps IdProvidingFormData

Mithilfe der Eingabekomponente FS_LIST können Listen gepflegt werden. Sie liefert ein FormDataList-Objekt zurück. Dieses enthält IdProvidingFormData-Objekte. Dabei dient IdProvidingFormData als Vermittler zwischen einer vom Redakteur gewählten Vorlage (je nach Konfiguration von FS_LIST eine bestimmte, im Projekt vorhandene Absatz-, Verweis- oder Tabellenvorlage), den in der gewählten Vorlage definierten Formularfeldern und den vom Redakteur in den Formularfeldern gespeicherten Werten. Daher ist sowohl eine Ausgabe einzelner Werte möglich (siehe 1) unten), als auch eine Ausgabe basierend auf der Definition für den Ausgabekanal der Vorlage (siehe 2) unten).

Die Ausgabe der einzelnen Elemente einer Liste erfolgt mit einer $CMS_FOR(...)$-Anweisung.

1) Ausgabe einzelner Werte
Einerseits kann auf die in FS_LIST gespeicherten Daten einer einzelnen Eingabekomponente zugegriffen werden. Dazu wird der Bezeichner der Eingabekomponente angegeben, z. B.

<ul>
   $CMS_FOR(ELEMENT, LISTE)$
     <li>$CMS_VALUE(ELEMENT.BEZEICHNER)$</li>
   $CMS_END_FOR$
</ul>

Dabei ist für LISTE der Variablenname der FS_LIST-Komponente, für BEZEICHNER der Variablenname der betreffenden Eingabekomponente der Absatz- oder Verweis- oder Tabellenvorlage anzugeben.

Die Objekte werden standardmäßig sprachabhängig ausgegeben. Daher ist keine sprachabhängige Unterscheidung notwendig.

Im DATASOURCE-Typ DATABASE kann darüber hinaus der Schlüsselbegriff fs_id verwendet werden, um die ID der Datensätze auszugeben, z. B.

$CMS_FOR(ELEMENT, LISTE)$
   		Datensatz-ID: $CMS_VALUE(ELEMENT.fs_id)$
$CMS_END_FOR$

Dabei ist LISTE der Bezeichner der FS_LIST-Eingabekomponente, ELEMENT einer der in FS_LIST ausgewählten Datensätze.

2) Vorlagenbasierte Ausgabe
Andererseits kann für die Ausgabe der in FS_LIST vorhandenen Listeneinträge die jeweils hinterlegte bzw. vom Redakteur ausgewählte Absatz- oder Verweisvorlage herangezogen werden.

$CMS_FOR(VARIABLE, BEZEICHNER)$
   		<li>$CMS_VALUE(VARIABLE)$</li>
$CMS_END_FOR$

Dabei ist für BEZEICHNER der Variablenname der FS_LIST-Komponente anzugeben. Die Ausgabe jedes Elements der Liste hängt dann also von der Definition des Ausgabekanals der gewählten Absatz- oder Verweisvorlage ab.

Hinweise zur Verwendung von FS_LIST, DATASOURCE-Typ INLINE mit <TEMPLATES source="sectiontemplates">, in Verbindung mit "Easy-Edit" siehe Kapitel Easy-Edit.

3) Ausgabe für den DATASOURCE-Typ PAGE
Bei Verwendung des DATASOURCE-Typs PAGE werden für die Ausgabe der Absatzinhalte die Schlüsselbegriffe uid und label verwendet: Mithilfe von uid wird der Name eines Absatzes ausgegeben, mithilfe von label die (manuell vergebene) Beschriftung, z. B.

<ul>
   		$CMS_FOR(VARIABLE, LISTE)$
     		<li>
		          <a href="#$CMS_VALUE(VARIABLE.uid)$">
              Label:    $CMS_VALUE(VARIABLE.label)$ 	 <br>
              UID:      $CMS_VALUE(VARIABLE.uid)$</a>
		     		</li>
   		$CMS_END_FOR$
</ul>

Dabei ist LISTE der Bezeichner der FS_LIST-Eingabekomponente.

Weitere Informationen zum Datentyp IdProvidingFormData siehe API-Dokumentation:

de.espirit.firstspirit.access.editor.fslist.IdProvidingFormData

Definition über die Standard-Eingabekomponenten

Die folgende Standard-Eingabekomponente liefert Objekte vom Datentyp IdProvidingFormData zurück:

• FS_LIST

Auf den zurückgelieferten Objekten können dann mithilfe von $CMS_VALUE(...)$- und $CMS_FOR(...)$-Anweisungen Methoden angewendet werden (siehe oben).

Methoden auf IdProvidingFormData-Objekten

In der unten angegebenen Tabellen werden alle Methoden aufgelistet, die auf Objekten vom Datentyp IdProvidingFormData aufgerufen werden können:

compareTo(Comparable)

Übersicht

equals(Object)

Übersicht

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)$

Übersicht

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

Übersicht

getForm

Übersicht

getId

Übersicht

getTemplate

Übersicht

isCase(Object)

Übersicht

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.

Übersicht

print

Übersicht

set(String, Object)

Übersicht

toJson

Übersicht

toString

Übersicht

type

Übersicht