Dokumentation: WebTML-Default-Aktionen

WebTML-Aktionen sind Prozeduren die von einer WebTML-Seite aus oder aus einer anderen Prozedur heraus aufgerufen werden können. Normalerweise bestehen diese Prozeduren aus TMLScript-Code, der definiert werden muss bevor die entsprechende WebTML-Aktion verwendet werden kann.

Es gibt jedoch eine Anzahl an vordefinierten WebTML-Aktionen, welche direkt verwendet werden können. Diese werden Default-Aktionen genannt und bieten sehr allgemeine Funktionalitäten die in den meisten WGA-Entwicklungen vonnöten sind, wie das Setzen einer WebTML-Variable. Ihre Verwendung ist identisch zur Verwendung normaler WebTML-Aktionen. Sie besitzen IDs, ebenso wie normale WebTML-Aktionen, über welche sie adressiert werden können. Zur Unterscheidung beginnen die IDs aller Default-Aktionen mit dem Dollarzeichen "$".

<tml:form id="testform">

Input: <tml:input name="field"/>
<tml:button clickaction="$store">Speichern</tml:form>

</tml:form>

Folgende Default-Aktionen sind verfügbar.

Die Angabe "aktuelles WebTML-Formular" bezieht sich im Folgenden auf das WebTML-Formular in dessen inneren die Aktion referenziert wird (bzw. das Formular welches explizit per geeignetem Attribut, z. B. form an <tml:url> gesetzt wird).

Der "aktuelle Kontext" ist der Kontext unter welchem die Aktion referenziert wurde.

1.4.1 action="$attach"

Description:

Hängt alle Dateien, die zum aktuellen WebTML-Formular hochgeladen wurden, an das aktuell im Kontext befindliche Inhaltsdokument an und speichert dieses. Diese Aktion wird automatisch als Master-Aktion ausgeführt.

1.4.2 action="$changelanguage"

Description:	Ändert die bevorzugte Sprache des aktuellen Benutzers auf die Parametersprache. In den meisten Fällen sollte zum Wechsel der bevorzugten Sprache die Funktionalität <tml:url type="changelanguage"> bevorzugt werden, da diese den Vorteil hat auch von Suchmaschinen indizierbar zu sein. Ein WebTML-Aktionslink ist nicht indiziertbar.
Parameters:	param1: Die neue bevorzugte Sprache als Sprachcode

1.4.3 action="$refresh"

Description:

Lädt die aktuelle WebTML-Seite bzw. das aktuelle AJAX-Portlet erneut ohne weitere Funktionalitäten auszulösen.

Diese Aktion eignet sich z.B. im Attribut changeaction des Tags <tml:input> um zu erreichen, dass die aktuelle Seite mit der veränderten Auswahl einfach neu geladen werden soll.

1.4.4 action="$reset"

Description:

Setzt das aktuelle WebTML-Formular zurück. Dabei werden aller gespeicherten Felder und hochgeladenen Dateien entfernt.

1.4.5 action="$setpvar"

Description:	Setzt eine WebTML-Portlet-.Variable für das aktuelle Portlet entsprechend der Parameter. Diese Variable ist entsprechend der Gültigkeitsdauer normaler Portlet-Variablen nur in dem Request gültig welcher der Ausführung dieser Aktion folgt. Aufgrund der Limitierungen von WebTML-Aktionsparameter können nur Variablen mit textuellem Inhalt gesetzt werden.
Parameters:	param1: Name der WebTML-Portlet-Variable param2: Inhalt der WebTML-Portlet-Variable

1.4.6 action="$setsessionvar"

Description:	Setzt eine WebTML-Session-Variable entsprechend der Parameter. Aufgrund der Limitierungen von WebTML-Aktionsparameter können nur Variablen mit textuellem Inhalt gesetzt werden.
Parameters:	param1: Name der WebTML-Session-Variable param2: Inhalt der WebTML-Session-Variable

1.4.7 action="$setvar"

Description:	Setzt eine WebTML-Variable entsprechend der Parameter. Diese Variable ist entsprechend der Gültigkeitsdauer normaler WebTML-Variablen nur in dem Request gültig welcher der Ausführung dieser Aktion folgt. Aufgrund der Limitierungen von WebTML-Aktionsparameter können nur Variablen mit textuellem Inhalt gesetzt werden.
Parameters:	param1: Name der WebTML-Variable param2: Inhalt der WebTML-Variable

1.4.8 action="$store"

Description:

Speichert das aktuelle WebTML-Formular inklusive aller Felder und hochgelandener Dateien, an seinem Quell-Dokument.

Diese Aktion entspricht dem Aufruf von tmlform.storeInContent() bzw. tmlform.storeInProfile() oder tmlform.storeInPortlet(), je nach Quelle des Formulars, sowie einer folgenden Default-Aktion "$attach" zur Speicherung aller hochgeladenen Dateien.

1.4.9 action="setpsessionvar"

Description:	Setzt eine WebTML-Portlet-Session-Variable für das aktuelle Portlet entsprechend der Parameter. Aufgrund der Limitierungen von WebTML-Aktionsparameter können nur Variablen mit textuellem Inhalt gesetzt werden.
Parameters:	param1: Name der Portlet-Session-Variable param2: Inhalt der Portlet-Session-Variable

1.4 WebTML-Default-Aktionen

1.4.1 action="$attach"

1.4.2 action="$changelanguage"

1.4.3 action="$refresh"

1.4.4 action="$reset"

1.4.5 action="$setpvar"

1.4.6 action="$setsessionvar"

1.4.7 action="$setvar"

1.4.8 action="$store"

1.4.9 action="setpsessionvar"