Datentyp GraphicalMedium

Wertebereich des Datentyps GraphicalMedium

Dokumente (z.B.: .pdf, .doc), Bilder (z.B.: .gif, .jpg) und sonstige Dateien (z.B.: .zip, .swf), die innerhalb eines FirstSpirit-Projekts verwendet werden, müssen in der Medien-Verwaltung des Projekts vorliegen. Innerhalb der Medien-Verwaltung werden zwei Medienarten unterschieden:

• Bilder: das heißt, alle Arten von grafischen Dateien. FirstSpirit unterstützt folgende Bildformate
  • GIF: Graphics Interchange Format (verlustfreie Komprimierung für Rastergrafiken mit geringer Farbtiefe).
  • PNG: Portable Network Graphics (verlustfreie Komprimierung für Rastergrafiken mit geringer Farbtiefe).
  • JPG: Joint Photographic Experts Group (verlustbehaftete Komprimierung für Rastergrafiken mit hoher Farbtiefe).
  • TIFF: Tagged Image File Format (verlustfreie Komprimierung für hochwertige Rastergrafiken z.B. Druckvorstufen).
  • BMP: Bitmap (schwache, verlustfreie Komprimierung für Rastergrafiken mit hoher Farbtiefe).
• Dateien: das heißt, alle Arten von binären Dateien, ausgenommen Bildern, beispielsweise PDF-Dateien, komprimierte ZIP-Dateien, animierte SWF-Dateien, u.v.m.

Für die Bearbeitung von Werten, die eine Grafik repräsentieren, stellt FirstSpirit den Datentyp GraphicalMedium zur Verfügung. Im Unterschied zum Datentyp BinaryMedium besitzt ein Objekt vom Datentyp GraphicalMedium weitere Attribute, wie Breite, Höhe, Abstand und Rand (border).

Der Datentyp GraphicalMedium kann auch in der API-Dokumentation nachgeschlagen werden:

de.espirit.firstspirit.access.editor.value.GraphicalMedium

Definition über die Standard-Eingabekomponenten

Innerhalb des Formularbereichs einer Seiten- oder Absatzvorlage werden Eingabekomponenten definiert, mit deren Hilfe die Redakteure später die eigentlichen redaktionellen Inhalte in die Seite einfügen können. Die von FirstSpirit unterstützten Standard-Eingabekomponenten liefern unterschiedliche Datentypen zurück.

Die folgenden Standard-Eingabekomponenten liefern ein Objekt vom Datentyp GraphicalMedium zurück:

• CMS_INPUT_PICTURE

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

$CMS_VALUE(BEZEICHNER.METHODE)$

Die Größe von Medien kann über die Methode humanReadable(String, String) des Datentyps Number ermittelt werden.

Methoden auf GraphicalMedium-Objekten

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

Objekt wird von folgenden Formular-Objekten erzeugt:
CMS_INPUT_PICTURE

Methodenname	Rückgabetyp	Kurzbeschreibung	Verfügbar seit
compareTo(Comparable)	int
equals(Object)	boolean
getAltText	String	Gespeicherter Kommentar in der Eingabekomponente
getBorderWidth	Integer	Gespeicherter Rand in der Eingabekomponente
getClass	Class	Klasse des aufrufenden Objektes
getComment	String	Gespeicherter Kommentar in der Eingabekomponente
getElement	Referenceable
getElementName	String
getFile	File
getFolder	MediaFolder
getHeight	Integer	Gespeicherte Höhe in der Eingabekomponente
getHorizontalSpace	Integer	Gespeicherter horizontaler Abstand in der Eingabekomponente
getLanguage	Language
getMedium	Media	Gespeichertes Medium in der Eingabekomponente
getPicture	Picture
getRemoteName	String	Gespeicherter Name des Remote-Projektes
getType	BinaryMedium$Type
getVerticalSpace	Integer	Gespeicherter vertikaler Abstand in der Eingabekomponente
getWidth	Integer	Gespeicherte Breite in der Eingabekomponente
isCase(Object)	boolean
isEmpty	boolean	Prüft, ob ein Ausdruck leer ist
isNull	boolean	Prüft, ob ein Ausdruck Null ist
print	void
set(String, Object)	Object
setAltText(String)	void
setBorderWidth(Integer)	void
setComment(String)	void
setElementName(String)	void
setFolder(MediaFolder)	void
setHeight(Integer)	void
setHorizontalSpace(Integer)	void
setMedium(Media)	void
setRemoteName(String)	void
setVerticalSpace(Integer)	void
setWidth(Integer)	void
toJson	String	Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings)	4.2.14
toString	String
type	String

compareTo(Comparable)

Methodenname	Rückgabetyp	Verfügbar seit
compareTo(Comparable)	int

Übersicht

equals(Object)

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

Übersicht

getAltText

Die Methode .getAltText() (in Bean-Syntax: .altText) liefert den in der Eingabekomponente (vgl. Eingabekomponente FILE und PICTURE) 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

Übersicht

getBorderWidth

Die Methode .getBorderWidth() (in Bean-Syntax: .borderWidth) liefert den in der Eingabekomponente (vgl. Eingabekomponente PICTURE) gespeicherten Wert für das Feld Rand in Pixeln zurück.

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

Methodenname	Rückgabetyp	Verfügbar seit
getBorderWidth	Integer

Ü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

Methodenname	Rückgabetyp	Verfügbar seit
getClass	Class

Übersicht

getComment

Die Methode .getComment() (in Bean-Syntax: .comment) liefert den in der Eingabekomponente (vgl. Eingabekomponente FILE und PICTURE) 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.

Methodenname	Rückgabetyp	Verfügbar seit
getComment	String

Übersicht

getElement

Methodenname	Rückgabetyp	Verfügbar seit
getElement	Referenceable

Übersicht

getElementName

Methodenname	Rückgabetyp	Verfügbar seit
getElementName	String

Übersicht

getFile

Methodenname	Rückgabetyp	Verfügbar seit
getFile	File

Übersicht

getFolder

Methodenname	Rückgabetyp	Verfügbar seit
getFolder	MediaFolder

Übersicht

getHeight

Die Methode .getHeight() (in Bean-Syntax: .height) liefert den in der Eingabekomponente (vgl. Eingabekomponente PICTURE) gespeicherten Wert für das Feld Höhe zurück.

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

Methodenname	Rückgabetyp	Verfügbar seit
getHeight	Integer

Übersicht

getHorizontalSpace

Die Methode .getHorizontalSpace() (in Bean-Syntax: .horizontalSpace) liefert den in der Eingabekomponente (vgl. Eingabekomponente PICTURE) gespeicherten Wert für das Feld hAbstand in Pixeln zurück.

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

Methodenname	Rückgabetyp	Verfügbar seit
getHorizontalSpace	Integer

Übersicht

getLanguage

Methodenname	Rückgabetyp	Verfügbar seit
getLanguage	Language

Übersicht

getMedium

Die Methode .getMedium() (in Bean-Syntax: .medium) liefert das in der Eingabekomponente (vgl. Eingabekomponenten FILE und PICTURE) 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

Übersicht

getPicture

Methodenname	Rückgabetyp	Verfügbar seit
getPicture	Picture

Übersicht

getRemoteName

Die Methode .getRemoteName() (in Bean-Syntax: .remoteName) liefert den in der Eingabekomponente (vgl. Eingabekomponente FILE und PICTURE) 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

Übersicht

getType

Methodenname	Rückgabetyp	Verfügbar seit
getType	BinaryMedium$Type

Übersicht

getVerticalSpace

Die Methode .getVerticalSpace() (in Bean-Syntax: .verticalSpace) liefert den in der Eingabekomponente (vgl. Eingabekomponente PICTURE) gespeicherten Wert für das Feld vAbstand in Pixeln zurück.

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

Methodenname	Rückgabetyp	Verfügbar seit
getVerticalSpace	Integer

Übersicht

getWidth

Die Methode .getWidth() (in Bean-Syntax: .width) liefert den in der Eingabekomponente (vgl. Eingabekomponente PICTURE) gespeicherten Wert für das Feld Breite zurück.

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

Methodenname	Rückgabetyp	Verfügbar seit
getWidth	Integer

Übersicht

isCase(Object)

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

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

Methodenname	Rückgabetyp	Verfügbar seit
isEmpty	boolean

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

Methodenname	Rückgabetyp	Verfügbar seit
isNull	boolean

Übersicht

print

Methodenname	Rückgabetyp	Verfügbar seit
print	void

Übersicht

set(String, Object)

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

Übersicht

setAltText(String)

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

Übersicht

setBorderWidth(Integer)

Methodenname	Rückgabetyp	Verfügbar seit
setBorderWidth(Integer)	void

Übersicht

setComment(String)

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

Übersicht

setElementName(String)

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

Übersicht

setFolder(MediaFolder)

Methodenname	Rückgabetyp	Verfügbar seit
setFolder(MediaFolder)	void

Übersicht

setHeight(Integer)

Methodenname	Rückgabetyp	Verfügbar seit
setHeight(Integer)	void

Übersicht

setHorizontalSpace(Integer)

Methodenname	Rückgabetyp	Verfügbar seit
setHorizontalSpace(Integer)	void

Übersicht

setMedium(Media)

Methodenname	Rückgabetyp	Verfügbar seit
setMedium(Media)	void

Übersicht

setRemoteName(String)

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

Übersicht

setVerticalSpace(Integer)

Methodenname	Rückgabetyp	Verfügbar seit
setVerticalSpace(Integer)	void

Übersicht

setWidth(Integer)

Methodenname	Rückgabetyp	Verfügbar seit
setWidth(Integer)	void

Übersicht

toJson

Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings)

Methodenname	Rückgabetyp	Verfügbar seit
toJson	String	4.2.14

Übersicht

toString

Methodenname	Rückgabetyp	Verfügbar seit
toString	String

Übersicht

type

Methodenname	Rückgabetyp	Verfügbar seit
type	String

Übersicht