Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / MappingMedium

Datentyp MappingMediumVerfügbar ab FirstSpirit-Version 4.0

Wertebereich des Datentyps MappingMedium

In FirstSpirit gibt es die Möglichkeit, für ein Bild maus-sensitive Bereiche festzulegen (auch verweis-sensitive Grafiken genannt). Um ein Bild mit maus-sensitiven Bereichen zu versehen, kann die Eingabekomponente IMAGEMAP verwendet werden. Die Eingabekomponente liefert ein Objekt vom Datentyp MappingMedium zurück. Mithilfe dieses Objekts kann der HTML-Quellcode für eine Imagemap erzeugt werden.

Weitere Informationen zum Datentyp MappingMedium siehe API-Dokumentation: de.espirit.firstspirit.access.editor.value.MappingMedium

Zur Ausgabe von Imagemaps siehe auch Datentyp Area.

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 MappingMedium zurück:

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

$CMS_VALUE(BEZEICHNER.METHODE)$

Unter BEZEICHNER muss der Parameter resultname, der in der Eingabekomponente definiert wurde, angegeben werden.

Methoden auf MappingMedium-Objekten

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

Objekt wird von folgenden Formular-Objekten erzeugt:
CMS_INPUT_IMAGEMAP
Methodenname Rückgabetyp Kurzbeschreibung Verfügbar seit
equals(Object) boolean
getAltText String Gespeicherter Kommentar in der Eingabekomponente 4.0
getAreas List Ausgabe der verweissensitiven Bereiche 4.0
getClass Class Klasse des aufrufenden Objektes
getComment String Gespeicherter Kommentar in der Eingabekomponente 4.0
getElement Referenceable Returns the element of the binary medium. 4.0.101
getElementName String Returns the element name of the binary medium. 4.1.10
getFile File Returns the file of the binary medium. 4.0.69
getFolder MediaFolder Returns the folder of the binary medium. 4.0.69
getHeight int Höhe des gespeicherten Mediums in der Eingabekomponente 4.0
getImage Media Provides the medium the map bases upon. 4.0
getLanguage Language Returns the language of the binary medium. 4.0
getMedium Media Gespeichertes Medium in der Eingabekomponente 4.0
getPicture Picture Returns the picture of the binary medium. 4.0.69
getRemoteName String Gespeicherter Name des Remote-Projektes 4.0
getResolution Resolution Auflösung des gespeicherten Mediums 4.0
getType BinaryMedium$Type Returns the type of this binary medium. 4.0.69
getWidth int Breite des gespeicherten Mediums in der Eingabekomponente 4.0
isCase(Object) boolean
isEmpty boolean Prüft, ob ein Ausdruck leer ist 4.0
isNull boolean Prüft, ob ein Ausdruck Null ist
print void
set(String, Object) Object
setAltText(String) void Sets an alt text for the medium. 4.0
setAreas(List) void Allows to define the areas mapping to links. 4.0
setComment(String) void Sets a comment. 4.0
setElementName(String) void Set the element name. 4.1.10
setFolder(MediaFolder) void Sets the folder of the binary medium. 4.0.69
setMedium(Media) void Sets the medium of the binary medium. 4.0
setRemoteName(String) void Sets a remote name for the medium 4.0
setResolution(Resolution) void Define the resolution to be used for the medium 4.0
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

getAltText

Die Methode .getAltText() (in Bean-Syntax: .altText) liefert den in der Eingabekomponente gespeicherten Wert für das Feld Kommentar zurück.

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

Methodenname Rückgabetyp Verfügbar seit
getAltText String 4.0

getAreas

Die verweissensitiven Bereiche einer CMS_INPUT_IMAGEMAP-Eingabekomponente können über die Methode getAreas() (in Bean-Syntax: .areas) ausgegeben werden.

Da innerhalb einer CMS_INPUT_IMAGEMAP-Eingabekomponente mehrere verweissensitive Bereiche gepflegt sein können, wird die Anweisung $CMS_FOR(...)$ verwendet, um die Attribute jedes einzelnen Bereichs ausgeben zu können:

$CMS_FOR(BEREICH, st_imagemap.getAreas())

Auf der Variablen BEREICH können dann verschiedene Methoden angewendet werden.

Methodenname Rückgabetyp Verfügbar seit
getAreas List 4.0

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

getComment

Die Methode .getComment() (in Bean-Syntax: .comment) liefert den in der Eingabekomponente gespeicherten Wert für das Feld Kommentar zurück.

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

Wichtig Bei der Methode handelt es sich um ein Synonym zu der Methode .getAltText(). Die Methode wurde aus Kompatibilitätsgründen eingebaut und kann in einer späteren Version entfallen.
Methodenname Rückgabetyp Verfügbar seit
getComment String 4.0

getElement

Returns the element of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
getElement Referenceable 4.0.101

getElementName

Returns the element name of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
getElementName String 4.1.10

getFile

Returns the file of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
getFile File 4.0.69

getFolder

Returns the folder of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
getFolder MediaFolder 4.0.69

getHeight

Die Methode .getHeight() (in Bean-Syntax: .height) liefert die Höhe des in der Eingabekomponente gespeicherten Mediums (vgl. Eingabekomponente IMAGEMAP) zurück.

Das Rückgabeobjekt ist eine Ganzzahl (siehe java.lang.Integer).

Methodenname Rückgabetyp Verfügbar seit
getHeight int 4.0

getImage

Provides the medium the map bases upon.
Methodenname Rückgabetyp Verfügbar seit
getImage Media 4.0

getLanguage

Returns the language of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
getLanguage Language 4.0

getMedium

Die Methode .getMedium() (in Bean-Syntax: .medium) liefert das in der Eingabekomponente ausgewählte Medium zurück (Beschriftung: Referenz).

Das Rückgabeobjekt ist ein Medium (siehe de.espirit.firstspirit.access.store.mediastore.Media).

Das Medium kann in einer $CMS_REF(...)$-Anweisung zur Ermittlung der URL genutzt werden:

<a href="$CMS_REF(referenzname)$">Text</a>
Methodenname Rückgabetyp Verfügbar seit
getMedium Media 4.0

getPicture

Returns the picture of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
getPicture Picture 4.0.69

getRemoteName

Die Methode .getRemoteName() (in Bean-Syntax: .remoteName) liefert den in der Eingabekomponente gespeicherten Namen des Remote-Projektes.

Der Wert wird in der Eingabekomponente gespeichert, wenn ein Element (z. B. Seitenreferenz, Bild, Datei usw.) aus einem Remote-Projekt ausgewählt wurde.

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

Methodenname Rückgabetyp Verfügbar seit
getRemoteName String 4.0

getResolution

Die Methode .getResolution() (in Bean-Syntax: .resolution) liefert die ausgewählte Auflösung des gespeicherten Mediums in der Eingabekomponente (vgl. Eingabekomponenten IMAGEMAP) zurück.

Die Auflösung ist bei der Auswahl des Bildes aus der Medien-Verwaltung auswählbar.

Das Rückgabeobjekt ist eine Auflösung (siehe de.espirit.firstspirit.access.project.Resolution).

Die Auflösung kann in einer $CMS_REF(...)$-Anweisung zur Ermittlung der URL genutzt werden:

<img src="$CMS_REF(st_cmsImagemap.medium, res:st_cmsImagemap.resolution)$">
Methodenname Rückgabetyp Verfügbar seit
getResolution Resolution 4.0

getType

Returns the type of this binary medium.
Methodenname Rückgabetyp Verfügbar seit
getType BinaryMedium$Type 4.0.69

getWidth

Die Methode .getWidth() (in Bean-Syntax: .width) liefert die Breite des in der Eingabekomponente gespeicherten Mediums (vgl. Eingabekomponente IMAGEMAP) zurück.

Das Rückgabeobjekt ist eine Ganzzahl (siehe java.lang.Integer).

Methodenname Rückgabetyp Verfügbar seit
getWidth int 4.0

isCase(Object)

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

isEmpty

Die Methode .isEmpty() (in Bean-Syntax: .isEmpty) prüft, ob ein Ausdruck bzw. Objekt leer ist, z. B. storeElement.isEmpty(). Das Ergebnis der semantischen Prüfung hängt vom Ausdruck bzw. Objekt ab, z. B. eine Zeichenkette ist dann leer, wenn sie kein Zeichen enthält. Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt, wann es leer 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 .isEmpty() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt leer ist und false (=unwahr) wenn nicht.

Methodenname Rückgabetyp Verfügbar seit
isEmpty boolean 4.0

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

setAltText(String)

Sets an alt text for the medium.
Methodenname Rückgabetyp Verfügbar seit
setAltText(String) void 4.0

setAreas(List)

Allows to define the areas mapping to links.
Methodenname Rückgabetyp Verfügbar seit
setAreas(List) void 4.0

setComment(String)

Sets a comment.
Methodenname Rückgabetyp Verfügbar seit
setComment(String) void 4.0

setElementName(String)

Set the element name.
Methodenname Rückgabetyp Verfügbar seit
setElementName(String) void 4.1.10

setFolder(MediaFolder)

Sets the folder of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
setFolder(MediaFolder) void 4.0.69

setMedium(Media)

Sets the medium of the binary medium.
Methodenname Rückgabetyp Verfügbar seit
setMedium(Media) void 4.0

setRemoteName(String)

Sets a remote name for the medium
Methodenname Rückgabetyp Verfügbar seit
setRemoteName(String) void 4.0

setResolution(Resolution)

Define the resolution to be used for the medium
Methodenname Rückgabetyp Verfügbar seit
setResolution(Resolution) void 4.0

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 - 2021 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2021-02 | Datenschutz | Impressum | Kontakt