Typ PAGE

FS_LIST, Typ PAGE

Mithilfe des FS_LIST-Typs PAGE wird eine Liste von Absätzen der aktuellen Seite erstellt. Aus dieser können Absätze per Checkbox ausgewählt werden. Für jeden Absatz kann darüber hinaus eine Beschriftung vergeben werden, der bei der Ausgabe berücksichtigt werden kann.

Bei den Beispielen unten werden zunächst beispielhafte Konfigurationen für FS_LIST, Typ PAGE, vorgestellt (1)).

Im Anschluss wird dargestellt, wie bisher verwendete Konfigurationen von CMS_INPUT_SECTIONLIST durch FS_LIST ersetzt wird (2)).

Bei der Umstellung von CMS_INPUT_SECTIONLIST auf FS_LIST ist zu beachten, dass wenn Daten mit FS_LIST gespeichert wurden, diese bei einer evtl. späteren Rückkehr aufgrund eines abweichenden Datenformats nicht mehr von CMS_INPUT_SECTIONLIST gelesen und interpretiert werden können.

FS_LIST-Eingabekomponenten vom Typ PAGE sind immer sprachabhängig.

Access-API Anwendungsbeispiel
Die Beispiel-Implementierung FsListEditorValueExample veranschaulicht einige einfache Anwendungsfälle für den Lesenden-, Schreibenden-, Erstellenden-Zugriff auf das Daten-Objekt (FsListEditorValue) und dessen inneren Daten-Container (FormDataList) der Eingabekomponente anhand der FirstSpirit Access-API.

• Anwendungs-Beispiel: FsListEditorValueExample
• Daten-Objekt: FsListEditorValue
• Container-Typ: FormDataList

Parameter

Der nachfolgenden Tabelle können die Parameter der Eingabekomponente LIST entnommen werden.

Übersicht

name

Das Attribut "name" ist der Variablenname einer Eingabekomponente, mit dem in den Vorlagen - mit Hilfe von $CMS_VALUE()$ - das Ergebnisobjekt der Eingabekomponente verwendet oder der Inhalt ausgegeben werden kann.

Übersicht

allowEmpty

Mit dem Parameter "allowEmpty" wird festgelegt, ob für eine Eingabekomponente ein Wert angegeben werden muss oder nicht.

Bei der Angabe von allowEmpty="YES" ist eine Eingabe nicht zwingend, bei allowEmpty="NO" jedoch schon.

Eingabekomponenten mit allowEmpty="NO" werden auch als Pflichteingabekomponenten bezeichnet.

Der Standardwert für allowEmpty ist YES.

Übersicht

hFill

Die Anzeige einer Eingabekomponente erfolgt immer mit einer vordefinierten Breite.

Ist es aber gewünscht, dass die Eingabekomponente die volle zur Verfügung stehende Anzeigebreite nutzt, ist der Parameter hFill mit dem Wert YES anzugeben.

Übersicht

height

Mit dem Parameter height kann die Anzeigehöhe der Eingabekomponente auf eine Pixelzahl festgelegt werden.

Als Wert erwartet der Parameter eine Ganzzahl.

Wird der Parameter nicht angegeben, wird die Höhe der Eingabekomponente standardmäßig auf 500 Pixel gesetzt.

Je nach dem, wie Layout, Funktion (z. B. Aufklappverhalten) und ggf. der Parameter rows gewählt sind, sollte die Höhe nicht zu gering gewählt werden.

Befindet sich die Eingabekomponente in einer Gruppierung (CMS_GROUP), richtet sich die Höhe nach der Höhe der höchsten Eingabekomponente innerhalb der Gruppierung.

Übersicht

hidden

Mit dem Parameter "hidden" kann eine Eingabekomponente für den Redakteur ausgeblendet werden.

Bei der Angabe von hidden="YES" wird die Eingabekomponente ausgeblendet, bei hidden="NO" nicht.

Der Standardwert für hidden ist NO, so dass Eingabekomponenten standardmäßig für den Redakteur sichtbar sind.

Übersicht

noBreak

Mit dem Parameter noBreak kann der automatische Zeilenumbruch nach einer Eingabekomponente unterdrückt werden.

Um den automatischen Zeilenumbruch zu unterdrücken, ist der Parameter noBreak mit dem Wert "YES" anzugeben (noBreak="YES").

Übersicht

preset

Mit dem Attribut preset kann festgelegt werden, wie Vorgabewerte in einer Eingabekomponente behandelt werden (vgl. dazu auch Kapitel Vorgabewerte). Wird preset="default" gesetzt, wird der im Formular definierte Rückgriffwert verwendet. Nachträgliche Änderungen im Formular an diesem Wert wirken sich auf alle Verwendungen in den vom Redakteur gepflegten Eingabekomponenten aus, solange bis ein manueller Wert in die Eingabekomponente gesetzt wird. Dies ist die Standardeinstellung. Wird preset="copy" gesetzt, wird der durch den Redakteur gewählte Wert "hart" in der Eingabekomponente gespeichert. Nachträgliche Änderungen am Vorgabewert im Formular wirken sich nicht aus.

Übersicht

rows

Ist für die Eingabekomponente mit dem DATASOURCE-Typ DATABASE, INLINE oder SERVICE eine Übersicht definiert (<ADD component="overview" ... >), kann mit dem Parameter rows die Höhe der Übersicht beeinflusst werden. Dazu wird die Zahl der gewünschten Zeilen angegeben. Im DATASOURCE-Typ PAGE bezieht sich die über rows angegebene Zahl auf die Höhe der Eingabekomponente in Zeilen. Über eine horizontale Trennleiste zwischen Übersicht und Detailansichten kann die Höhe der Übersicht bzw. der Detailansichten vergrößert bzw. verkleinert werden.

Der Parameter erwartet als Wert eine Ganzzahl.

Standardwert ist 10.

Übersicht

width

Mit dem Parameter width kann die Anzeigebreite der Eingabekomponente in Pixel festgelegt werden.

Der Parameter erwartet als Wert eine Ganzzahl.

Wird der Parameter nicht angegeben so beträgt die Standardbreite 480 Pixel.

Der Parameter hat keine Auswirkung, wenn der Parameter hFill verwendet wird.

Übersicht

DATASOURCE

Mithilfe des Tags DATASOURCE wird definiert, auf welchen Datentyp die Eingabekomponente zurückgreifen soll.

Wird das Tag mehr als einmal für eine Eingabekomponente angegeben, wird beim Speichern immer die letzte/unterste Definition übernommen und alle anderen Definitionen entfernt.

Übersicht

type

Mit dem Pflichtparameter type wird der Datentyp, auf den die Eingabekomponente zurückgreifen soll, bzw. der Typ der Datenherkunft definiert.

Folgende Typen werden unterstützt:

• DATABASE: Mit diesem Parameter ist es möglich, eine Liste von Datensätzen zu erstellen. Die Tabellenvorlage, auf der die Datenquelle basiert, aus der Datensätze ausgewählt bzw. in die neue Datensätze angelegt werden sollen, muss mit dem Tag TABLE angegeben werden.
• INLINE: Mit diesem Parameter ist es möglich, eine Liste von Absätzen bzw. Verweisen zu erstellen. Ob eine Absatz- oder Verweisliste erstellt werden soll, muss über das Tag TEMPLATES, Parameter source definiert werden.
• PAGE: Mit diesem Parameter ist es möglich, eine Liste der Absätze der aktuellen Seite anzeigen zu lassen.
• SERVICE: Mit diesem Parameter ist es möglich, über ein Service-Modul extern Datenlieferanten anzubinden, die der Eingabekomponente Daten zur Verfügung stellen sollen. Weitere Informationen zur Konfiguration werden im FirstSpirit Entwicklerhandbuch für Komponenten bereitgestellt.

Übersicht

LABELS

Standardmäßig werden für Beschriftungen z. B. der Übersicht, Register, Balken und Tooltips

1. die Namen aller Eingabekomponenten, die in der ausgewählten Absatz-, Verweis- oder Tabellenvorlage enthalten sind (Bezeichner), in eckigen Klammern und
2. die Werte (falls vorhanden), die in den Eingabekomponenten gespeichert sind, wenn es sich um den Datentyp String handelt (z. B. CMS_INPUT_TEXT, CMS_INPUT_TEXTAREA, CMS_INPUT_DOM)

verwendet:

Über das Tag LABELS kann die Beschriftung beeinflusst werden.

Für den DATASOURCE-Typ PAGE wird LABELS / LABEL nicht unterstützt.

Für jede Sprache muss dazu ein Tag LABEL angegeben werden.

ACHTUNG: Es muss mindestens eine Definition für die Rückfallbeschriftung ("*") erfolgen:

<LABELS>
 <LABEL lang="*">...</LABEL>
</LABELS>

LABEL

Mit dem Tag LABEL kann für jede Sprache eine flexible, sprachabhängige Beschriftung definiert werden.

Um die Beschriftung für eine Sprache festzulegen, ist im Parameter lang die Abkürzung der Projektsprache anzugeben:

...
<LABEL lang="DE">...</LABEL>
<LABEL lang="EN">...</LABEL>
...

Rückfallwerte werden mit dem speziellen Sprachkürzel * ("für alle Sprachen") angegeben:

...
<LABEL lang="*">...</LABEL>
...

Bei dem Parameter lang handelt es sich um einen Pflichtparameter.

Der Beschriftungstext wird innerhalb eines öffnenden und schließenden <LABEL>-Tag angegeben (siehe Platzhalter TEXT).

Übersicht

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe , Kapitel "Sprach-Vorlagen"), angegeben, um festzulegen für welche Projektsprachen die Definitionen gelten sollen, z. B. DE für Deutsch, EN für Englisch, FR für Französisch usw. Folgende Zeichen können dabei beliebig oft angegeben werden: -, _, 0-9 und A-Z. Kleinbuchstaben werden nach dem Speichern der Vorlage automatisch in Großbuchstaben umgewandelt. Alternativ kann * für Rückfallwerte verwendet werden.

Übersicht

TEXT

An dieser Stelle kann eine alternative Beschriftung definiert werden.

Um auf die in den Eingabekomponenten gespeicherten Werte zurückgreifen zu können, steht das Systemobjekt #item zur Verfügung.

Im Falle des DATASOURCE-Typs DATABASE wird die Variable der Spalte (Bezeichner der Eingabekomponente) durch einen Punkt getrennt angehängt, z. B.

#item.cs_lastname

Ist die über FS_LIST referenzierte Tabelle mit einer weiteren Tabelle über eine Fremdschlüsselbeziehung verbunden, können in FS_LIST die Werte einer Spalte der verbundenen Tabelle für die Beschriftung herangezogen werden, indem #item mit der Fremdschlüsselbezeichnung sowie dem gewünschten Spaltennamen angegeben wird, z. B.

#item.product_Properties_Type.Name

wobei product_Properties_Type die Fremdschlüsselbezeichnung ist, Name der Name einer Spalte in der über product_Properties_Type definierten Tabelle.

Im Falle des DATASOURCE-Typs INLINE wird die Variable der jeweiligen Absatz- oder Verweisvorlage (Bezeichner der Eingabekomponente) durch einen Punkt getrennt angehängt, z. B.

#item.st_headline

In beiden Fällen sind auch Kombinationen der Werte mehrerer Eingabekomponenten möglich, z. B.

<LABELS>
 <LABEL lang="*">#item.cs_firstname + " " + #item.cs_lastname</LABEL>
</LABELS>

Um z. B. einen Alternativwert für die Anzeige für den Fall zu definieren, dass die betreffende Eingabekomponente nicht befüllt ist, kann die if(...)-Funktion verwendet werden, z. B.

<LABELS>
 <LABEL lang="*">if(#item.st_headline.isEmpty, "No headline", #item.st_headline)</LABEL>
</LABELS>

In diesem Beispiel wird der Text "No headline" angezeigt, wenn die Eingabekomponente nicht befüllt ist.

Im Falle des DATASOURCE-Typs INLINE können auch die Bezeichner von Eingabekomponenten unterschiedlicher Absatz- bzw- Verweisvorlagen angegeben werden. Dies bietet sich an, wenn die Auswahl nicht auf eine Vorlage beschränkt ist und die Bezeichner der Eingabekomponenten von Vorlage zu Vorlage variieren. Steht ein über #item angegebener Bezeichner in der vom Redakteur gewählten Vorlage nicht zur Verfügung, wird nichts ausgegeben.

Beispiel:
FS_LIST ermöglicht die Auswahl aus zwei Absatzvorlagen, von denen eine ein Textfeld mit dem Bezeichner "st_text" und eine ein Textfeld mit dem Bezeichner "st_headline" enthält.

Wählt der Redakteur nun die Absatzvorlage, die den Bezeichner "st_text" enthält, wird mit der Syntax

<LABELS>
 <LABEL lang="*">#item.st_text + #item.st_headline</LABEL>
</LABELS>

für die Beschriftung der gespeicherte Wert der Eingabekomponente "st_text" verwendet,
wählt der Redakteur die Absatzvorlage, die den Bezeichner "st_headline" enthält, wird der gespeicherte Wert der Eingabekomponente "st_headline" verwendet.

Enthält eine Vorlage beide Bezeichner, werden beide für die Beschriftung verwendet. Für diesen Fall sollte ein Trennzeichen vorgesehen werden, z. B.

<LABELS>
 <LABEL lang="*">#item.st_text + " " + #item.st_headline</LABEL>
</LABELS>

Es sollte darauf geachtet werden, dass die verwendeten Variablen (Bezeichner der Eingabekomponenten) korrekt angegeben werden, und die Variablen sollten auch tatsächlich in den zur Auswahl stehenden Vorlagen vorhanden sein. Ansonsten wird auf die Standardbeschriftung zurückgegriffen (Name und alle Werte aller Eingabekomponenten der gewählten Vorlage). Für eine optimale Übersichtlichkeit und Benutzerfreundlichkeit der Komponente sollte eine möglichst kurze Beschriftung gewählt werden.

Im Falle des DATASOURCE-Typs INLINE ist es zusätzlich möglich, die Vorlage eines Absatzes oder Verweises in der Liste zu ermitteln. Dazu steht das Systemobjekt #template zur Verfügung.

Der Referenzname der verwendeten Vorlage kann z. B. über folgende Syntax für die Beschriftung ausgegeben werden:

<LABELS>
 <LABEL lang="*">#template.uid</LABEL>
</LABELS>

Auch hier kann die if(...)-Funktion verwendet werden, um eine Beschriftung in Abhängig von der gewählten Vorlage zu realisieren.

Für den DATASOURCE-Typ PAGE wird LABELS / LABEL nicht unterstützt.

COLUMNS

Standardmäßig zeigt die Eingabekomponente eine Liste aller Absätze der Seite, jeweils mit einer Checkbox zur Auswahl einzelner Absätze und einem Textfeld, über das für jeden Absatz ein Name vergeben werden kann.

Zusätzlich kann über COLUMNS / COLUMN auch eine Spalte mit fortlaufender Nummerierung eingeblendet werden.

Über das Tag COLUMNS kann die Anzeige verändert werden.

COLUMN

Mit dem Tag COLUMN können Eigenschaften für jeweils eine Spalte festgelegt werden.

Der Name der Spalte, für die die Eigenschaften gelten sollen, wird innerhalb eines öffnenden und schließenden COLUMN-Tags angegeben (siehe Platzhalter TEXT innerhalb des COLUMNS-Tags).

Übersicht

resizable

Der Parameter resizable hat für diesen DATASOURCE-Typ keine Auswirkung.

Übersicht

show

Mit dem Parameter show kann definiert werden, ob eine Spalte (siehe COLUMNS / COLUMN / TEXT) in der Eingabekomponente angezeigt wird oder nicht.

Wird COLUMNS / COLUMN nicht angegeben, wird beim Speichern automatisch

<COLUMNS>
 <COLUMN show="no">#identifier</COLUMN>
</COLUMNS>

ergänzt. In dieser Konfiguration werden alle Spalten bis auf die Spalte mit der fortlaufenden Nummerierung angezeigt.

Wird für eine Spalte COLUMN angegeben, wird sie standardmäßig angezeigt (show="YES").

Soll eine Spalte ausgeblendet werden, muss show="NO" gesetzt werden. Andere Parameter innerhalb von COLUMN für die betreffende Spalte haben dann keine Auswirkung.

Übersicht

sortOrder

Der Parameter sortOrder hat für diesen DATASOURCE-Typ keine Auswirkung.

Übersicht

width

Mit dem Parameter width kann die Anzeigebreite der Spalte in Pixel festgelegt werden.

Der Parameter erwartet als Wert eine Ganzzahl.

Wird der Parameter nicht angegeben, so richtet sich die Spaltenbreite nach dem Inhalt der Spalten.

Übersicht

TEXT

An dieser Stelle wird die Spalte definiert, für die die Eigenschaften gelten sollen.

Dazu werden folgende Bezeichner verwendet:

• #identifier: Spalte mit fortlaufender Nummerierung
• #text: Spalte mit Checkbox

Dieser Bezeichner wird von einem öffnenden und schließenden COLUMN-Tag umschlossen.

Wird COLUMNS / COLUMN nicht angegeben, wird folgende Konfiguration beim Speichern der Vorlage automatisch ergänzt:

<COLUMNS>
 <COLUMN show="no">#identifier</COLUMN>
</COLUMNS>

LANGINFOS

Über das Tag LANGINFOS können für jede Eingabekomponente sprachabhängige Angaben definiert werden, z. B. wie die Eingabekomponente in den unterschiedlichen Projektsprachen betitelt sein soll (Parameter label), welcher Tooltip angezeigt werden soll (Parameter description) usw. Aus Gründen der Übersichtlichkeit werden dabei Definitionen, die in mehreren Sprachen identisch sind, zusammengefasst. So wird z. B. aus

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

Die Definition für den Rückfallwert (*) bleibt dabei immer erhalten, von Definitionen für Sprachen mit gleichen Werten bleibt immer die oberste erhalten.

Ab FirstSpirit-Version 4.2R4 kann der Rückfallwert weggelassen werden. Dann wird beim Speichern automatisch die zuerst definierte Sprache als Rückfallwert verwendet, z. B. wird aus

<LANGINFOS>
 <LANGINFO lang="EN" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

LANGINFO

Mit dem Tag LANGINFO werden Werte oder Attribute für eine Sprache oder aber für die Verwendung als Rückfallwerte angegeben.

Um Werte bzw. Attribute für eine Sprache anzugeben ist im Parameter lang die Abkürzung der Projektsprache anzugeben:

...
<LANGINFO lang="DE".../>
...

Rückfallwerte werden mit dem speziellen Sprachkürzel * ("für alle Sprachen") angegeben:

...
<LANGINFO lang="*".../>
...

Bei dem Parameter lang handelt es sich um einen Pflichtparameter.

Übersicht

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe , Kapitel "Sprach-Vorlagen"), angegeben, um festzulegen für welche Projektsprachen die Definitionen gelten sollen, z. B. DE für Deutsch, EN für Englisch, FR für Französisch usw. Folgende Zeichen können dabei beliebig oft angegeben werden: -, _, 0-9 und A-Z. Kleinbuchstaben werden nach dem Speichern der Vorlage automatisch in Großbuchstaben umgewandelt. Alternativ kann * für Rückfallwerte verwendet werden.

Übersicht

description

Mit dem Parameter description kann eine Beschreibung angegeben werden, die zur Anzeige eines Tooltipps (Mouse-Over) genutzt wird.

Übersicht

label

Mit dem Parameter label wird die Oberflächenbeschriftung für Eingabe- und Visualisierungkomponenten angegeben.

Übersicht

LanguageAbbreviation	Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte
PositiveInteger	Positive Ganzzahl
YesNo	Schalter, um ein Attribut anzuwenden oder nicht NO Attribut nicht anwenden YES Attribut anwenden
SortOrder	Schalter, um die Sortierreihenfolge der Einträge festzulegen KEEP_ORDER Sortierreihenfolge der Einträge beibehalten ASCENDING Einträge aufsteigend alphabetisch sortieren DESCENDING Einträge absteigend alphabetisch sortieren
String	Eine beliebige Zeichenkette
Preset	Behandlung von Vorgabewerten Copy Verwendung des vom Redakteur gewählten Wertes, nachträgliche Änderungen wirken sich nicht aus Default Verwendung des im Formular definierten Rückgriffwerts, solange kein manueller Wert gesetzt wird
DataSourceType	Datenherkunfts-Typen DATABASE Zugriff auf Daten einer Tabelle INLINE Zugriff auf Daten über Absatz- oder Verweisvorlagen PAGE Zugriff auf Absätze der aktuellen Seite SERVICE Zugriff auf Daten aus externen Komponenten oder Modulen
Designator	Eindeutiger Bezeichner variabler Länge; muss mit einem Buchstaben oder Unterstrich beginnen und darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z.B. "fr_st_varName"

Beispiele

1) Konfigurationsbeispiel FS_LIST, Typ PAGE

<FS_LIST name="BEZEICHNER">
    <DATASOURCE type="page"/>
      <LANGINFOS>
        <LANGINFO lang="*" label="Absätze dieser Seite"/>
      </LANGINFOS>
</FS_LIST>

2) Abbildung der Eingabekomponente CMS_INPUT_SECTIONLIST

Mithilfe der Eingabekomponente FS_LIST können die Funktionalitäten der Eingabekomponente CMS_INPUT_SECTIONLIST abgebildet werden.

Bei der Umstellung von CMS_INPUT_SECTIONLIST auf FS_LIST ist zu beachten, dass wenn Daten mit FS_LIST gespeichert wurden, diese bei einer evtl. späteren Rückkehr aufgrund eines abweichenden Datenformats nicht mehr von CMS_INPUT_SECTIONLIST gelesen und interpretiert werden können.

Beispiel-Formular CMS_INPUT_SECTIONLIST:

<CMS_INPUT_SECTIONLIST name="BEZEICHNER">
        <LANGINFOS>
          <LANGINFO lang="*" label="Absätze dieser Seite"/>
        </LANGINFOS>
</CMS_INPUT_SECTIONLIST>

Abbildung durch FS_LIST:

<FS_LIST name="BEZEICHNER">
    <DATASOURCE type="page">
      <COLUMNS>
        <COLUMN show="no">#identifier</COLUMN>
      </COLUMNS>
    </DATASOURCE>
      <LANGINFOS>
        <LANGINFO lang="*" label="Absätze dieser Seite"/>
      </LANGINFOS>
</FS_LIST>

Neben der Umstellung des Formular-Tags von CMS_INPUT_SECTIONLIST zu FS_LIST muss lediglich

<DATASOURCE type="page"/>

ergänzt werden.

<COLUMNS>
 <COLUMN show="no">#identifier</COLUMN>
</COLUMNS>

zum Ausblenden der Spalte mit der fortlaufenden Nummerierung (#identifier) wird automatisch beim Speichern der Vorlage ergänzt.