Datentyp MappingMedium

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:

• CMS_INPUT_IMAGEMAP

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 Tabellen werden alle Methoden aufgelistet, die auf Objekten von Datentyp MappingMedium aufgerufen werden können:

compareTo(Comparable)

Übersicht

equals(Object)

Übersicht

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

Übersicht

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.

Ü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

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

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.

Übersicht

getElement

Übersicht

getElementName

Übersicht

getFile

Übersicht

getFolder

Übersicht

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

Übersicht

getImage

Übersicht

getLanguage

Übersicht

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>

Übersicht

getPicture

Übersicht

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

Übersicht

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

Übersicht

getType

Übersicht

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

Übersicht

isCase(Object)

Übersicht

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.

Ü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

setAltText(String)

Übersicht

setAreas(List)

Übersicht

setComment(String)

Übersicht

setElementName(String)

Übersicht

setFolder(MediaFolder)

Übersicht

setMedium(Media)

Übersicht

setRemoteName(String)

Übersicht

setResolution(Resolution)

Übersicht

toJson

Übersicht

toString

Übersicht

type

Übersicht