CMS_INPUT_DOMTABLE
Inhaltsverzeichnis |
zum Beispiel |
zu den Methoden: Table |
Parameter name*, allowEmpty, bold, columnChange, combine, develop, enableImport, hFill, height, hidden, import, importRuleset, italic, list, listConfig, listDefaultConfig, preset, properties, propertyConfig, rowChange, rows, useLanguages, width FORMATSTEMPLATEname* LANGINFOS*LANGINFO*LINKEDITORSLINKEDITORname* |
Diese Eingabekomponente dient dazu, dem Redakteur eine komfortable Möglichkeit zu geben, in Tabellenform auszugebende Daten in das System einzupflegen. Hierbei ist es dem Vorlagenentwickler möglich, die Tabelle für den Redakteur in beliebiger Weise vorzufertigen. Wie in der Eingabekomponente CMS_INPUT_DOM ist es auch in dieser Eingabekomponente möglich, beliebige Verweisvorlagen zu verwenden. Weiterhin können beliebige Zeichen-Formatvorlagen verwendet werden, jedoch keine Absatzformatvorlagen. Darüber hinaus kann dem Redakteur eine Funktion zum Importieren von Tabelleninhalten aus externen Dateien zur Verfügung gestellt werden.
Die gespeicherten Informationen einer Tabelle können entweder über Standardformatvorlagen oder durch die Funktion "Table" ausgegeben werden.
Für die Darstellung einer Tabelle über die Standardformatvorlagen werden die Formatvorlagen "Table" (Kürzel: "table"; Tabellenkörper), "Table-Row" (Kürzel: "tr"; eine Tabellenzeile) und "Table-Cell" (Kürzel: "td", eine Tabellenzelle) verwendet.
Access-API Anwendungsbeispiel
Die Beispiel-Implementierung DomTableEditorValueExample veranschaulicht einige einfache Anwendungsfälle für den Lesenden-, Schreibenden-, Erstellenden-Zugriff auf das Daten-Objekt (DomTableEditorValue) und dessen inneren Daten-Container (Table) der Eingabekomponente anhand der FirstSpirit Access-API.
- Anwendungs-Beispiel: DomTableEditorValueExample
- Daten-Objekt: DomTableEditorValue
- Container-Typ: Table
Die Eingabekomponente CMS_INPUT_DOMTABLE wird im FirstSpirit ContentCreator unterstützt. Zu Einschränkungen siehe Kapitel Einschränkungen in ContentCreator. |
Pflichtparameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Optionaler Parameter
Pflichtparameter
Pflichtparameter
Optionaler Parameter
Optionaler Parameter
Pflichtparameter
Parameter
Der nachfolgenden Tabelle können die Parameter der Eingabekomponente DOMTABLE entnommen werden.
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
name* | Ja | 3.1 | Designator | Keiner |
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
allowEmpty | Nein | 3.0 | YesNo | YES |
bold
Mit dem Parameter bold kann der Fett-Button in der Eingabekomponente ein- oder ausgeblendet werden.
Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.
Bei der Angabe von NO (...bold="NO"...) wird der Button aus- und bei YES eingeblendet.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
bold | Nein | 2.0 | YesNo | YES |
columnChange
Mit dem Parameter columnChange kann das Löschen und Hinzufügen von Spalten in der Eingabekomponente zugelassen oder aber unterbunden werden.
Wird der Parameter nicht angegeben so ist das Löschen und Hinzufügen von Spalten möglich.
Das Löschen und Hinzufügen wird durch die Angabe von NO (...columnChange="NO"...) deaktiviert.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
columnChange | Nein | 2.1 | YesNo | YES |
combine
Mit dem Parameter combine kann das Verschmelzen von Zellen zugelassen oder aber unterbunden werden.
Wird der Parameter nicht angegeben, so können Zellen verschmolzen werden.
Bei der Angabe von NO (...combine="NO"...) wird das Verschmelzen von Zellen deaktiviert.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
combine | Nein | 2.1 | YesNo | YES |
develop
Enable debug mode using Java-Console for output.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
develop | Nein | 2.1 | YesNo | NO |
enableImport
Mithilfe des Parameters enableImport kann die Funktionalität des Moduls FirstSpirit Office aktiviert werden.
Standardmäßig ist die Funktionalität nicht aktiv. Wird der Parameter auf YES gesetzt, wird der Button "Word-Inhalte aus der Zwischenablage einfügen" angezeigt.
Für die Verwendung dieses Attributs ist eine gültige Lizenz für das Modul FirstSpirit Office erforderlich. |
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
enableImport | Nein | 4.2 | YesNo | NO |
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
hFill | Nein | 2.0 | YesNo | NO |
height
Mit dem Parameter height wird die Anzeigehöhe der Eingabekomponente in Zeilen festgelegt.
Als Wert erwartet der Parameter eine Ganzzahl.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
height | Nein | 2.1 | PositiveInteger | 6 |
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
hidden | Nein | 4.0.44 | YesNo | NO |
import
Mit dem Parameter import kann der Button zum Importieren von Tabelleninhalten aus einer externen Datei in der Eingabekomponente ein- oder ausgeblendet werden.
Wird der Parameter nicht angegeben, so wird der Button standardmäßig ausgeblendet.
Bei der Angabe von NO (...import="NO"...) wird der Button aus- und bei YES eingeblendet.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
import | Nein | 2.1 | YesNo | NO |
importRuleset
Mit dem Parameter importRulesets kann bei aktivierter Funktionalität des Moduls FirstSpirit Office die Auswahl der XML-Regelsätze für die jeweilige Eingabekomponente eingeschränkt werden. Dazu wird importRulesets mit dem oder den Namen der gewünschten Regelsätze, die in den Server- und Projekteigenschaften definiert wurden, in doppelten Hochkommata angegeben. Mehrere Regelsätze werden durch Komma separiert angegeben.
Wird der Parameter nicht angegeben, werden alle für das jeweilige Projekt zur Verfügung stehenden XML-Regelsätze zur Auswahl angeboten.
Dieser Parameter wird nur ausgewertet, wenn der Parameter enableImport auf YES gesetzt ist. |
Weiterführende Informationen zum Modul FirstSpirit Office siehe entsprechende Modul-Dokumentation.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
importRuleset | Nein | 4.2 | String | Keiner |
italic
Mit dem Parameter italic kann der Kursiv-Button in der Eingabekomponente ein- oder ausgeblendet werden.
Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.
Bei der Angabe von NO (...italic="NO"...) wird der Button aus- und bei YES eingeblendet.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
italic | Nein | 2.0 | YesNo | YES |
list
Mit dem Parameter list kann der Liste einfügen-Button in der Eingabekomponente ein- oder ausgeblendet werden.
Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.
Bei der Angabe von NO (...list="NO"...) wird der Button aus- und bei YES eingeblendet.
Die Konfiguration von Listen kann mit den Parametern listConfig und listDefaultConfig vorgenommen werden.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
list | Nein | 2.3 | YesNo | YES |
listConfig
Mit dem Parameter listConfig kann der Listendialog frei konfiguriert werden.
Für den Typ des Eingabefeldes stehen sieben Schlüsselbegriffe zur Verfügung:
- text (Eingabefeld für die Eingabe einzeiliger Texte)
- number (Eingabefeld für die Eingabe von Zahlen)
- boolean (Auswahlbox, die aktiviert werden kann)
- choice (Combo-Box, aus der ein Eintrag ausgewählt werden kann)
- password (Eingabefeld für verschlüsstelte Texteingaben, z.B. für Passwörter)
- color (Auswahldialog zur Farbauswahl)
Die Syntax für die Definition eines Eingabefeldes lautet:
BEZEICHNER:BESCHRIFTUNG[type=TYP;PARAMETERLISTE]
Mehrere Eingabefelder sind als kommaseparierte Liste anzugeben.
Mit BESCHRIFTUNG wird die Beschriftung des Eingabefeldes definiert, die im Dialog dargestellt werden soll.
Mit dem Parameter type wird mit Hilfe des mit TYP angegebenen Schlüsselwortes (siehe obige Liste) festgelegt, welcher Eingabetyp dargestellt werden soll.
Wird der Parameter type nicht angegeben, so wird ein einzeiliges Textfeld dargestellt, ausser es wird eine durch Pipesymbole (|) getrennte Liste als Parameter übergeben.
In diesem Fall wird eine Combobox dargestellt.
Für die meisten Eingabetypen (text, number, password, color, choice) können die folgenden Parameter verwendet werden, wobei beachtet werden sollte, dass nicht jede Kombination sinnvoll ist:
- maxlen: Über diesen Parameter kann die maximale Eingabelänge (in Zeichen) festgelegt werden. (z.B. maxlen=20)
- upcase=true: Dieser Parameter wandelt alle Eingaben in Großbuchstaben um.
- allowed=Zeichenkette: Als Wert für diesen Parameter werden alle Zeichen übergeben, die bei der Eingabe verwendet werden dürfen (z.B. allowed=abcdef)
Für den Eingabetyp choice ist es zwingend erforderlich, eine Liste der Auswahlmöglichkeiten zu definieren, wobei die einzelnen Punkte durch das Pipe-Symbol ("|") getrennt werden. Die Beschriftung des jeweiligen Auswahlpunktes kann hinter dem Wert mit einem Doppelpunkt definiert werden. (z.B. choice:Wahl[type=choice;choice1:Auswahl1|choice2:Auswahl2|choice3:Auswahl3]).
...listConfig="
a:Text[type=text;maxlen=30;upcase=true;
allowed=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ],
style:Listenart[4:Großbuchstaben|2:Zahlen|6:römische Zahlen],
c:Check Box[boolean],
d:Passwort[password],
e:Nummer[type=number;maxlen=10],
f:Farbe[color],
h:Text,
i:Text[text]"...
In den Formatvorlagen mit den Kürzeln ul und li steht der gespeicherte Wert für ein Eingabefeld mit dem definierten BEZEICHNER zur Verfügung.
Der gespeicherte Wert lässt sich mit Hilfe des Systemobjekts #list und der Methode attr ausgeben:
$CMS_VALUE(#list.attr("BEZEICHNER"))$
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
listConfig | Nein | 2.3 | String | Keiner |
listDefaultConfig
Dem Vorlagenentwickler ist es über den Parameter listDefaultConfig möglich, einzelne Listenvariablen mit Werten vorzubelegen.
Hierzu wird als Wert für den Parameter eine kommaseparierte Liste mit allen vorzubelegenen Listenvariablennamen (BEZEICHNER) übergeben, wobei für jede Variable ein Wert zugeordnet wird. (z.B. listDefaultConfig="mediaref=media:O,pre=%index% von %count%,style=4").
Wird hierbei einer der reservierten Listenvariablennamen (siehe unten) verwendet, so wird das Aussehen der Liste beeinflusst. |
style
Über den reservierten Listenvariablennamen style wird festgelegt, welche Listentypen dem Redakteur zur Auswahl stehen. Die verschiedenen Listentypen werden unten erläutert. (Beispiel: style:Typ[4:Großbuchstaben|2:Zahlen|6:römische Zahlen|3:Kleinbuchstaben|8:Kreis|1:Scheibe|0:Quadrat]).
Wird der reservierten Listenvariablennamen style nicht vorbelegt, so stehen dem Redakteur entweder alle 9 Listentypen einmal zur Verfügung (wenn es keinen listConfig-Parameter gibt) oder kein Listentyp (falls listConfig angegeben wurde).
pre
Über den reservierten Listenvariablennamen pre wird die Darstellung der Aufzählungszeichen für den Listentyp 8 definiert.
Bei dieser Definition können die Schlüsselbegriffe %index% (Nummer des aktuellen Elementes), %count% (Anzahl der Elemente) und %count2% (Nummer des letzten Elementes) verwendet werden.
start
Über diesen reservierten Listenvariablennamen wird der Startpunkt einer Nummerierung festgelegt.
Der Startpunkt muss immer als Zahl festgelegt werden, unabhängig davon, welcher Nummerierungstyp verwendet wird. |
Tipp: Falls der Redakteur Eingaben vornehmen soll, als Typ für dieses Eingabefeld "number" verwenden und mit dem Wert 1 vorbelegen.
mediaref
Über diesen reservierten Listenvariablennamen kann ein Bild aus der Medien-Verwaltung ausgewählt werden, welches bei dem Listentyp 1 vor der Liste dargestellt wird.
Listentypen
Die Definition, welche Listentypen dem Redakteur zur Auswahl stehen sollen, wird mit Hilfe des reservierten Listenvariablennamen style festgelegt.
...style:Typ[2:Buchstaben|6:römische Zahlen]...
Folgende Listentypen stehen zur Verfügung:
- Typ 0: Spiegelstrich; als Listensymbol wird ein Strich (-) dargestellt.
- Typ 1: Bullet; als Listensymbol wird ein blaues Dreieck oder der Inhalt der Listenvariabel mediaref dargestellt.
- Typ 2: Nummeriert; als Nummerierungszeichen werden arabische Zahlen verwendet.
- Typ 3: Alphabetisch (Kleinbuchstaben); als Nummerierungszeichen werden lateinische Kleinbuchstaben verwendet.
- Typ 4: Alphabetisch (Großbuchstaben); als Nummerierungszeichen werden lateinische Großbuchstaben verwendet.
- Typ 5: Römische Ziffern (Kleinbuchstaben); als Nummerierungszeichen werden römische Zahlen in Kleinbuchstaben verwendet.
- Typ 6: Römische Ziffern (Großbuchstaben); als Nummerierungszeichen werden römische Zahlen in Großbuchstaben verwendet.
- Typ 7: Leer (nur Einrücken); es werden keine Listensymbole verwendet, die gesamte Liste wird alerdings eingerückt.
- Typ 8: Benutzerdefiniert; als Listensymbol bzw. Nummerierungszeichen wird der Inhalt der reservierten Listenvariabel "pre" angezeigt.
Der Zugriff auf die Informationen einer Liste erfolgen üblicherweise über die Systemobjekte #list (gesamte Liste) und #listitem (ein Listenpunkt).
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
listDefaultConfig | Nein | 2.3 | String | Keiner |
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
preset | Nein | 4.0 | Preset | DEFAULT |
properties
Mit dem Parameter properties kann der Eigenschaften Zelle-Button in der Eingabekomponente ein- oder ausgeblendet werden.
Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.
Bei der Angabe von NO (...properties="NO"...) wird der Button aus- und bei YES eingeblendet.
Mithilfe dieses Buttons kann der Redakteur in einem separatem Dialog Eigenschaftswerte für eine Zelle hinterlegen. Die Eingabefelder des Dialogs werden mit dem Parameter propertyConfig (siehe unten) definiert.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
properties | Nein | 2.1 | YesNo | YES |
propertyConfig
Mit dem Parameter propertyConfig kann der Zelleneigenschaften-Dialog frei konfiguriert werden.
Für den Typ des Eingabefeldes stehen sieben Schlüsselbegriffe zur Verfügung:
- text (Eingabefeld für die Eingabe einzeiliger Texte)
- number (Eingabefeld für die Eingabe von Zahlen)
- boolean (Auswahlbox, die aktiviert werden kann)
- choice (Combo-Box, aus der ein Eintrag ausgewählt werden kann)
- password (Eingabefeld für verschlüsstelte Texteingaben, z.B. für Passwörter)
- color (Auswahldialog zur Farbauswahl)
Die Syntax für die Definition eines Eingabefeldes lautet:
BEZEICHNER:BESCHRIFTUNG[type=TYP;PARAMETERLISTE]
Mehrere Eingabefelder sind als kommaseparierte Liste anzugeben.
Mit BESCHRIFTUNG wird die Beschriftung des Eingabefeldes definiert, die im Dialog dargestellt werden soll.
Mit dem Parameter type wird mit Hilfe des mit TYP angegebenen Schlüsselwortes (siehe obige Liste) festgelegt, welcher Eingabetyp dargestellt werden soll.
Wird der Parameter type nicht angegeben, so wird ein einzeiliges Textfeld dargestellt, ausser es wird eine durch Pipesymbole (|) getrennte Liste als Parameter übergeben.
In diesem Fall wird eine Combobox dargestellt.
Für die meisten Eingabetypen (text, number, password, color, choice) können die folgenden Parameter verwendet werden, wobei beachtet werden sollte, dass nicht jede Kombination sinnvoll ist:
- maxlen: Über diesen Parameter kann die maximale Eingabelänge (in Zeichen) festgelegt werden. (z.B. maxlen=20)
- upcase=true: Dieser Parameter wandelt alle Eingaben in Großbuchstaben um.
- allowed=Zeichenkette: Als Wert für diesen Parameter werden alle Zeichen übergeben, die bei der Eingabe verwendet werden dürfen (z.B. allowed=abcdef)
Für den Eingabetyp choice ist es zwingend erforderlich, eine Liste der Auswahlmöglichkeiten zu definieren, wobei die einzelnen Punkte durch das Pipe-Symbol ("|") getrennt werden. Die Beschriftung des jeweiligen Auswahlpunktes kann hinter dem Wert mit einem Doppelpunkt definiert werden. (z.B. choice:Wahl[type=choice;choice1:Auswahl1|choice2:Auswahl2|choice3:Auswahl3]).
...propertyConfig="
a:Text[type=text;maxlen=30;upcase=true;
allowed=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ],
style:Listenart[4:Großbuchstaben|2:Zahlen|6:römische Zahlen],
c:Check Box[boolean],
d:Passwort[password],
e:Nummer[type=number;maxlen=10],
f:Farbe[color],
h:Text,
i:Text[text]"...
In den Formatvorlagen mit dem Kürzel td steht der gespeicherte Wert für ein Eingabefeld mit dem definierten BEZEICHNER zur Verfügung.
Der gespeicherte Wert lässt sich mit Hilfe des Systemobjekts #cell und der Methode attr ausgeben:
$CMS_VALUE(#cell.attr("BEZEICHNER"))$
Das Icon zum Aufrufen des Dialogs ist nicht vorhanden, wenn der Parameter properties (siehe oben) auf "NO" gesetzt ist. |
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
propertyConfig | Nein | 2.1 | String | Keiner |
rowChange
Mit dem Parameter rowChange kann das Löschen und Hinzufügen von Zeilen in der Eingabekomponente zugelassen oder aber unterbunden werden.
Wird der Parameter nicht angegeben so ist das Löschen und Hinzufügen von Zeilen möglich.
Das Löschen und Hinzufügen wird durch die Angabe von NO (...rowChange="NO"...) deaktiviert.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
rowChange | Nein | 2.1 | YesNo | YES |
rows
Height of the form input field in number of rows.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
rows | Nein | 2.0 | PositiveInteger | 4 |
useLanguages
Mit dem Parameter useLanguages kann festgelegt werden, ob eine Eingabekomponente für verschiedene Sprachen unterschiedliche bzw. abweichende Werte speichern soll oder nicht (mehrsprachige Pflege).
Wird der Parameter nicht angegeben so werden standardmäßig abweichende Werte für die verschiedenen Sprachen gespeichert.
Bei der Angabe von NO (...useLanguages="NO") wird ein Wert für alle Sprachen gespeichert.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
useLanguages | Nein | 2.0 | YesNo | YES |
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. |
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
width | Nein | 2.0 | PositiveInteger | Keiner |
FORMATS
Mit dem Tag FORMATS kann die Menge der in der Eingabekomponente verwendbaren Formatvorlagen festgelegt werden.
Im Tag kann das Tag TEMPLATE angegeben werden.
Eine verwendbare Formatvorlage entspricht einem TEMPLATE-Tag.
Wird FORMATS nicht angegeben, können alle im Projekt vorhandenen Formatvorlagen verwendet werden.
TEMPLATE
Mit einem TEMPLATE-Tag wird innerhalb des FORMATS-Tags genau eine Formatvorlage definiert, die in der Eingabekomponente verwendbar sein soll.
Das Tag besitzt den Pflichtparameter name, der den eindeutigen Bezeichner (Kürzel) der Formatvorlage enthalten muss.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
name* | Ja | 3.0 | String | Keiner |
name
Mit dem Parameter name im Tag TEMPLATE wird der Referenzname der Vorlage angegeben, die in der Eingabekomponente auswählbar sein soll.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
name* | Ja | 3.0 | String | Keiner |
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
lang* | Ja | 3.1 | LanguageAbbreviation | Keiner |
description | Nein | 3.1 | String | Keiner |
label | Nein | 3.1 | String | Keiner |
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.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
lang* | Ja | 3.1 | LanguageAbbreviation | Keiner |
description
Mit dem Parameter description kann eine Beschreibung angegeben werden, die zur Anzeige eines Tooltipps (Mouse-Over) genutzt wird.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
description | Nein | 3.1 | String | Keiner |
label
Mit dem Parameter label wird die Oberflächenbeschriftung für Eingabe- und Visualisierungkomponenten angegeben.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
label | Nein | 3.1 | String | Keiner |
LINKEDITORS
Mit dem Tag LINKEDITORS kann die Menge der in der Eingabekomponente verwendbaren Verweisvorlagen festgelegt werden.
Im Tag kann das Tag LINKEDITOR angegeben werden.
Eine verwendbare Verweisvorlage entspricht einem LINKEDITOR-Tag.
LINKEDITOR
Mit einem LINKEDITOR-Tag wird innerhalb des LINKEDITORS-Tags genau eine Verweisvorlage definiert, die in der Eingabekomponente verwendbar sein soll.
Das Tag besitzt den Pflichtparameter name, der den Referenznamen der Verweisvorlage enthalten muss.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
name* | Ja | 3.0 | String | Keiner |
name
Mit dem Parameter name im Tag LINKEDITOR wird der Referenzname der Verweiskonfiguration angegeben, die in der Eingabekomponente auswählbar sein soll.
Parameter | Pflichtparameter | Seit | Typ | Standardwert |
---|---|---|---|---|
name* | Ja | 3.0 | String | Keiner |
Beispiel
Ein Beispiel für die Eingabekomponente "CMS_INPUT_DOMTABLE":
<CMS_INPUT_DOMTABLE height="10" hFill="YES" name="BEZEICHNER" useLanguages="YES">
<FORMATS>
<TEMPLATE name="u"/>
</FORMATS>
<LANGINFOS>
<LANGINFO lang="*" label="TEXT" description="TEXT"/>
<LANGINFO lang="DE" label="TEXT" description="TEXT"/>
<LANGINFO lang="EN" label="TEXT" description="TEXT"/>
</LANGINFOS>
</CMS_INPUT_DOMTABLE>