Version: GSB 7Formularelemente
- Inhaltsverzeichnis
- HFTextSeparator
- HFTextInputField
- HFTextInputArea
- HFCheckbox
- HFSCeckboxGrp
- HFDCheckboxGrp
- HFRadiobutton
- HFDRadiobuttonGrp
- HFSelectOption
- HFSSelectBox
- HFDSelectBox
- HFGenericButton
- HFButtonGrp
- HFGrp
- HFOption
Die einzelnen Formularelemente werden in der HTML-Formular Property Formularelemente genauso eingetragen, wie LanguageEnts in einem NavTarget. Der Link-Classifier eines Eintrags gibt die zu verwendende Viewvariante der zugeordneten Links an. Jeder Eintrag wird einem Slot des Formular-Layouts zugeordnet. Wenn jedoch der Text-Classifier eines Elements den Wert "&" enthält, wird der Inhalt dem vorherigen Slot zugewiesen.
Inhaltsverzeichnis
- 1 HFTextSeparator
- 2 HFTextInputField
- 3 HFTextInputArea
- 4 HFCheckbox
- 5 HFSCeckboxGrp
- 6 HFDCheckboxGrp
- 7 HFRadiobutton
- 8 HFDRadiobuttonGrp
- 9 HFSelectOption
- 10 HFSSelectBox
- 11 HFDSelectBox
- 12 HFGenericButton
- 13 HFButtonGrp
- 14 HFGrp
- 15 HFOption
Folgende Bausteine stehen zur Verfügung:
- HFTextSeparator - Hiermit können beliebige Texte in das Formular integriert werden. In den Default-Templates wird die Property separator innerhalb eines eigenen Absatzes angezeigt.
- HFTextInputField - Ein einzeiliges Texteingabe-Feld.
- HFTextInputArea - Ein mehrzeiliges Texteingabe-Feld.
- HFCheckbox - Eine einzelne Checkbox, die innerhalb einer HFSCheckboxGrp oder HFDCheckboxGrp verwendet werden kann. Dokumente von diesem Typ werden nicht direkt im Formular verwendet, sondern wie angedeutet immer in Checkbox Gruppen zusammengefasst. Der Dokumententyp HFOption soll zukünftig zur Konfiguration von Checkboxen verwendet werden.
- HFSCheckboxGrp - Eine Checkbox-Gruppe mit fest zugeordneten HFCheckbox Objekten.
- HFDCheckboxGrp - Eine Checkbox-Gruppe mit dynamisch ermittelten HFCheckbox Objekten oder freien Einträgen.
- HFRadiobutton - Ein einzelner Radiobutton, der innerhalb einer HFSRadiobuttonGrp oder HFDRadiobuttonGrp verwendet werden kann Dokumente von diesem Typ werden nicht direkt im Formular verwendet, sondern wie angedeutet immer in Radiobutton Gruppen zusammengefasst. Der Dokumententyp HFOption soll zukünftig zur Konfiguration von Radiobuttons verwendet werden.
- HFSRadiobuttonGrp - Eine Radiobutton-Gruppe mit fest zugeordneten HFRadiobutton Objekten.
- HFDRadiobuttonGrp - Eine Radiobutton-Gruppe mit dynamisch ermittelten HFRadiobutton Objekten oder freien Einträgen.
- HFSelectOption - Eine einzelne Select-Option, die innerhalb einer HFSSelectBox oder HFDSelectBox verwendet werden kann. Dokumente von diesem Typ werden nicht direkt im Formular verwendet, sondern wie angedeutet immer in Selectboxen zusammengefasst. Der Dokumententyp HFOption soll zukünftig zur Konfiguration von Select-Option verwendet werden.
- HFSSelectBox - Eine Selectbox mit fest zugeordneten HFSelectOption Objekten.
- HFDSelectBox - Eine Selectbox mit dynamisch ermittelten HFSelectOption Objekten oder freien Einträgen.
- HFGenericButton - Erstellt einen Submit- oder Reset-Button oder ein Input-Feld vom Typ Image. In der Regel werden die Buttons eines Formulars nicht direkt eingebunden, sondern innerhalb einer HFButtonGrp zusammengefasst.
- HFButtonGrp - Dient zur Zusammenfassung der Buttons eines Formulars. Die einzelnen HFGenericButton Objekte werden in den Default-Templates innerhalb einer einzeiligen Tabelle nebeneinander ausgegeben.
- HFGrp - Dient zur Gruppierung beliebiger anderer Formularelemente. In den Default-Templates werden diese innerhalb eines fieldset Elements untereinander ausgegeben. Der displayName wird als legend Titel verwendet.
- HFOption – soll zukünftig zur Konfiguration von HFCheckbox, HFRadiobutton und HFSelectItem anstelle der abgeleiteten Dokumenttypen verwendet werden.
Bitte beachten Sie, dass die statischen Formularelemente (bspw. HFSSelectBox) nach Möglichkeit nicht mehr verwendet werden sollten. Anstatt dessen sollten die dynamischen Formularelemente (bspw. HFDSelectBox) verwendet werden.
HFTextSeparator
Hiermit können beliebige Texte in das Formular integriert werden. In den Default-Templates wird die Property separator innerhalb eines eigenen Absatzes angezeigt.
| Property | Funktion |
| separator | Auszugebender Richtext |
HFTextInputField
Ein Textinput-Feld definiert ein einzeiliges Texteingabefeld und ist damit eines der wichtigsten Elemente.
| Property | Funktion |
| idName | ID des Formularfeldes. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularfeldes. |
| formFillerClass | Hier kann der Klassen-Name des zu verwendenden FormFillers eingetragen werden, wenn der Defaultwert des Formularfeldes dynamisch ermittelt werden soll. |
| formFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Die Konfiguration erfolgt in Properties-Syntax, d. h. als Liste von Name-Value Paaren. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| cl2FormFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Hier können Verweise auf andere CoreMedia Dokumente eingetragen werden. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| defaultValue | Defaultwert für das Formularfeld. Dieser Wert wird nur verwendet, wenn ein evtl. konfigurierter FormFiller keinen Wert liefert. |
| readOnlyAttribute | Gibt an, ob das Textinput-Feld readonly ist. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist. Im Fehlerfall wird sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| sizeAttribute | Größe des Textfeldes. |
| maxLengthAttribute | Maximale Anzahl der einzugebenden Zeichen. |
| typeAttribute | Gibt den Typ des input-Feldes an. Möglich sind die Typen "text", "hidden", "password" und "file". Im letzteren Fall muss für das Formular das Multipart-Encoding verwendet werden (siehe DateiUpload). |
HFTextInputArea
Dieser Dokumenttyp definiert ein mehrzeiliges Texteingabefeld.
| Property | Funktion |
| idName | ID des Formularfeldes. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularfeldes. |
| formFillerClass | Hier kann der Klassen-Name des zu verwendenden FormFillers eingetragen werden, wenn der Defaultwert des Formularfeldes dynamisch ermittelt werden soll. |
| formFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Die Konfiguration erfolgt in Properties-Syntax, d. h. als Liste von Name-Value Paaren. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| cl2FormFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Hier können Verweise auf andere CoreMedia Dokumente eingetragen werden. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| defaultValue | Defaultwert für das Formularfeld. Dieser Wert wird nur verwendet, wenn ein evtl. konfigurierter FormFiller keinen Wert liefert. |
| readOnlyAttribute | Gibt an, ob das Textinput-Feld readonly ist. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist und im Fehlerfall sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| columnsAttribute | Anzahl der Spalten der Textinput-Area |
| rowsAttribute | Anzahl der Zeilen der Textinput-Area |
| wrapAttribute | Gibt an, ob ein automatischer Zeilenumbruch erfolgen soll. |
HFCheckbox
Zur Konfiguration einer Checkbox siehe HFOption.
HFSCeckboxGrp
Eine Checkbox-Gruppe mit fest eingetragenen HFCheckbox Objekten.
| Property | Funktion |
| idName | ID des Formularelements. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularelements. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist. Im Fehlerfall wird sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| checkboxes | Liste der zu verwendenden HFCheckbox Objekte. |
HFDCheckboxGrp
Eine Checkbox-Gruppe mit dynamisch ermittelten HFCheckbox Objekten oder freien Einträgen.
| Property | Funktion |
| idName | ID des Formularelements. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularelements. |
| formFillerClass | Hier kann der Klassen-Name des zu verwendenden FormFillers eingetragen werden, wenn der Defaultwert des Formularfeldes und/oder die einzelnen Optionen dynamisch ermittelt werden sollen. |
| formFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Die Konfiguration erfolgt in Properties-Syntax, d. h. als Liste von Name-Value Paaren. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| cl2FormFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Hier können Verweise auf andere CoreMedia Dokumente eingetragen werden. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist. Im Fehlerfall wird sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| choicesDirectory | Wenn die Optionen nicht von einem FormFiller geliefert werden, können hier ein oder mehrere Verzeichnisse (bzw. beliebige Dokumente daraus) verlinkt werden, deren enthaltene HFCheckbox Dokumente dann verwendet werden. |
| sortOrder | Gibt an, ob die aus dem choicesDirectory gelesenen HFCheckbox Dokumente aufsteigend oder absteigend sortiert werden sollen. |
| firstChoices | Liste von vor den dynamisch ermittelten Optionen auszugebenden HFCheckbox Objekten. |
| lastChoices | Liste von nach den dynamisch ermittelten Optionen auszugebenden HFCheckbox Objekten. |
HFRadiobutton
Zur Konfiguration eines Radiobuttons siehe HFOption.
HFDRadiobuttonGrp
Eine Radiobutton-Gruppe mit dynamisch ermittelten HFRadiobutton Objekten oder freien Einträgen.
| Property | Funktion |
| idName | ID des Formularelements. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularelements. |
| formFillerClass | Hier kann der Klassen-Name des zu verwendenden FormFillers eingetragen werden, wenn der Defaultwert des Formularfeldes und/oder die einzelnen Optionen dynamisch ermittelt werden sollen. |
| formFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Die Konfiguration erfolgt in Properties-Syntax, d. h. als Liste von Name-Value Paaren. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| cl2FormFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Hier können Verweise auf andere CoreMedia Dokumente eingetragen werden. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist. Im Fehlerfall wird sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| choicesDirectory | Wenn die Optionen nicht von einem FormFiller geliefert werden, können hier ein oder mehrere Verzeichnisse (bzw. beliebige Dokumente daraus) verlinkt werden, deren enthaltene HFRadiobutton Dokumente dann verwendet werden. |
| sortOrder | Gibt an, ob die aus dem choicesDirectory gelesenen HFRadiobutton Dokumente aufsteigend oder absteigend sortiert werden sollen. |
| firstChoices | Liste von vor den dynamisch ermittelten Optionen auszugebenden HFRadiobutton Objekten. |
| lastChoices | Liste von nach den dynamisch ermittelten Optionen auszugebenden HFRadiobutton Objekten. |
HFSelectOption
Zur Konfiguration einer SelectOption siehe HFOption.
HFSSelectBox
Eine Selectbox mit fest eingetragenen HFSelectOption Objekten.
| Property | Funktion |
| idName | ID des Formularelements. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularelements. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist. Im Fehlerfall wird sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| options | Liste der zu verwendenden HFSelectOption Objekte. |
| multipleAttribute | Gibt an, ob mehrere oder nur eine Option gleichzeitig ausgewählt werden können. |
| sizeAttribute | Größe der Selectbox. |
HFDSelectBox
Eine Selectbox mit dynamisch ermittelten HFSelectOption Objekten oder freien Einträgen.
| Property | Funktion |
| idName | ID des Formularelements. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularelements. |
| formFillerClass | Hier kann der Klassen-Name des zu verwendenden FormFillers eingetragen werden, wenn der Defaultwert des Formularfeldes und/oder die einzelnen Optionen dynamisch ermittelt werden sollen. |
| formFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Die Konfiguration erfolgt in Properties-Syntax, d. h. als Liste von Name-Value Paaren. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| cl2FormFillerProps | Optionale Konfiguration für den verwendeten FormFiller. Hier können Verweise auf andere CoreMedia Dokumente eingetragen werden. Welche Properties im Einzelfall benötigt werden, ist abhängig vom verwendeten FormFiller. |
| mandatory | Gibt an, ob das Formularfeld ein Pflichtfeld ist. Wenn ja, wird vor Bearbeitung der Action geprüft, ob der entsprechende Parameter gesetzt ist. Im Fehlerfall wird sofort zur konfigurierten Fehlerseite des Formulars weitergeleitet. |
| validators | Hier können zusätzliche Validatoren konfiguriert werden, die vor Bearbeitung der Action geprüft werden sollen. |
| choicesDirectory | Wenn die Optionen nicht von einem FormFiller geliefert werden, können hier ein oder mehrere Verzeichnisse (bzw. beliebige Dokumente daraus) verlinkt werden, deren enthaltene HFSelectOption Dokumente dann verwendet werden. |
| sortOrder | Gibt an, ob die aus dem choicesDirectory gelesenen HFSelectOption Dokumente aufsteigend oder absteigend sortiert werden sollen. |
| firstChoices | Liste von vor den dynamisch ermittelten Optionen auszugebenden HFSelectOption Objekten. |
| lastChoices | Liste von nach den dynamisch ermittelten Optionen auszugebenden HFSelectOption Objekten. |
| multipleAttribute | Gibt an, ob mehrere oder nur eine Option gleichzeitig ausgewählt werden können. |
| sizeAttribute | Größe der Selectbox. |
HFGenericButton
Erstellt einen Submit- oder Reset-Button oder ein Input-Feld vom Typ image. In der Regel werden die Buttons eines Formulars nicht direkt eingebunden, sondern innerhalb einer HFButtonGrp zusammengefasst.
| Property | Funktion |
| idName | ID des Formularelements. Dieser Wert wird als Name des abzuschickenden Request-Parameters verwendet. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| image | Wenn hier ein Bild hochgeladen wurde, wird ein Input-Feld vom Typ image anstelle eines normalen Submit-Buttons gerendert. |
| typeAttribute | Gibt den Typ des Buttons an. Mögliche Werte sind "submit", "reset" und "button" |
HFButtonGrp
Dient zur Zusammenfassung der Buttons eines Formulars. Die einzelnen HFGenericButton Objekte werden in den Default-Templates innerhalb einer einzeiligen Tabelle nebeneinander ausgegeben.
| Property | Funktion |
| buttons | Die anzuzeigenden HFGenericButton Objekte werden hier eingetragen. |
HFGrp
Dient zur Gruppierung beliebiger anderer Formularelemente. In den Default-Templates werden diese werden innerhalb eines fieldset Elements untereinander ausgegeben.
| Property | Funktion |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem als legend Titel anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| groupElements | Hier werden die zu gruppierenden Formularelemente eingetragen. |
HFOption
Einzelne Checkboxen, Radiobuttons, SelectOptions die innerhalb einer HFSCheckboxGrp, HFDCheckboxGrp, HFSRadiobuttonGrp, HFDRadiobuttonGrp, HFSSelectBox oder HFDSelectBox verwendet werden können. Dokumente dieser Typen werden in Gruppen zusammengefasst und nicht direkt im Formular verwendet.
| Property | Funktion |
| idName | Wert dieser Option. |
| displayNameKey | Verweis auf ein ConfigResLabel mit dem vor dem Formularelement anzuzeigenden Text.
Achtung: Das Label wird nicht direkt verwendet. Stattdessen wird der ResourceBundles-Eintrag mit dem Namen dieses Labels ausgewertet. |
| altText | Der Alt-Text des Formularelements. |
| selectedAttribute | Gibt an, ob der Eintrag per Default "ausgewählt" ist. |