LinkTreeInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (hat „LinkTreeInformation“ nach „LinkTreeInformation (Objekt)“ verschoben)
 
(9 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
LinkTreeInformation-Objekte enthalten die Definitionen für einen Baum, der sich aus Verlinkungen einzelner Artikel oder Resource ergibt.
+
LinkTreeInformation-Objekte enthalten die Definitionen für einen Baum, der sich aus Verlinkungen einzelner Artikel oder Resource ergibt. LinkTrees werden mit dem Tag [[sp:linktree]] erzeugt.
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 16: Zeile 16:
 
|-
 
|-
 
| field
 
| field
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Element]]
 
| [[Element]]
 
| Root-Element dieser Information
 
| 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
 
| 1
 
|-
 
|-
Zeile 36: Zeile 46:
 
|-
 
|-
 
| attributes
 
| attributes
| [[Collection]]
+
| [[Collection]]&nbsp;<[[String]]>
| Liste der Attribute-Name der Article oder -Resourcen, auf die der Baum bei Änderungen reagieren soll
+
| Liste der Attribute-Namen der Article oder -Resourcen, auf die der Baum bei Änderungen reagieren soll
 
| 1
 
| 1
 
|-
 
|-
 
| sortkeys
 
| sortkeys
| [[Collection]]
+
| [[Collection]]&nbsp;<[[String]]>
| Liste der Attribute-Name der Article oder -Resourcen, nach denen sortiert werden soll
+
| Liste der Attribute-Namen der Article oder -Resourcen, nach denen sortiert werden soll
 
| 1
 
| 1
 
|-
 
|-
 
| sortsequence
 
| sortsequence
| [[Collection]]
+
| [[Collection]]&nbsp;<[[String]]>
| Liste der Sortierreihenfolgen für <code>sortkeys</code> (<code>asc</code> oder <code>desc</code>)
+
| Liste der Sortierreihenfolge für <code>sortkeys</code> (<code>asc</code> oder <code>desc</code>)
 
| 1
 
| 1
 
|-
 
|-
 
| sorttypes
 
| sorttypes
| [[Collection]]
+
| [[Collection]]&nbsp;<[[String]]>
| Liste der Sortierarten für <code>sortkeys</code> (<code>text</code>, <code>number</code> oder <code>date</code>)
+
| Liste der Sortierart für <code>sortkeys</code> (<code>text</code>, <code>number</code> oder <code>date</code>)
 
| 1
 
| 1
 
|-
 
|-
Zeile 61: Zeile 71:
 
|}
 
|}
  
 +
==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>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_des_Inhalts_prüfen]]
 
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

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

Name

LinkTreeInformation - Definition einen LinkTrees

Beschreibung

LinkTreeInformation-Objekte enthalten die Definitionen für einen Baum, der sich aus Verlinkungen einzelner Artikel oder Resource ergibt. LinkTrees werden mit dem Tag sp:linktree erzeugt.

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
isEmpty Boolean true, wenn die Größe der Binäredaten 0 ist. 1
rootElement ID Root-Article oder -Resource, ab der der Baum beginnt 1
attributes Collection <String> Liste der Attribute-Namen der Article oder -Resourcen, auf die der Baum bei Änderungen reagieren soll 1
sortkeys Collection <String> Liste der Attribute-Namen der Article oder -Resourcen, nach denen sortiert werden soll 1
sortsequence Collection <String> Liste der Sortierreihenfolge für sortkeys (asc oder desc) 1
sorttypes Collection <String> Liste der Sortierart für sortkeys (text, number oder date) 1
parentlink String Attribute-Name der Article oder -Resourcen des Links über den der Baum aufgebaut wird 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