SimpleInformation (Objekt): Unterschied zwischen den Versionen

Aktuelle Version vom 4. November 2015, 13:15 Uhr

Name

SimpleInformation - Einfache Text- und Link-Daten

Beschreibung

Ein SimpleInformation-Objekt enthält einfachen Content wie Texte und Links. Alle Content-Typen liegen als Liste vor. Dies ist notwendig, da ein SimpleInformation-Objekt beispielsweise durch eine Multi-Select-Box erzeugt werden kann (siehe sp:select). Alle ausgewählen Einträge der Select-Box müssen in diesem Information-Objekt als Collection abgelegt werden. In den meisten Fällen beinhaltet ein SimpleInformation-Objekt jedoch nur einen Text, oder einen Linktext mit einem Link. Für diese einfachen Fälle wurden einige Sonderregeln im Umgang mit Collection eingeführt. Siehe dazu „Sonderregelung“.

Ausgabe eines Textfeldes

Angenommen sp_title sei ein SimpleInformation-Objekt, das lediglich ein Text-Feld enthält. Dieser Text kann mit dem Attribut text erfragt werden. Um diesen Text mit sp:print auszugeben, könnte, da es sich um eine Collection handelt, das erste Element der Liste ausgegeben werden.

<sp:print name="sp_title.text[0]"/>

Da bei der Ausgabe einer Collection alle Einträge der Liste kommasepariert ausgegeben werden und dieses Text-Feld nur einen Eintrag enthält, kann auf den Index-Zugriff verzichtet werden.

<sp:print name="sp_title.text"/>

Da das Text-Feld für dieses Beispiel verwendet wurde, kann auch auf .text verzichtet werden, weil ein SimpleInformation-Objekt sein Text-Feld ausgibt, wenn es ausgegeben wird.

<sp:print name="sp_title"/>

Ausgabe eines Textfelds über einen Link

Soll nun das Feld sp_title über einen Link ausgegeben werden, kann wie oben der Index-Zugriff verwendet werden.

<sp:print name="sp_mylink.link[0].sp_title"/>

Durch die Sonderregelung in Collection (siehe „Sonderregelung“) kann auf den Index-Zugriff verzichtet werden, weil ohne Angabe des Index, der erste Eintrag der Liste verwendet wird.

<sp:print name="sp_mylink.link.sp_title"/>

Auf die Angabe von link kann nicht verzichtet werden, da text das Default-Attribut ist und nicht link. Damit ist <sp:print name="sp_mylink.link[0].sp_title[0]"/> equivalent zu <sp:print name="sp_mylink.link.sp_title"/>

Ausgabe

Bei der Ausgabe dieses Objekts, wird der Inhalt des text-Attibutes ausgegeben. Besteht das text-Attribut aus mehreren Einträgen, werden diese kommasepariert ausgegeben (siehe auch „Ausgabe“).

Attribute

Attribut	Type	Beschreibung	ab IES Version
id	ID	ID des Objektes	1
field	String	Variablenname des Objektes	1
lastField	String	Variablenname des Objektes ohne Struktur-Date	2.13
root	Element	Root-Element dieser Information	1
parent	ID	ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein	1
locale	Locale	Sprache, für die die Information gilt	1
isEmpty	Boolean	`true`, wenn das Objekt leer ist	1
all	Collection <Information>	Liefert eine Liste alle Unter-Informationen	1
flat	Collection <Information>	Liefert eine Liste aller Unter-Informationen ohne Struktierungs-Objekten wie `ListInformations`, `ListItemInformations` oder `SubInformations`	1
text (default-Attribut)	Collection <String>	Liste der Texte dieser Information. Die Liste besteht aus `String`-Objekten	1
date	Collection <Date>	Liste der Daten dieser Information. Die Liste besteht aus `Date`-Objekten	1
number	Collection <Number>>	Liste der Nummern dieser Information. Die Liste besteht aus `Number`-Objekten	1
mail	Collection <String>	Liste der E-Mail-Adressen dieser Information. Die Liste besteht aus `String`-Objekten	1
url	Collection <String>	Liste der URLs dieser Information. Die Liste besteht aus `String`-Objekten	1
linktext	Collection <String>	Liste der Link-Texte dieser Information. Die Liste besteht aus `String`-Objekten	1
link	Collection <ID>	Liste der Links dieser Information. Die Liste besteht aus `ID`-Objekten	1
navlink	Collection <ID>	Liste der Navlinks dieser Information. Die Liste besteht aus `ID`-Objekten	1
systemlink	Collection <ID>	Liste der Systemlinks dieser Information. Die Liste besteht aus `ID`-Objekten	1
categorylink	Collection <ID>	Liste der Categorylinks dieser Information. Die Liste besteht aus `ID`-Objekten	1
keywordlink	Collection <ID>	Liste der Keywordlinks dieser Information. Die Liste besteht aus `ID`-Objekten	1

Methoden

Methode	Rückgabewert	Beschreibung	ab IES Version
`toXip(Boolean emptyFields)`	String	Erzeugt XML-Daten im XIP-Format für dieses Objekt	2.14

String toXip(Boolean emptyFields)

Erzeugt XML-Daten im XIP-Format für dieses Objekt.

Parameter

Boolean emptyFields: Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).

Rückgabewert

String: XML-Daten im XIP-Format

@@ Zeile 3: / Zeile 3: @@
 ==Beschreibung==
-Ein SimpleInformation-Objekt enthält einfachen Content wie Texte und Links. Alle Content-Typen liegen als Liste vor. Dies ist notwendig, da ein SimpleInformation-Objekt beispielsweise durch eine Multi-Select-Box erzeugt werden kann (siehe <code>sp:select</code>). Alle ausgewählen Einträge der Select-Box müssen in diesem Information-Objekt als Collection abgelegt werden. In den meisten Fällen beinhaltet ein SimpleInformation-Objekt jedoch nur einen Text, oder einen Linktext mit einem Link. Für diese einfachen Fälle wurden einige Sonderregeln im Umgang mit <code>Collection</code> eingeführt. Siehe dazu „Sonderregelung“.
+Ein SimpleInformation-Objekt enthält einfachen Content wie Texte und Links. Alle Content-Typen liegen als Liste vor. Dies ist notwendig, da ein SimpleInformation-Objekt beispielsweise durch eine Multi-Select-Box erzeugt werden kann (siehe <code>sp:select</code>). Alle ausgewählen Einträge der Select-Box müssen in diesem Information-Objekt als Collection abgelegt werden. In den meisten Fällen beinhaltet ein SimpleInformation-Objekt jedoch nur einen Text, oder einen Linktext mit einem Link. Für diese einfachen Fälle wurden einige Sonderregeln im Umgang mit <code>Collection</code> eingeführt. Siehe dazu „[[Collection#Sonderregelung|Sonderregelung]]“.
 ==Ausgabe eines Textfeldes==
-Angenommen <code>sp_title</code> sei ein SimpleInformation-Objekt, daß lediglich ein Text-Feld enthält. Dieser Text kann mit dem Attribut <code>text</code> erfragt werden. Um diesen Text mit <code>sp:print</code> auszugeben, könnte, da es sich um eine <code>Collection</code> handelt, das erste Element der Liste ausgegeben werden.
+Angenommen <code>sp_title</code> sei ein SimpleInformation-Objekt, das lediglich ein Text-Feld enthält. Dieser Text kann mit dem Attribut <code>text</code> erfragt werden. Um diesen Text mit <code>sp:print</code> auszugeben, könnte, da es sich um eine <code>Collection</code> handelt, das erste Element der Liste ausgegeben werden.
 <code><sp:print name="sp_title.text[0]"/></code>
@@ Zeile 14: / Zeile 14: @@
 <code><sp:print name="sp_title.text"/></code>
-Da das Text-Feld für dieses Beispiel verwendet wurde, kann auch auf <code>.text</code> verzichtet werden, da ein <code>SimpleInformation</code>-Objekt sein Text-Feld ausgibt, wenn es ausgegeben wird.
+Da das Text-Feld für dieses Beispiel verwendet wurde, kann auch auf <code>.text</code> verzichtet werden, weil ein <code>SimpleInformation</code>-Objekt sein Text-Feld ausgibt, wenn es ausgegeben wird.
 <code><sp:print name="sp_title"/></code>
 ==Ausgabe eines Textfelds über einen Link==
-Soll nun das Feld <code>sp_title</code> über einen Link ausgegeben werden, kann wie oben der Index-Zugriff verwendet werden
+Soll nun das Feld <code>sp_title</code> über einen Link ausgegeben werden, kann wie oben der Index-Zugriff verwendet werden.
 <code><sp:print name="sp_mylink.link[0].sp_title"/></code>
-Durch die Sonderregelung in <code>Collection</code> (siehe „Sonderregelung“) kann auf den Index-Zugriff verzichtet werden, da ohne Angabe des Index, der erste Eintrag der Liste verwendet wird.
+Durch die Sonderregelung in <code>Collection</code> (siehe „Sonderregelung“) kann auf den Index-Zugriff verzichtet werden, weil ohne Angabe des Index, der erste Eintrag der Liste verwendet wird.
 <code><sp:print name="sp_mylink.link.sp_title"/></code>
@@ Zeile 34: / Zeile 34: @@
 ==Attribute==
-{| class="prettytable"
+{| class="prettytable sortable"
 |- class="hintergrundfarbe1"
 ! Attribut || Type || Beschreibung || ab IES Version
@@ Zeile 44: / Zeile 44: @@
 |-
 | field
-| [[Variable]]
+| [[String]]
 | Variablenname des Objektes
 | 1
+|-
+| lastField
+| [[String]]
+| Variablenname des Objektes ohne Struktur-Date
+| 2.13
 |-
 | root
 | [[Element]]
 | Root-Element dieser Information
+| 1
+|-
+| parent
+| [[ID]]
+| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 | 1
 |-
@@ Zeile 64: / Zeile 74: @@
 |-
 | all
-| [[Collection]]
+| [[Collection]]&nbsp;<[[Information]]>
 | Liefert eine Liste alle Unter-Informationen
 | 1
 |-
 | flat
-| [[Collection]]
+| [[Collection]]&nbsp;<[[Information]]>
 | Liefert eine Liste aller Unter-Informationen ohne Struktierungs-Objekten wie <code>ListInformations</code>, <code>ListItemInformations</code> oder <code>SubInformations</code>
 | 1
 |-
 | text (default-Attribut)
-| [[Collection]]
+| [[Collection]]&nbsp;<[[String]]>
 | Liste der Texte dieser Information. Die Liste besteht aus <code>String</code>-Objekten
 | 1
 |-
 | date
-| [[Collection]]
+| [[Collection]]&nbsp;<[[Date]]>
 | Liste der Daten dieser Information. Die Liste besteht aus <code>Date</code>-Objekten
 | 1
 |-
 | number
-| [[Collection]]
+| [[Collection]]&nbsp;<[[Number]]>>
 | Liste der Nummern dieser Information. Die Liste besteht aus <code>Number</code>-Objekten
 | 1
 |-
 | mail
-| [[Collection]]
+| [[Collection]]&nbsp;<[[String]]>
-| Liste der Email-Adressen dieser Information. Die Liste besteht aus <code>String</code>-Objekten
+| Liste der E-Mail-Adressen dieser Information. Die Liste besteht aus <code>String</code>-Objekten
 | 1
 |-
 | url
-| [[Collection]]
+| [[Collection]]&nbsp;<[[String]]>
-| Liste der URL's dieser Information. Die Liste besteht aus <code>String</code>-Objekten
+| Liste der URLs dieser Information. Die Liste besteht aus <code>String</code>-Objekten
-| 1
-|-
-| mail
-| [[Collection]]
-| Liste der Daten dieser Information. Die Liste besteht aus <code>String</code>-Objekten
 | 1
 |-
 | linktext
-| [[Collection]]
+| [[Collection]]&nbsp;<[[String]]>
 | Liste der Link-Texte dieser Information. Die Liste besteht aus <code>String</code>-Objekten
 | 1
 |-
 | link
-| [[Collection]]
+| [[Collection]]&nbsp;<[[ID]]>
 | Liste der Links dieser Information. Die Liste besteht aus <code>ID</code>-Objekten
 | 1
 |-
 | navlink
-| [[Collection]]
+| [[Collection]]&nbsp;<[[ID]]>
 | Liste der Navlinks dieser Information. Die Liste besteht aus <code>ID</code>-Objekten
 | 1
 |-
 | systemlink
-| [[Collection]]
+| [[Collection]]&nbsp;<[[ID]]>
 | Liste der Systemlinks dieser Information. Die Liste besteht aus <code>ID</code>-Objekten
 | 1
 |-
 | categorylink
-| [[Collection]]
+| [[Collection]]&nbsp;<[[ID]]>
 | Liste der Categorylinks dieser Information. Die Liste besteht aus <code>ID</code>-Objekten
 | 1
 |-
 | keywordlink
-| [[Collection]]
+| [[Collection]]&nbsp;<[[ID]]>
 | Liste der Keywordlinks dieser Information. Die Liste besteht aus <code>ID</code>-Objekten
 | 1
 |}
+==Methoden==
+{| class="prettytable sortable"
+|- class="hintergrundfarbe1"
+! Methode || Rückgabewert || Beschreibung || ab IES Version
+|-
+| <code>toXip([[Boolean]] emptyFields)</code>
+| String
+| Erzeugt XML-Daten im XIP-Format für dieses Objekt
+| 2.14
+|}
+;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
+:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
+:;Parameter
+::;<code>Boolean emptyFields</code>
+:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
+:;Rückgabewert
+::;String
+:::XML-Daten im XIP-Format
 <noinclude>
 [[Category:Objekte]]
-[[Category:Qualität_des_Inhalts_prüfen]]
-[[Category:Qualität_der_Sprache_prüfen]]
 [[Category:Qualität_des_Codes_prüfen]]
 </noinclude>