Wertebereich des Datentyps Table
In FirstSpirit gibt es die Möglichkeit, Daten in Tabellenform zu erfassen. Solche Daten werden üblicherweise strukturiert in der Auszeichnungssprache XML abgespeichert. Dies ist notwendig, da (zusätzlich zu den Zeilen und Zellen) einige Inhalte besondere Auszeichnungen, Hervorhebungen und Informationen für bestimmte Teile enthalten müssen.
Um so gespeicherte Inhalte ausgeben oder weiterverarbeiten zu können, liefern diese Eingabekomponenten ein Objekt vom Datentyp Table zurück.
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 Table 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 Table-Objekten
In der unten angegebenen Tabelle werden alle Methoden aufgelistet, die auf Objekten von Datentyp Table aufgerufen werden können:
Methodenname |
Rückgabetyp |
Kurzbeschreibung |
Verfügbar seit |
addColumn(int) |
void |
Adds a new column at the specified index. |
4.0.17 |
addRow(int) |
void |
Adds a new row at the specified index. |
4.0.17 |
deleteColumn(int) |
void |
Deletes the column with the specified index |
4.0.17 |
deleteRow(int) |
void |
Deletes the row with the specified index |
4.0.17 |
diff(Element) |
Element |
Compute a difference between this element and the given one. |
4.0.59 |
equals(Object) |
boolean |
|
|
getCell(int, int) |
TableCell |
Gets the cell of this table with the given row & col index or null if no cell exists with these indices. |
4.0.17 |
getClass |
Class |
Klasse des aufrufenden Objektes |
|
getColumns |
int |
Anzahl der Spalten einer Tabelle |
4.0.17 |
getDom |
Element |
Returns the element node of this table. |
4.0.17 |
getRows |
int |
Anzahl der Zeilen einer Tabelle |
4.0.17 |
isCase(Object) |
boolean |
|
|
isEmpty |
boolean |
Prüft, ob ein Ausdruck leer ist |
4.0.17 |
isNull |
boolean |
Prüft, ob ein Ausdruck Null ist |
|
print |
void |
default print behaviour of a dom table: print all contained rows and cells |
4.0.0 |
replace(Table) |
void |
Replaces this table with the given table. |
4.0.36 |
set(String, Object) |
Object |
|
|
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 |
|
|
addColumn(int)
Adds a new column at the specified index.
Methodenname |
Rückgabetyp |
Verfügbar seit |
addColumn(int) |
void |
4.0.17 |
Übersicht
addRow(int)
Adds a new row at the specified index.
Methodenname |
Rückgabetyp |
Verfügbar seit |
addRow(int) |
void |
4.0.17 |
Übersicht
deleteColumn(int)
Deletes the column with the specified index
Methodenname |
Rückgabetyp |
Verfügbar seit |
deleteColumn(int) |
void |
4.0.17 |
Übersicht
deleteRow(int)
Deletes the row with the specified index
Methodenname |
Rückgabetyp |
Verfügbar seit |
deleteRow(int) |
void |
4.0.17 |
Übersicht
diff(Element)
Compute a difference between this element and the given one.
Methodenname |
Rückgabetyp |
Verfügbar seit |
diff(Element) |
Element |
4.0.59 |
Übersicht
equals(Object)
Methodenname |
Rückgabetyp |
Verfügbar seit |
equals(Object) |
boolean |
|
Übersicht
getCell(int, int)
Gets the cell of this table with the given row & col index or null if no cell exists with these indices.
Methodenname |
Rückgabetyp |
Verfügbar seit |
getCell(int, int) |
TableCell |
4.0.17 |
Ü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
getColumns
Die Methode .getColumns() (in Bean-Syntax: .columns) liefert die Anzahl der Spalten einer Tabelle zurück.
Das Rückgabeobjekt ist eine Ganzzahl (siehe java.lang.Integer).
Methodenname |
Rückgabetyp |
Verfügbar seit |
getColumns |
int |
4.0.17 |
Übersicht
getDom
Returns the element node of this table.
Methodenname |
Rückgabetyp |
Verfügbar seit |
getDom |
Element |
4.0.17 |
Übersicht
getRows
Die Methode .getRows() (in Bean-Syntax: .rows) liefert die Anzahl der Zeilen einer Tabelle zurück.
Das Rückgabeobjekt ist eine Ganzzahl (siehe java.lang.Integer).
Methodenname |
Rückgabetyp |
Verfügbar seit |
getRows |
int |
4.0.17 |
Ü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 |
4.0.17 |
Ü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
default print behaviour of a dom table: print all contained rows and cells
Methodenname |
Rückgabetyp |
Verfügbar seit |
print |
void |
4.0.0 |
Übersicht
replace(Table)
Replaces this table with the given table.
Methodenname |
Rückgabetyp |
Verfügbar seit |
replace(Table) |
void |
4.0.36 |
Übersicht
set(String, Object)
Methodenname |
Rückgabetyp |
Verfügbar seit |
set(String, Object) |
Object |
|
Übersicht
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 |
Übersicht
toString
Methodenname |
Rückgabetyp |
Verfügbar seit |
toString |
String |
|
Übersicht
type
Methodenname |
Rückgabetyp |
Verfügbar seit |
type |
String |
|
Übersicht