Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / SectionListEntry

Datentyp SectionListEntry

Wertebereich des Datentyps SectionListEntry

Mit der Eingabekomponente SECTIONLIST kann eine Liste von vorhandenen Absätzen erstellt werden. Die Eingabekomponente wird z. B. genutzt, um ein Inhaltsverzeichnis mit Sprungmarken zu den Absätzen zu erstellen.

Da die Eingabekomponente eine Liste von SectionListEntry-Objekten zurückliefert, erfolgt die Ausgabe der einzelnen Absatzeinträge mit einer $CMS_FOR(...)$-Anweisung.

<ul>
$CMS_FOR(section, st_sectionlist)$
<li><a href="#$CMS_VALUE(section.anchorName)$">$CMS_VALUE(section.text)$ -> Sectionname: $CMS_VALUE(section.sectionName)$</a></li>
$CMS_END_FOR$
</ul>

Weitere Informationen zum Datentyp SectionListEntry siehe API-Dokumentation:

de.espirit.firstspirit.access.editor.value.SectionListEntry

Definition über die Standard-Eingabekomponenten

Im Formularbereich einer Seiten- oder Absatzvorlage können unterschiedliche Eingabekomponenten definiert werden. Über diese Formularelemente können dann die eigentlichen redaktionellen Inhalte in die Seite einfügen werden. Die von FirstSpirit unterstützten Standard-Eingabekomponenten liefern unterschiedliche Datentypen zurück.

Die folgenden Standard-Eingabekomponenten liefern eine Liste von Objekten vom Datentyp SectionListEntry zurück:

Auf diesen Objekten lassen sich dann mit Hilfe einer $CMS_VALUE(...)$-Anweisung Methoden anwenden:

$CMS_VALUE(BEZEICHNER.METHODE)$

Unter BEZEICHNER muss die Laufvariable der $CMS_FOR(...)$-Anweisung verwendet werden, mit der über die Eingabekomponente iteriert wird.

Methoden auf SectionListEntry-Objekten

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

Objekt wird von folgenden Formular-Objekten erzeugt:
CMS_INPUT_SECTIONLIST
Methodenname Rückgabetyp Kurzbeschreibung Verfügbar seit
equals(Object) boolean
getAnchorName String Namen des durch den Absatz erzeugten Ankers
getClass Class Klasse des aufrufenden Objektes
getSectionName String Referenznamen des Absatzes
getText String Bezeichnung, die dem Absatz zugeordnet ist
isCase(Object) boolean
isNull boolean Prüft, ob ein Ausdruck Null ist
print void
set(String, Object) Object
setSectionName(String) void Ändert den Absatznamen (in der Sectionlist)
setText(String) void Ändert die Absatzbeschriftung
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
toXml String XML-Repräsentation des Absatzes
type String

equals(Object)

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

getAnchorName

Die Methode .getAnchorName() (in Bean-Syntax: .anchorName) liefert den Namen des durch den Absatz erzeugten Ankers in HTML-Syntax zurück.

Das Rückgabeobjekt ist eine Zeichenkette (siehe java.lang.String).

Methodenname Rückgabetyp Verfügbar seit
getAnchorName String

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

getSectionName

Die Methode .getSectionName() (in Bean-Syntax: .sectionName) liefert den Referenznamen des Absatzes zurück.

Das Rückgabeobjekt ist eine Zeichenkette (siehe java.lang.String).

Methodenname Rückgabetyp Verfügbar seit
getSectionName String

getText

Die Methode getText() (in Bean-Syntax: .text) liefert die für den Absatz vergebene Beschriftung zurück.

Das Rückgabeobjekt ist eine Zeichenkette (siehe java.lang.String).

Methodenname Rückgabetyp Verfügbar seit
getText String

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

print

Methodenname Rückgabetyp Verfügbar seit
print void

set(String, Object)

Methodenname Rückgabetyp Verfügbar seit
set(String, Object) Object

setSectionName(String)

Die Methode .setSectionName(String) (in Bean-Syntax: .sectionName(String)) ändert den Namen des Absatzes (in der Sectionlist) auf den übergebenen Wert.

Wird nicht zugleich auch der Absatz selbst umbenannt, führt dies dazu, dass der Eintrag nicht mehr angezeigt wird.

Methodenname Rückgabetyp Verfügbar seit
setSectionName(String) void

setText(String)

Die Methode setText(String) (in Bean-Syntax: .text(string)) ändert die für den Absatz vergebene Beschriftung auf den übergebenen Wert.

Methodenname Rückgabetyp Verfügbar seit
setText(String) void

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

toXml

Die Methode .toXML() (in Bean-Syntax: .xml) liefert eine XML-Repräsentation des Absatzes zurück.

Das Rückgabeobjekt ist eine Zeichenkette (siehe java.lang.String).

Methodenname Rückgabetyp Verfügbar seit
toXml String

type

Methodenname Rückgabetyp Verfügbar seit
type String

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