Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / Link

Datentyp LinkVerfügbar ab FirstSpirit-Version 4.0

Wertebereich des Datentyps Link

Für die Bearbeitung von Werten, die einen Verweis innerhalb oder außerhalb des Projektes repräsentieren, stellt FirstSpirit den Datentyp Link zur Verfügung.

Zu weiteren Informationen über Verweise und Verweisvorlagen in FirstSpirit siehe auch Kapitel Verweisvorlagen.

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 ein Objekt vom Datentyp Link bzw. eine Liste von Link-Objekten zurück:

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

$CMS_VALUE(BEZEICHNER.METHODE)$

Methoden auf Link-Objekten

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

Objekt wird von folgenden Formular-Objekten erzeugt:
CMS_INPUT_LINK
Methodenname Rückgabetyp Kurzbeschreibung Verfügbar seit
equals(Object) boolean
findReferences(Language) List
get(Object) Object Returns the value mapped to the given key or null if the given key isn't mapped. 4.0.17
getClass Class Klasse des aufrufenden Objektes
getContentID String
getFormData FormData Gets the formdata container for this link. 4.2.440
getLinkLanguage Language Provides the language the link is created for. 4.2.400
getSectiontemplate String
getTemplate LinkTemplate Returns the link template this link is based on. 2.3.17
getText String Verweistext 2.3.17
isCase(Object) boolean
isNull boolean Prüft, ob ein Ausdruck Null ist
isSet(Object) boolean Indicates whether the given key is set or not. 4.0.17
print void 4.0.0
set(String, Object) Object
setFormData(FormData) void Sets the given formdata container for this link. 4.2.440
setTemplate(LinkTemplate) void Switch the template - use with caution. 2.3.17
setText(String) void Sets the text for this link. 2.3.17
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

findReferences(Language)

Methodenname Rückgabetyp Verfügbar seit
findReferences(Language) List

get(Object)

Returns the value mapped to the given key or null if the given key isn't mapped.
Methodenname Rückgabetyp Verfügbar seit
get(Object) Object 4.0.17

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

getContentID

Methodenname Rückgabetyp Verfügbar seit
getContentID String

getFormData

Gets the formdata container for this link.
Methodenname Rückgabetyp Verfügbar seit
getFormData FormData 4.2.440

getLinkLanguage

Provides the language the link is created for.
Methodenname Rückgabetyp Verfügbar seit
getLinkLanguage Language 4.2.400

getSectiontemplate

Methodenname Rückgabetyp Verfügbar seit
getSectiontemplate String

getTemplate

Returns the link template this link is based on.
Methodenname Rückgabetyp Verfügbar seit
getTemplate LinkTemplate 2.3.17

getText

Die Methode getText liefert den Inhalt der Eingabekomponente eines Verweises zurück, die auf dem Register "Eigenschaften" in der Drop-Down-Box "Verweistext" ausgewählt ist. Siehe dazu auch Kapitel Verweisvorlagen.

Methodenname Rückgabetyp Verfügbar seit
getText String 2.3.17

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

isSet(Object)

Indicates whether the given key is set or not.
Methodenname Rückgabetyp Verfügbar seit
isSet(Object) boolean 4.0.17

print

Methodenname Rückgabetyp Verfügbar seit
print void 4.0.0

set(String, Object)

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

setFormData(FormData)

Sets the given formdata container for this link.
Methodenname Rückgabetyp Verfügbar seit
setFormData(FormData) void 4.2.440

setTemplate(LinkTemplate)

Switch the template - use with caution.
Methodenname Rückgabetyp Verfügbar seit
setTemplate(LinkTemplate) void 2.3.17

setText(String)

Sets the text for this link.
Methodenname Rückgabetyp Verfügbar seit
setText(String) void 2.3.17

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.4 | Datenschutz