Formular-Taglibs (bis Version 1.10)
Diese Seite enthält die Dokumentation der Formular-Taglibs bis einschließlich Version
1.10. Bitte beachten Sie, dass diese im dem Release 1.11 vollständlich überarbeitet
wurden und zukünftig nicht mehr unterstützt werden.
Nutzen Sie noch die Formular-Taglibs des Release 1.10, so finden sie die vorhanden Formular-Taglibs
unter
. Bitte beachten Sie zum Einsatz der alten Taglibs mit dem neuen
APF-Release das
HOWTO im Wiki.
Zur dynamischen Generierung und Handhabung von Formularen gibt es das html:form-Tag. Mit diesem
können Formulare innerhalb eines Dokuments beschreiben werden. Ähnlich wie Templates sind
diese im Document-Controller verfügbar und können entsprechend in das Dokument eingesetzt
werden.
APF-Template
<html:form name="" [method=""]>
...
</html:form>
Beschreibung der Attribute:
-
name: Name des Formulars. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
method: Versand-Methode des Formulars. Standardmäßig wird post verwendet.
(Zeichen:
[get|post])
Innerhalb eines Formulars stehen folgende Tags zu Verfügung. Diese können in unterschiedlichen
Kombinationen auftreten. Für ein Anwendungsbeispiel wird auf das Kontaktformular der Beispiel-Seite
auf die API-Dokumentation verwiesen.
Des Weiteren stehen für Eingabe-Felder folgende Attribute zur Aktivierung und Konfiguration der
Validierung von Benutzereingaben zur Verfügung
(z.B. bei einer Textarea):
APF-Template
<form:area name="" [validate="" button="" [validator=""]]/>
Beschreibung der Attribute:
-
validate: Ist der Wert des Attributes mit "true" gefüllt, so wird der Eingabe-
Werte beim Absenden überprüft. Fehlt das Attribut oder ist es mit dem Wert "false" versehen
wird keine Validierung vorgenommen. Der Wert "true" bedingt jedoch das Attribut "button".
(Zeichen:
[true|false])
-
button: Name des Buttons, bei dessen Klicken das Feld validiert werden soll.
(Zeichen:
[A-Za-z0-9-_])
-
validator: Name des Validators. Standard ist "Text" und prüft auf Vorhandensein
von mind. einem beliebigen Zeichen. Die hier möglichen Validatoren ergeben sich aus den Methoden
der Klasse "myValidator" durch weglassen des Keywords "validate". Beispiel: Möchte eine E-Mail
validiert werden, so ist hierfür die Methode "validateEMail" zuständig. Im Feld "validate"
kann damit ein "EMail" notiert werden. Sollen weitere Validatoren möglich gemacht werden muss
die Klasse "myValidator" erweitert werden.
(Zeichen:
[A-Za-z])
APF-Template
<form:area name="" [id=""] [class=""] [style=""] [filter="" [filterclass=""]]/>
Beschreibung der Attribute:
-
name: Name des Textarea. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Style des Feldes.
-
filter: Name des anzuwendenen Filters.
-
filterclass: Angabe einer alternativen Filter-Klasse.
APF-Template
<form:area name="" [id=""] [class=""] [style=""] [filter="" [filterclass=""]]>
[..]
</form:area>
Beschreibung der Attribute:
-
name: Name des Textarea. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
filter: Name des anzuwendenen Filters.
-
filterclass: Angabe einer alternativen Filter-Klasse.
Die TagLib repräsentiert einen Submit-Button. Reset- oder andere Arten von Buttons können
innerhalb eines Formulars direkt als HTML-Code definiert werden. Für diese gibt es keine eigene
APF-TagLib, da diese innerhalb eines Formulars keine Funktion inne haben.
APF-Template
<form:button name="" [id=""] [class=""] [style=""] />
Beschreibung der Attribute:
-
name: Name des Buttons. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
APF-Template
<form:checkbox name="" value="" [id=""] [class=""] [style=""] [checked="checked"] />
Beschreibung der Attribute:
-
name: Name der Checkbox. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
value: Wert der Checkbox.
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
checked: Zeigt an, ob der Radio-Button vorselektiert ist.
APF-Template
<form:date name="" [id=""] [class=""] [style=""] [yearrange=""] [offsetnames=""]/>
Beschreibung der Attribute:
-
name: Name des Datum-Controlls. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
yearrange: Range des Jahres-Feldes. Beispiel:
1990-2007.
(Zeichen: [0-9-])
-
offsetnames: Namen der Felder für Tag, Monat und Jahr. Einzelne Felder müssen
durch ";" getrennt werden. Beispiel:
Tag;Monat;Jahr.
(Zeichen: [A-Za-z])
APF-Template
<form:file name="" [id=""] [class=""] [style=""] />
Beschreibung der Attribute:
-
name: Name des Dateiupload-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
APF-Template
<form:hidden name="" value="" />
Beschreibung der Attribute:
-
name: Name des Hidden-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
value: Wert des Hidden-Feldes.
APF-Template
<form:multiselect name="" [id=""] [class=""] [style=""] />
Beschreibung der Attribute:
-
name: Name des Multiselect-Felds. Über den Namen kann auf das Element
zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
Hinweis: Der Name des Formular-Feldes muss am Schluss "[]" enthalten, da es sonst
zu Fehlern bei der übertragung der Optionen kommt.
APF-Template
<form:multiselect name="" [id=""] [class=""] [style=""]>
<select:option value="" [selected="selected"]></select:option>
</form:multiselect>
Beschreibung der Attribute:
-
name: Name des Text-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
value: Wert der Option.
-
selected: Gibt an, ob die aktuelle Option vorselektiert ist.
(Zeichen:
[selected|<leer>])
Hinweis: Der Name des Formular-Feldes muss am Schluss "[]" enthalten, da es sonst
zu Fehlern bei der übertragung der Optionen kommt.
APF-Template
<form:password name="" [id=""] [class=""] [style=""] [filter="" [filterclass=""]]/>
Beschreibung der Attribute:
-
name: Name des Passwort-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
filter: Name des anzuwendenen Filters.
-
filterclass: Angabe einer alternativen Filter-Klasse.
APF-Template
<form:placeholder name="" />
Beschreibung der Attribute:
-
name: Name des Platzhalters. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
APF-Template
<form:radio name="" value="" [id=""] [class=""] [style=""] [checked="checked"]/>
Beschreibung der Attribute:
-
name: Name des Radio-Buttons. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
value: Wert des Radio-Buttons.
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
value: Wert der Option.
-
checked: Zeigt an, ob der Radio-Button vorselektiert ist.
APF-Template
<form:select name="" [id=""] [class=""] [style=""] />
Beschreibung der Attribute:
-
name: Name des Select-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
APF-Template
<form:select name="" [id=""] [class=""] [style=""]>
<select:option value="" [selected="selected"]></select:option>
</form:select>
Beschreibung der Attribute:
-
name: Name des Select-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
value: Wert der Option.
-
selected: Soll eine Option vorausgewählt dargestellt werden, so muss das
Attribut selected mit dem gleichnamigen Wert gefüllt sein.
-
selected: Definiert, ob eine Option als vorausgewählt dargestellt werden
soll oder nicht.
(Zeichen:
[selected|<leer>])
APF-Template
<form:text name="" [id=""] [class=""] [style=""] [filter="" [filterclass=""]]/>
Beschreibung der Attribute:
-
name: Name des Text-Felds. Über den Namen kann auf das Element zugegriffen werden.
(Zeichen:
[A-Za-z0-9-_])
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Feldes.
-
style: CSS-Klasse des Feldes.
-
filter: Name des anzuwendenen Filters.
-
filterclass: Angabe einer alternativen Filter-Klasse.
APF-Template
<form:validate validator="" button="" field="" [type=""] [msginputreq=""] [msginputwrg=""] />
Beschreibung der Attribute:
-
validator: Name des Validators, mit dem der Wert geprüft werden soll. (Zeichen:
[A-Za-z])
-
button: Name des Buttons des Formulars.
-
field: Name des Feldes, das validiert werden soll.
-
type: Ausgabe-Typ des Validators. Bei "text" gibt der Validator-Tag einen in der Konfigurations-Datei
angegebenen Text aus, bei "css" eine CSS-Formatierung. (Werte:
text|css).
-
msginputreq: Eintrag der Konfigurations-Datei, der bei Angabe des "type"s "text" statt der
Standard-Meldung ausgegeben werden soll um anzuzeigen, dass das mit "field" gekennzeichnete Feld nicht
gefüllt wurde. Wird der Parameter nicht angegeben werden Standard-Werte verwendet.
(Zeichen:
[A-Za-z0-9_-]).
-
msginputwrg: Eintrag der Konfigurations-Datei, der bei Angabe des "type"s "text" statt der
Standard-Meldung ausgegeben werden soll um anzuzeigen, dass das mit "field" gekennzeichnete Feld mit
dem falschen Wert gefüllt wurde. Wird der Parameter nicht angegeben werden Standard-Werte verwendet.
(Zeichen:
[A-Za-z0-9_-]).
APF-Template
<form:valgroup name="">
<valgroup:validate validator="" button="" field="" [type=""] [msginputreq=""] [msginputwrg=""] />
[<valgroup:placeholder name="" />]
</form:valgroup>
Beschreibung der Attribute:
-
name: Name der Validator-Gruppe. Es kann mehrere Gruppen in einem Formular geben.
-
validator: Name des Validators, mit dem der Wert geprüft werden soll. (Zeichen:
[A-Za-z])
-
button: Name des Buttons des Formulars.
-
field: Name des Feldes, das validiert werden soll.
-
type: Ausgabe-Typ des Validators. Bei "text" gibt der Validator-Tag einen in der Konfigurations-Datei
angegebenen Text aus, bei "css" eine CSS-Formatierung. (Werte:
text|css).
-
msginputreq: Eintrag der Konfigurations-Datei, der bei Angabe des "type"s "text" statt der
Standard-Meldung ausgegeben werden soll um anzuzeigen, dass das mit "field" gekennzeichnete Feld nicht
gefüllt wurde. Wird der Parameter nicht angegeben werden Standard-Werte verwendet.
(Zeichen:
[A-Za-z0-9_-]).
-
msginputwrg: Eintrag der Konfigurations-Datei, der bei Angabe des "type"s "text" statt der
Standard-Meldung ausgegeben werden soll um anzuzeigen, dass das mit "field" gekennzeichnete Feld mit
dem falschen Wert gefüllt wurde. Wird der Parameter nicht angegeben werden Standard-Werte verwendet.
(Zeichen:
[A-Za-z0-9_-]).
Optional besitzt die Validator-Gruppe Platzhalter, die mit der Methode
setPlaceHolder() auf
das Validator-Gruppen-Objekt gesetzt werden können. Attribute sind dem
html:placeholder-Tag zu entnehmen.
Der generische Validator kommt immer dann zum Einsatz, wenn es für den aktuellen Anwendungsfall
keinen passenden gibt. Dieser gibt den Inhalt des Tags bei nicht erfolgreicher Prüfung des
angegebenen Feldes zurück. So lassen sich beispielsweise einfach CSS-Attribute von HTML-Tags
beeinflussen.
Reichen die Prüfmethoden der Klasse
Validator
nicht aus, gibt es die Möglichkeit, die Validierung über einen regulären Ausdruck
auszuführen. Hierzu muss das Attribut
validator mit dem Wert
RegExp
gefüllt und der reguläre Ausdruck im Attribut
regexp bereitgestellt werden.
APF-Template
<form:genericval button="" field="" [validator="" [regexp=""]]>[text]</form:genericval>
Beschreibung der Attribute:
-
button: Name des Buttons des Formulars.
-
field: Name des Feldes, das validiert werden soll.
-
validator: Name des Validators, mit dem der Wert geprüft werden soll. (Zeichen:
[A-Za-z])
-
regexp: Regulärer Ausdruck. Das Attribut muss dann vorhanden sein, wenn der
Inhalt des Attributes validator "RegExp" ist. Letzteres indiziert, dass
die Validierung gemäß einem regulären Ausdruck erfolgen soll.
-
text: Text, der ausgegeben werden soll, falls das beschriebene Feld nicht
erfolgreich validiert werden konnte. Der Text kann beliebige HTML- bzw. XML-Fragmente enthalten.
Der Tag "form:getstring" dient dazu einen Konfigurations-String aus einer sprachabhängigen
Konfigurations-Datei auszulesen und anzuzeigen. So können auf einfache Weise mehrsprachige
Formulare aufgebaut werden.
APF-Template
<form:getstring namespace="" config="" entry="" />
Beschreibung der Attribute:
-
namespace: Namespace der Konfiguration des Attributes.
(Zeichen:
[A-Za-z0-9_-:])
-
config: Name der Konfiguration.
(Zeichen:
[A-Za-z0-9-_])
-
entry: Name des Konfigurations-Offsets.
(Zeichen:
[A-Za-z0-9-_.])
Die Taglib "form:addtaglib" bildet das Pendant zur Taglib "core:addtaglib" und bietet die
Möglichkeit, die bestehende Funktionalität der Formular-Tags zu erweitern. Die Implementierung
des Tags erlaub es beliebige weitere Formular-Tags einzubinden und zu verwenden.
APF-Template
<form:addtaglib namespace="" prefix="" class="" />
Beschreibung der Attribute:
-
namespace: Ein mit "::" getrennter Namespace-Pfad.
(Zeichen:
[A-Za-z0-9_-:])
-
prefix: XML-Prefix
(Zeichen:
[a-z])
-
class: XML-Klasse
(Zeichen:
[a-z])
Wie im Kapitel
Dynamische Formulare
beschrieben, ist der Tag
<form:marker />-Tag zur Positionierung von dynamischen
Formular-Elementen gedacht. Der Tag selbst erzeugt keine Ausgabe.
APF-Template
<form:marker name="" />
Beschreibung der Attribute:
-
name: Name des Markers. Dieser dient zur Adressierung desselben.
(Zeichen:
[A-Za-z0-9_-])
Seit dem Release 1.10 beinhalten die Formular-TagLibs einen Tag für Reset-Buttons. Diese
repräsentieren einen HTML-Reset-Button und können wie "normale" Buttons im Document-Controller
adressiert und konfiguriert werden.
APF-Template
<form:reset [value=""] [id=""] [class=""] [style=""] />
Beschreibung der Attribute:
-
value: Wert (Beschriftung) des Rest-Buttons.
-
id: Eindeutige ID innerhalb eines Formulars.
(Zeichen:
[A-Za-z0-9-_])
-
class: CSS-Klasse des Buttons.
-
style: CSS-Klasse des Buttons.
Möchten Sie den Artikel eine Anmerkung hinzufügen, oder haben Sie ergänzende Hinweise? Dann können Sie diese
hier einfügen. Die bereits verfassten Anmerkungen und Kommentare finden Sie in der untenstehenden Liste.
Für diesen Artikel liegen aktuell keine Kommentare vor.