Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / Card

Datentyp CardVerfügbar ab FirstSpirit-Version 5.2

Wertebereich des Datentyps Card

Inhaltsverzeichnis

Mithilfe der Eingabekomponente FS_CATALOG können Absatz- oder Verweislisten gepflegt werden. Sie liefert ein Catalog-Objekt zurück. Dieses enthält Card-Objekte. Dabei dient Card als Vermittler zwischen einer vom Redakteur gewählten Vorlage (je nach Konfiguration von FS_CATALOG eine bestimmte, im Projekt vorhandene Absatz- oder Verweisvorlage), 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)), als auch eine Ausgabe basierend auf der Definition des Vorlagensatzes der referenzierten (Absatz- oder Verweis-)Vorlage (siehe 2)).

1) Ausgabe einzelner Formularfelder über die Vorlage selbst

Einerseits kann auf die in FS_CATALOG gespeicherten Daten einzelner Formularfelder zugegriffen werden.

Dazu wird die Methode .getItem (in Bean-Syntax: .item) verwendet. Diese gibt ein Objekt vom Typ FormData zurück. Um an die gespeicherten Werte einer „inneren“ Eingabekomponente zu gelangen, muss zusätzlich der Bezeichner des Formularfelds angegeben werden, z. B.

<ul>
$CMS_FOR(var, st_catalog)$
<li>$CMS_VALUE(var.item.BEZEICHNER)$</li>
$CMS_END_FOR$
</ul>

Dabei ist für st_catalog der Variablenname der FS_CATALOG-Komponente, für BEZEICHNER der Variablenname des betreffenden Formularfelds der Absatz- oder Verweisvorlage anzugeben.

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

Bei einer solchen Iteration über die Elemente wie mit $CMS_FOR(...)$ stehen in den abhängigen Absatz- oder Verweisvorlagen die Systemobjekte #card, #index und #fs_catalog nicht zur Verfügung.

2) Ausgabe der "Card" über die referenzierte Vorlage

Andererseits kann für die Ausgabe der in FS_CATALOG vorhandenen Einträge die jeweils hinterlegte bzw. vom Redakteur ausgewählte Absatz- oder Verweisvorlage herangezogen werden. Dazu wird $CMS_VALUE(...)$ verwendet, z. B.

$CMS_VALUE(BEZEICHNER)$

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

In der abhängigen Absatz- oder Verweisvorlage stehen die Systemobjekte

  • #card (repräsentiert den Eintrag (Absatz oder Verweis) einer FS_CATALOG-Eingabekomponente)
  • #index (ermittelt die Nummer des aktuell gerenderten Eintrags)
  • #fs_catalog (ermittelt die Anzahl der in der FS_CATALOG-Eingabekomponente enthaltenen Einträge)

zur Verfügung.

Weitere Informationen zum Datentyp Card siehe API-Dokumentation:

de.espirit.firstspirit.client.access.editor.lists.Catalog$Card

Methoden auf Card-Objekten

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

Objekt wird von folgenden Formular-Objekten erzeugt:
FS_CATALOG
Methodenname Rückgabetyp Kurzbeschreibung Verfügbar seit
equals(Object) boolean
getClass Class Klasse des aufrufenden Objektes
getId UUID Ermittlung der UUID eines FS_CATALOG-Eintrags 5.2.181202
getItem FormData Liefert den aktuellen Eintrag als FormData zurück 5.2.6
getTemplate Template Liefert die Vorlage zurück, auf der der aktuelle Eintrag basiert 5.2.6
isCase(Object) boolean
isNull boolean Prüft, ob ein Ausdruck Null ist
loadItem(FormData) void Loads the data from the given item into this card. 5.2.13
print void
set(String, Object) Object
toJSON String 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. 5.2.11
toString String
type String

equals(Object)

Methodenname Rückgabetyp Verfügbar seit
equals(Object) boolean

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

getId

Mit der Methode getId() (in Bean-Syntax: .id) kann die ID des entsprechenden FS_CATALOG-Eintrags ("Card") ermittelt werden. Auf diese ID kann dann beispielsweise in der Generierung zugegriffen werden. Eine solche ID kann folgendermaßen aussehen:

c84c8dae-512a-4142-9068-85208d4072fe

Syntax-Beispiel:

<p>
$CMS_FOR(var,st_catalog)$
ID: $CMS_VALUE(var.getId())$
</p>

Dabei ist var der Bezeichner für das (Listen-)Objekt, st_catalog der Variablenname der FS_CATALOG-Komponente.

Mit folgender beispielhaften Syntax kann der Text (Inhalt der Eingabekomponente st_text) eines bestimmten Eintrags (hier der FS_CATALOG-Eintrag mit der ID 7644cfe2-b117-4ec7-bc94-bb8f255d1f59) mithilfe der Hilfsmethode find(String) ausgegeben werden:

$CMS_VALUE(st_catalog.find("7644cfe2-b117-4ec7-bc94-bb8f255d1f59").get().item.st_text)$
Methodenname Rückgabetyp Verfügbar seit
getId UUID 5.2.181202

getItem

Liefert den aktuellen Eintrag als FormData zurück.

Beispiel siehe oben.

Methodenname Rückgabetyp Verfügbar seit
getItem FormData 5.2.6

getTemplate

Liefert die Vorlage zurück, auf der der aktuelle Eintrag der FS_CATALOG-Komponente basiert.

Methodenname Rückgabetyp Verfügbar seit
getTemplate Template 5.2.6

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

loadItem(FormData)

Loads the data from the given item into this card.
Methodenname Rückgabetyp Verfügbar seit
loadItem(FormData) void 5.2.13

print

Methodenname Rückgabetyp Verfügbar seit
print 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

© 2005 - 2024 Crownpeak Technology GmbH | Alle Rechte vorbehalten. | FirstSpirit 2024.2 | Datenschutz