Datentyp DomElement

Wertebereich des Datentyps DomElement

Einige FirstSpirit Eingabekomponenten speichern Werte strukturiert in der Auszeichnungssprache XML ab. Dies ist notwendig, da einige Inhalte besondere Auszeichnungen, Hervorhebungen und Informationen für bestimmte Teile enthalten können.

Um die so gespeicherte Inhalte auszugeben oder weiter zu verarbeiten, liefern diese Eingabekomponenten ein Objekt vom Datentyp DomElement zurück.

CMS_INPUT_DOM

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

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

• CMS_INPUT_DOM

Auf diesem Objekt lassen sich dann mithilfe 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 DomElement-Objekten

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

addChangeListener(ValueChangeListener)

Übersicht

adopt(DomElement)

Übersicht

compareTo(Comparable)

Übersicht

diff(Element)

Übersicht

equals(Object)

Übersicht

get

Ü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

getRoot

Ü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

normalize

Neben der Erfassung und Formatierung von Fließtext kann die Eingabekomponente CMS_INPUT_DOM auch für die Erzeugung und Pflege von Listen und Tabellen verwendet werden.

Der Inhalt eines DOM-Editors wird strukturiert in Paragraphen. Die Darstellung eines Paragraphen erfolgt durch eine Formatvorlage. Dabei muss es sich um eine "Absatzformatvorlage" handeln ("Absatzformatierung", siehe Seite Formatvorlagen im Grundlagen-Kapitel). Diese Formatvorlage definiert neben der Darstellung im Editor auch die Ausgabe des Inhalts, der im DOM-Editor mit dieser Formatvorlage ausgezeichnet ist. Standardmäßig, das heißt für den Fall, in dem

• der Redakteur keine bestimmte Formatvorlage auswählt oder
• im Formular keine Absatzformatvorlage über die Tags FORMATS / TEMPLATE definiert ist

handelt es sich dabei um die Formatvorlage "Standard". Die Ausgabe erfolgt standardmäßig mit <p>-Tags, die den Inhalt eines Absatzes im DOM-Editor umschließen, also z. B.

<p>Dies ist ein <b>formatierter</b> Text.</p>

Je nach gewählter Formatvorlage können es aber auch andere Tags sein.

Auch im Falle von Listen und Tabellen werden Ein- und Ausgabe über die gewählte Absatzformatvorlage geregelt. Wird die Formatvorlage "Standard" für eine Liste oder Tabelle gewählt, wird die Ausgabe ebenfalls standardmäßig von <p>-Tags umschlossen.

Da ein <p>-Element als Blockelement gemäß HTML-Spezifikation keine weiteren Blockelemente (Listen, Tabellen) enthalten darf, kann ab FirstSpirit-Version 5.1R3 mithilfe der Methode .normalize die Ausgabe von CMS_INPUT_DOM so konfiguriert werden, dass Listen und Tabellen nicht von anderen Tags, die durch die für die Liste oder die Tabelle gültige Absatzformatvorlage erzeugt werden, umschlossen werden.

Beispiel:

$CMS_VALUE(pt_dom.normalize)$

Dabei ist pt_dom der Bezeichner für eine CMS_INPUT_DOM-Eingabekomponente.

Ohne Verwendung von .normalize können Listen und Tabellen in der HTML-Ausgabe von Tags umschlossen sein, das aus der gewählten Absatzformatvorlage stammt, z. B.

<p>Fließtext</p>
<p>Fließtext</p>
<p>
    <ul>
        <li>Listenelement 1</li>
        <li>Listenelement 2</li>
        <li>Listenelement 3</li>
    </ul>
</p>
<p>Fließtext</p>

Mit Verwendung von .normalize werden Listen und Tabellen in der Ausgabe nicht von Tags umschlossen, die aus der gewählten Absatzformatvorlage stammen, z. B.

<p>Fließtext</p>
<p>Fließtext</p>
<ul>
<li>Listenelement 1</li>
<li>Listenelement 2</li>
<li>Listenelement 3</li>
</ul>
<p>Fließtext</p>

Übersicht

parseHtml(String)

Übersicht

print

Übersicht

removeChangeListener(ValueChangeListener)

Übersicht

renderToString

Die Methode .renderToString() (in Bean-Syntax: .renderToString) gibt ein DOM-Element als Zeichenkette aus. Dies ist notwendig, da die Daten z.B. in der Eingabekomponente DOM strukturiert als XML gespeichert werden. Beim Rendern des XMLs der Eingabekomponente werden dann die einzelnen Formatvorlagen angewendet.

Der Inhalt eines DOM-Elementes kann potentiell sehr groß sein. Weiterhin können beim Rendern viele Formatvorlagen angewendet werden. Beides ist sehr berechnungsintensiv und daher sollte die Methode renderToString nur im Ausnahmefall verwendet werden.

Übersicht

set(Element)

Übersicht

set(String)

Übersicht

set(String, Object)

Übersicht

toJson

Übersicht

toString

Übersicht

toText(boolean)

Übersicht

type

Übersicht