Startseite
Startseite

Startseite / Vorlagenentwicklung / Formulare / Eingabekomponenten / TOGGLE

CMS_INPUT_TOGGLEVerfügbar ab FirstSpirit-Version 4.0

Inhaltsverzeichnis
zum Beispiel
zu den Methoden: Boolean

CMS_INPUT_TOGGLE

Mithilfe dieser Eingabekomponente kann je nach Konfiguration entweder zwischen zwei vorgegebenen Werten (z. B. an/aus, rechts/links) umgeschaltet oder eine Checkbox aktiviert/deaktiviert werden.

Während die Eingabekomponente im ausgewählten Zustand true und im deaktivierten Zustand false zurückliefert, liefert sie im initialen Zustand, in dem noch keine Option ausgewählt wurde, den Wert null zurück. Dies sollte auch bei der Regeldefinition (Dynamische Formulare), speziell bei der Verwendung der Eigenschaft VISIBLE berücksichtigt werden.

Access-API Anwendungsbeispiel
Die Beispiel-Implementierung ToggleEditorValueExample veranschaulicht einige einfache Anwendungsfälle für den Lesenden-, Schreibenden-, Erstellenden-Zugriff auf das Daten-Objekt (ToggleEditorValue) und dessen Wert (java.lang.Boolean) der Eingabekomponente anhand der FirstSpirit Access-API.

name
Designator
Pflichtparameter
allowEmpty
YesNo
Optionaler Parameter
convertEntities
ConvertEntity
Optionaler Parameter
hFill
YesNo
Optionaler Parameter
hidden
YesNo
Optionaler Parameter
hideLabel
YesNo
Optionaler Parameter
noBreak
YesNo
Optionaler Parameter
preset
Preset
Optionaler Parameter
singleLine
YesNo
Optionaler Parameter
type
ToggleType
Optionaler Parameter
useLanguages
YesNo
Optionaler Parameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter

Parameter

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner
allowEmptyNein3.0YesNoYES
convertEntitiesNein2.0ConvertEntityNONE
hFillNein2.0YesNoNO
hiddenNein4.0.44YesNoNO
hideLabelNein4.0YesNoNO
noBreakNein2.0YesNoNO
presetNein4.0PresetDEFAULT
singleLineNein4.0YesNoYES
typeNein4.0ToggleTypeCHECKBOX
useLanguagesNein2.0YesNoYES

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.

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner

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.

ParameterPflichtparameterSeitTypStandardwert
allowEmptyNein3.0YesNoYES

convertEntities

Mit dem Attribut "convertEntities" werden Sonderzeichen, die in die Eingabekomponenten eingeben wurden, bei der Ausgabe in HTML-Zeichen umgewandelt.

Es gibt hier drei Ausprägungen:

  • convertEntities="NONE" (Standard)
  • convertEntities="STANDARD"
  • convertEntities="QUOTE"

Bei NONE werden keinerlei Konvertierungsregeln angewendet.

Wird STANDARD angegeben, so werden die Konvertierungsregeln angewendet, die im Bereich "convert" der ausgewählten Konvertierungsregel des Präsentationskanales stehen.

Die Angabe QUOTE schließt STANDARD explizit mit ein. Es wird jedoch zusätzlich der Bereich "quote" der Konvertierungsregel angewendet.

ParameterPflichtparameterSeitTypStandardwert
convertEntitiesNein2.0ConvertEntityNONE

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.

ParameterPflichtparameterSeitTypStandardwert
hFillNein2.0YesNoNO

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.

ParameterPflichtparameterSeitTypStandardwert
hiddenNein4.0.44YesNoNO

hideLabel

hideLabel ist ausschließlich in Verbindung mit type="radio" verwendbar. Ist hideLabel="yes" gesetzt, wird die über den Parameter label angegebene Bezeichnung ausgeblendet. Standardmäßig wird die Bezeichnung eingeblendet (hideLabel="no").

ParameterPflichtparameterSeitTypStandardwert
hideLabelNein4.0YesNoNO

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").

ParameterPflichtparameterSeitTypStandardwert
noBreakNein2.0YesNoNO

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.

ParameterPflichtparameterSeitTypStandardwert
presetNein4.0PresetDEFAULT

singleLine

Mit dem Parameter singleLine kann festgelegt werden, ob eine Eingabekomponente in einer Zeile (ohne Rahmen) dargestellt werden soll oder nicht.

Wird der Parameter nicht angegeben so wird die Eingabekomponente im in einer Zeile - ohne Rahmen - dargestellt.

Bei der Angabe von NO (...singleLine="NO"...) wird die Eingabekomponente zweizeilig mit Rahmen dargestellt.

Um ein einheitliches Layout der Eingabekomponenten zu gewährleisten ist es empfehlenswert für die Eingabekomponenten, die dieses Attribut unterstützen (z.B. COMBOBOX, DATE, NUMBER, TEXT und TOGGLE) singleLine="NO", anzugeben.

ParameterPflichtparameterSeitTypStandardwert
singleLineNein4.0YesNoYES

type

CMS_INPUT_TOGGLE kann in zwei Varianten dargestellt werden. Diese werden über den Parameter type angegeben:

  • Checkbox: Mit type="CHECKBOX" wird die Eingabekomponente als Checkbox mit genau einem ankreuzbaren Quadrat angezeigt (vgl. auch Abbildung bei CMS_INPUT_CHECKBOX).
  • Radiobutton: Mit type="RADIO" wird die Eingabekomponente mit zwei Knöpfen zur Auswahl zwischen genau zwei Zuständen angezeigt (vgl. auch Abbildung CMS_INPUT_RADIOBUTTON).

Wird type nicht angegeben, wird CMS_INPUT_TOGGLE standardmäßig in der Variante "Checkbox" dargestellt.

ParameterPflichtparameterSeitTypStandardwert
typeNein4.0ToggleTypeCHECKBOX

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.

ParameterPflichtparameterSeitTypStandardwert
useLanguagesNein2.0YesNoYES

LANGINFOSVerfügbar ab FirstSpirit-Version 4.0

Ü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>

LANGINFOVerfügbar ab FirstSpirit-Version 3.1

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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner
descriptionNein3.1StringKeiner
labelNein3.1StringKeiner

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe Dokument ansehen, 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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner

description

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

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

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

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner

OFFVerfügbar ab FirstSpirit-Version 4.0

Mit dem Tag OFF können sprachabhängige Angaben für den Zustand aus bzw. deaktiviert angegeben werden.

Sinnvoll ist die Angabe wenn für das Attribut type der Wert RADIO angegeben wurde.

LANGINFOVerfügbar ab FirstSpirit-Version 3.1

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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner
descriptionNein3.1StringKeiner
labelNein3.1StringKeiner

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe Dokument ansehen, 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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner

description

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

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

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

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner

ONVerfügbar ab FirstSpirit-Version 4.0

Mit dem Tag ON können sprachabhängige Angaben für den Zustand an bzw. aktiviert angegeben werden.

Sinnvoll ist die Angabe wenn für das Attribut type der Wert RADIO angegeben wurde.

LANGINFOVerfügbar ab FirstSpirit-Version 3.1

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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner
descriptionNein3.1StringKeiner
labelNein3.1StringKeiner

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe Dokument ansehen, 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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner

description

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

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

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

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner
Legende

ToggleType

Anzeigetyp des Umschalters

CHECKBOXVerfügbar ab FirstSpirit-Version 4.0

Anzeige einer Checkbox

RADIOVerfügbar ab FirstSpirit-Version 4.0

Anzeige von zwei Knöpfen für die Zustände "an" und "aus"

LanguageAbbreviation

Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte

YesNo

Schalter, um ein Attribut anzuwenden oder nicht

NOVerfügbar ab FirstSpirit-Version 2.0

Attribut nicht anwenden

YESVerfügbar ab FirstSpirit-Version 2.0

Attribut anwenden

String

Eine beliebige Zeichenkette

Preset

Behandlung von Vorgabewerten

CopyVerfügbar ab FirstSpirit-Version 4.0

Verwendung des vom Redakteur gewählten Wertes, nachträgliche Änderungen wirken sich nicht aus

DefaultVerfügbar ab FirstSpirit-Version 4.0

Verwendung des im Formular definierten Rückgriffwerts, solange kein manueller Wert gesetzt wird

ConvertEntity

Schalter, um die Konvertierungsregel festzulegen

NONEVerfügbar ab FirstSpirit-Version 2.0

Keine Konvertierungsregeln anwenden

STANDARDVerfügbar ab FirstSpirit-Version 2.0

Konvertierungsregeln des "convert"-Bereichs anwenden

QUOTEVerfügbar ab FirstSpirit-Version 2.1

Konvertierungsregeln des "convert"- und "quote"-Bereichs anwenden

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"

Beispiel

Ein Beispiel für die Eingabekomponente "CMS_INPUT_TOGGLE":

<CMS_INPUT_TOGGLE name="BEZEICHNER">
<LANGINFOS>
<LANGINFO lang="*" label="TEXT" description="TEXT"/>
<LANGINFO lang="DE" label="TEXT" description="TEXT"/>
<LANGINFO lang="EN" label="TEXT" description="TEXT"/>
</LANGINFOS>
<OFF>
<LANGINFO lang="*" label="TEXT"/>
<LANGINFO lang="DE" label="TEXT"/>
<LANGINFO lang="EN" label="TEXT"/>
</OFF>
<ON>
<LANGINFO lang="*" label="TEXT"/>
<LANGINFO lang="DE" label="TEXT"/>
<LANGINFO lang="EN" label="TEXT"/>
</ON>
</CMS_INPUT_TOGGLE>

© 2005 - 2015 e-Spirit AG | Alle Rechte vorbehalten. | Letzte Änderung: 2014-07-21