Die Common-Controls Tag Bibliothek

<ctrl:cancel>

Das Tag erzeugt eine abbrechen Schaltfläche. Im Gegensatz zu einer normalen Schaltfläche werden bei einer abbrechen Schaltfläche nach einem Server roundtrip keine Formulardaten übernommen und es wird keine Eingabe Validierung durchgeführt.

Bei Angabe des src-Attributes wird die Schaltfläche als Grafik gezeichnet.

Bei Angabe des text-Attributes wird ein Textbutton mit einer Hintergrundgrafik erstellt. Dabei werden verschiedene Grafik für den linken, mittleren und rechten verwendet.

Verwendete Java Klassen/Interfaces:

RolleJava Klasse
ControlCalendarControl
DesignmodelCalendarDesignModel
StatemodelTextStateModel

Body content: EMPTY
Tag class: CancelTag
 

[ Syntax ]

Standard Syntax
<ctrl:cancel
[ action = "String" ]
[ base = "Verzeichnisname oder Ressourcenschlüssel" ]
[ border = "Integer" ]
[ buttonStyle = "Integer" ]
[ disabled = "Boolean" ]
[ filter = "Boolean" ]
[ formElement = "Boolean" ]
[ id = "String" ]
[ locale = "String" ]
[ name = "String" ]
[ onblur = "String" ]
[ onchange = "String" ]
[ onclick = "String" ]
[ oncontextmenu = "String" ]
[ ondblclick = "String" ]
[ onfocus = "String" ]
[ onkeydown = "String" ]
[ onkeypress = "String" ]
[ onkeyup = "String" ]
[ onmousedown = "String" ]
[ onmousemove = "String" ]
[ onmouseout = "String" ]
[ onmouseover = "String" ]
[ onmouseup = "String" ]
[ permission = "ACL" ]
[ property = "String" ]
[ runat = "{server | client | auto}" ]
[ scope = "{any | page | request | session | application}" ]
[ shadow = "Boolean" ]
[ src = "String" ]
[ style = "String" ]
[ styleClass = "String" ]
[ styleId = "String" ]
[ tabindex = "Integer" ]
[ text = "String" ]
[ title = "String" ]
[ tooltip = "String" ]
[ width = "String" ]
/>
 

[ Attribute ]

AttributTypBeschreibungPflichtRTExp
actionString Gibt die Struts Action an, welche bei Kontrollelement Ereignissen aufgerufen werden soll.

Dieses Attribut muss nicht angegeben werden, wenn das Tag von einem Struts <html:form> Tag umschlossen ist. in diesem Fall wird der Name der Action über die Struts Formular Bean ermittelt.

Anmerkung: Die Action muss in einer der struts-config.xml Dateien deklariert sein.

 
baseVerzeichnisname oder Ressourcenschlüssel Setzt das Basisverzeichnis für eine Ressource. Dieses wird dem eigentlichen Ressourcennamen vorangestellt. Das base Attribut kann wegen des Lokalisierungsmechanismus des Frameworks auch als Schlüssel der ApplicationProperties.properties Datei angegeben werden.  
borderInteger Gibt die Stärke des Rahmens an, welcher um das Kontrollelement gezeichnet werden soll.  
buttonStyleInteger

Id (nummerisch) zur Referenzierung einer alternativen Hintergrundgrafik für einen Textbutton.

Die Hintergrundgrafiken müssen zuvor in einer ResourceMap registriert worden sein.
Der Resourcenschlüssel wird dabei nach der folgenden Konvention mit der angegebenen Id zusammengesetzt:

ResourcenschlüsselBeschreibung
app.tbtn.bg.left<id>Linkes Hintergrund Bild
app.tbtn.bg.middle<id>Hintergrund Bild
app.tbtn.bg.right<id>Rechtes Hintergrund Bild
 
disabledBoolean Über dieses Attribut kann das Kontrollelement deaktiviert werden. Es nimmt dann keine Benutzereingaben entgegen und erzeugt keine Kontrollelement Ereignisse.  
filterBoolean Mit dem filter-Attribut kann die automatische HTML-Konvertierung des Elementes aktiviert bzw. deaktiviert werden.
  • true = Die HTML Konvertierung ist aktiv. So wird beispielsweise das "<" Zeichen als "&lt;" codiert. HTML Code wird damit nicht ausgeführt.
  • false = Die HTML Konvertierung ist abgeschaltet. HTML Code wird demzufolge direkt in die Seite eingesetzt und somit ausgeführt.
 
formElementBoolean Über dieses Attribut wird gesteuert, wie sich das Kontrollelement im Falle einer Benutzer Aktion verhalten soll.
Als Formularelement
Es wird ein Submit des umschliessenden Formulars ausgeführt. Alle Informationen über das Kontrollelement Ereignis werden in Hidden Feldern zum Server transportiert.
Als eigenständiges Kontrollelement
Kontrollelement Ereignisse werden direkt in Form von Hyperlinks ausgelösst. Sämtliche eingegeben Daten in der HTML Seite gehen damit verloren!
Intern wird über dieses Attribut gesteuert, wie der ActionPainter Links generieren soll - als HTML-a Tag oder HTML-input Tag.

Anmerkung: Der Wert true (= Formularelement) darf nur dann verwendet werden, wenn sich das Kontrollement in einem Formular befindet.

 
idString Weist dem Kontrollelement einen eindeutigen Bezeichner zu. Im Tag Body wird daraufhin eine Java Variable angelegt, auf die in Java Scriptlets zugegriffen werden kann. Diese Variable verweist auf die Kontrollelement Instanz (abgeleitet von Control).

Dieses Attribut wird meist in Verbindung mit dem type Attribut verwendet

Anmerkung: Da zur JSP Compile Zeit eine Java Variable mit diesem Bezeichner angelegt wird, muss hier ein String Literal (und keine Expression!) angegeben werden! Der Bezeichner muss den Regeln für gültiger Java Bezeichner folgen.

 
localeString Weist das Kontrollelement an alle angegebenen Zeichenkettenliterale als Schlüssel für Textressourcen zu interpretieren.

Die folgenden Werte sind möglich:

  • "true" Die Lokalisierung ist aktiv und es wird die von Struts vergebene Ländereinstellung des angemeldenten Benutzers verwendet (wie in der HTTP Session unter dem Schlüssel org.apache.struts.action.LOCALE abgelegt).
  • "false" Die Lokalisierung ist nicht aktiviert. Alle Zeichenkettenliterale werden wie angegeben in die HTML Seite geschrieben.
  • ISO Code Die Lokalisierung ist aktiv und es wird die angegebene Sprache verwendet.

Bei aktivierter Lokalisierung werden die angegebenen Schlüssel von dem registrierten FrameworkAdapter (eine Interface Klasse) mit Hilfe der überschreibbaren localizeKey() Methode übersetzt. Der mitgelieferte StrutsFrameworkAdapter verwendet die in der struts-config.xml registrierten Message Resource Bundles für die Übersetzung des Ressourcen Schlüssels.

Zeichenketten die mit einem "#"-Zeichen beginnen werden grundsätzlich nicht lokalisiert (Das "#"-Zeichen wird jedoch abgeschnitten).

Alle Zeichenketten die von einem DataModel zurückgeliefert werden, sind ebenfalls von dem Lokalisierungsmechanismus ausgeschlossen, da dies in den Aufgabenbereich der Applikation fällt.

 
nameString Gibt den Namen der Java-Bean - eine Instanz der Klasse Control. Die Java-Bean muss im angegebenen Scope abgelegt sein.

Wenn das Tag von einem Struts <html:form> Tag umschlossen ist, dann muss kein Bean Name angegeben werden. In diesem Fall wird die Java-Bean über ein Property der Struts Formular Bean gezogen.

Anmerkung: Es muss ein gültiger Java Bezeichner angegeben werden.

 
onblurString Fires when the object loses the input focus.

Anmerkung: JavaScript Code

 
onchangeString Fires when the contents of the object or selection have changed.

Anmerkung: JavaScript Code

 
onclickString Fires when the user clicks the left mouse button on the object.

Anmerkung: JavaScript Code

 
oncontextmenuString Fires when the user clicks the right mouse button in the client area, opening the context menu.

Anmerkung: JavaScript Code

 
ondblclickString Fires when the user double-clicks the object.

Anmerkung: JavaScript Code

 
onfocusString Fires when the object receives focus.

Anmerkung: JavaScript Code

 
onkeydownString Fires when the user presses a key.

Anmerkung: JavaScript Code

 
onkeypressString Fires when the user presses an alphanumeric key.

Anmerkung: JavaScript Code

 
onkeyupString Fires when the user releases a key.

Anmerkung: JavaScript Code

 
onmousedownString Fires when the user clicks the object with either mouse button.

Anmerkung: JavaScript Code

 
onmousemoveString Fires when the user moves the mouse over the object.

Anmerkung: JavaScript Code

 
onmouseoutString Fires when the user moves the mouse pointer outside the boundaries of the object.

Anmerkung: JavaScript Code

 
onmouseoverString Fires when the user moves the mouse pointer into the object.

Anmerkung: JavaScript Code

 
onmouseupString Fires when the user releases a mouse button while the mouse is over the object.

Anmerkung: JavaScript Code

 
permissionACL Mit diesem Attribut kann der Zugriff auf das Element beschränkt werden.

Berechtigungen werden über das Principal Objekt in der Benutzer Session geprüft. Das Principal Objekt wird mit der Methode SecurityUtil.registerPrincipal() in der Session registriert. Es wird vom Anwendungsentwickler durch Implementierung des Principal Interfaces zur Verfügung gestellt. Somit lassen sich sehr einfach beliebige Berechtigungssysteme mit dem Framework verbinden.

Berechtigungen werden immer in Form einer Access Control List (ACL) angegeben. Dabei handelt es sich um einen Ausdruck dessen Elemente Einzelberechtigungen sind. Das Framweork unterstützt die folgenden Berechtigungstypen, welche jedoch vom Anwendungsentwickler beliebig erweitert werden können:

Literal
true|false -> StaticPermission
Rolle
#rollenname -> RoleBasedPermission
Funktion
$funktionsname -> FunctionBasedPermission

Zur Formulierung der Ausdrücke kann die folgende Syntax verwendet werden:

PERMISSION_PREFIX
	: '#' | '$'

AND_OP
	: 'and' | '&' | '*'

XOR_OP
	: 'xor' | '^'

OR_OP
	: 'or' | '|' | '+'

UNARY_OP
	: '~' | '!'

permission
	: PERMISSION_PREFIX IDENTIFIER

primary_expr
	: permission
	| '(' expr_list ')'

unary_expr
	: primary_expr
	| UNARY_OP primary_expr

logical_and_expr
	: unary_expr
	| logical_and_expr AND_OP unary_expr

logical_xor_expr
	: logical_and_expr
	| logical_or_expr XOR_OP logical_and_expr

logical_or_expr
	: logical_xor_expr
	| logical_or_expr OR_OP logical_xor_expr

expr_list
	: logical_or_expr
	| expr_list ';' logical_or_expr
	| expr_list ',' logical_or_expr

Access Control Listen werden mit der statischen Methode AccessControlList.parse() eingelesen. Der Parser verwendet wiederum die statische Methode PermissionFactory.parse() um die einzelnen Permissions zu lesen. Der Anwendungsentwickler kann über die PermissionFactory eigene von Permission abgeleitete Klassen registrieren und so den Sprachumfang der ACL erweitern.

 
propertyString Gibt den Namen des Properties an, über welchen auf die Java-Bean zugegriffen werden soll. Dies ist in der Regel nur dann notwendig, wenn die Java-Bean mit einer Struts Formular Bean assoziiert ist.

Anmerkung: Es muss ein gültiger Java Bezeichner angegeben werden.

 
runatRunAt Dieses Attribut gibt an, ob für das Kontrollelement JavaScript verwendet werden soll, oder ob das Kontrollelement ausschließlich mit Server Roundtrips arbeiten soll.
  • server = Alle Kontrollelement Aktionen führen zu einem Server Roundtrip und werden auf dem Server bearbeitet.
  • client = Kontrollelement Aktionen werden direkt im Browser des Benutzers durchgeführt. Es hängt von der verwendeten Painter Factory und dem konkreten Kontrollelement Painter ab, wie weit die Unterstützung für Clientside Scripting geht.
  • auto = Das Framework wählt basierend auf der JavaScript Aktivierung des Anwender Browsers den Modus "client" bei aktiviertem JavaScript und "server" bei deaktiviertem JavaScript (siehe BrowserInfo).
 
scopeHttpScope Dieses Attribut gibt den Scope an, in welchem die Java-Bean mit den eigentlichen Anzeigedaten zu finden ist.
  • any = Nach der Bean wird in jedem Scope gesucht.
  • page = Die Bean liegt im PageContext der JSP Seite.
  • request = Die Bean liegt im HTTP Servlet Request
  • session = Die Bean liegt in der HTTP Session
  • application = Die Bean liegt applikationsweit im Servlet Kontext
 
shadowBoolean Gibt an ob das Kontrollelement mit einem Schatten hinterlegt werden soll.

Diese Funktion ist nur bei bestimmten Painterfactories verfügbar

 
srcString Gibt den Namen der Image Ressource mit dem Schaltflächenbild an.

Namenskonvention: Das Framework bietet einen Mechanismus zum automatischen Image Austausch bei bestimmten Mausereignissen an. Damit der Mechanismus genutzt werden kann gelten die folgenden Regeln:

  • Der Name der Schaltfläche (angegeben im name-Attribut) muss mit dem Präfix btn beginnen.
  • Der Dateiname des verwendeten gif Bildes muss das folgende format haben: xxxxxxxN.gif. Dabei Steht <N> für den Schaltflächenzustand.
Es werden die folgenden Schaltflächenzustände unterschieden:
  • 1 = aktiv (normal)
  • 2 = inaktiv (disabled)
  • 3 = hover (Maus über der Schaltfläche)
  • 4 = pressed
 
styleString Über dieses Attribut kann direkt ein HTML-style Attribut angegeben werden.

Anmerkung: Siehe HTML Dokumentation für das Attribut style.

 
styleClassString Über dieses Attribut kann direkt ein HTML-class Attribut angegeben werden.

Anmerkung: Siehe HTML Dokumentation für das Attribut class.

 
styleIdString Über dieses Attribut kann direkt ein HTML-id Attribut angegeben werden.

Anmerkung: Siehe HTML Dokumentation für das Attribut id.

 
tabindexInteger Legt den Tabulator Index für dieses Element fest.  
textString Die lokalisierbare Beschriftung der Schaltfläche. Wird dieses Attribut angegeben, dann wird die Schaltfläche als Text-Button gezeichnet.  
titleString Wird in einem Tooltip Fenster angezeigt, wenn der Anwender die Maus über die Schaltfläche bewegt.  
tooltipString Tooltip Text welcher in einem Popup Fenster angezeigt wird, wenn der Benutzer die Maus über das Kontrollelement bewegt.

Die Zeichenkette wird vor der Ausgabe HTML-codiert

 
widthString Setzt die Breite des Kontrollelmentes. Die Breite kann absolut oder prozentual angegeben werden.

Siehe HTML-Dokumentation

 

[ Beispiel ]

Formularelement mit einer Schaltfläche


<%@ taglib uri="http://www.common-controls.com/cc/tags-ctrl"    prefix="ctrl" %>

<ctrl:cancel  name="btnBack"  src="images/buttons/btnCancel1.gif"/>