Die Common-Controls Tag Bibliothek

<ctrl:columncheck>

Erzeugt eine Check Spalte.

Der Check Zustand einer Zeile kann dabei über zwei Arten festgelegt werden:

Im Gegensatz zur Checkbox Spalte lößt die Check Spalte sofort das Server Event Check aus. Es wird der onCheck-Eventhandler der zugeordneten Action ausgelösst.

Da dem Eventhandler lediglich der Zeilenschlüssel und kein Spaltenkennzeichner als Parameter übergeben wird sollte in einem Kontrollelement maximal eine Check Spalte verwendet werden!
Dies hängt auch mit der möglichen Verwendung des Checkable Interfaces zusammen, welches für eine Row Bean ja auch nur einen Wert für eine einzelne Spalte liefern kann.
Eine Check Spalte eigent sich daher besonders dann, wenn sie für eine Zeilen Auswahl verwendet wird.

RolleJava Klasse
DesignmodelColumnCheckDesignModel
ReowbeanCheckable
Das <columncheck>-Tag darf nur innerhalb von einem Taghandler welcher das ColumnContainerTag Interface implementiert verwendet werden. Dies sind beispielsweise das <list>- oder das <treelist>-Tag.
../images/images/columncheck_small.gif

Body content: JSP
Tag class: ColumnCheckTag
 

[ Syntax ]

Standard Syntax
<ctrl:columncheck
[ ajax = "Boolean" ]
[ align = "{left | right | center}" ]
[ checkAll = "{none | false | page | all | true}" ]
[ filter = "Boolean" ]
[ join = "{none | false | concatenate | true | separator}" ]
[ maxlength = "Integer" ]
[ onblur = "String" ]
[ onchange = "String" ]
[ oncheck = "String" ]
[ oncheckall = "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" ]
[ onuncheck = "String" ]
[ onuncheckall = "String" ]
[ permission = "ACL" ]
[ property = "String" ]
[ sortable = "Boolean" ]
[ style = "String" ]
[ styleClass = "String" ]
[ styleId = "String" ]
[ target = "String" ]
[ targetProperty = "String" ]
[ title = "String" ]
[ tooltip = "String" ]
[ tooltipProperty = "String" ]
[ transaction = "Boolean" ]
[ width = "String" ]
>
...Body Content...

</ctrl:columncheck>
 

[ Attribute ]

AttributTypBeschreibungPflichtRTExp
ajaxBoolean Aktiviert die AJAX Funktion der Spalte. Alle Ereignisse werden dann mit JavaScript asynchron an den Server gesendet und dort verarbeitet.

Die Verarbeitung auf dem Server unterscheidet sich nicht von einer normalen Request Behandlung. Der Anwendungsentwickler hat jedoch die Möglichkeit über die Methoden des AjaxRequest Interfaces (Basisklasse von ActionContext) die Ergebnis Rückmeldung zu steuern.

Im Normalfall (-> AjaxRequest.isAjaxCanceled() == false) wird ein Delta XML Stream zum Web Browser zurückgeschickt. Dieser Stream enthält nur die schmutzigen Kontrollelemente, welche dann mit Hilfe eines JavaScript Handlers vom Web Browser im HTML DOM Tree selektiv ausgetauscht werden. Es wird also keine vollständige HTML Seite vom Server übertragen!

  • (+) Die übertragene Datenmenge ist kleiner.
  • (+) Die HTML Seite bleibt im Browser stehen und es gibt kein "flackern".
  • (-) Der Request wird nicht in der Browser Historie vermerkt!
  • (-) Es wird JavaScript benötigt, sonst wird ein normaler Server roundtrip ausgelößt

Die meisten Kontrollelemente fügen sich selbst in die Dirty Liste des ActionContext ein. Hierzu wird einfach die Methode AjaxRequest.markDirty() aufgerufen. Der Anwendungsentwickler hat damit die Möglichkeit noch weitere Kontrollelemente - die durch eine Zustandsänderung ebenfalls schmutzig geworden sind - in den Delta Stream aufzunehmen

Wenn der Request eine vollständig neue HTML Seite zurückgeben soll, dann besteht auch die Möglichkeit die AJAX Verarbeitung auf dem Server abzubrechen. Hierzu wird die Methode AjaxRequest.cancelAjaxRequest() aufgerufen. Das Framework sendet danach immer eine vollständige HTML Seite zurück an den Web Browser.

Das Common-Controls AJAX XML Protokoll hat das folgende Format:


<?xml version="1.0" encoding="UTF-8" ?>
<ajax-response>
	<token/>
	<controls>
		<control styleId="" class="" name="">
			<html>
				<[CDATA[...]] >
			</html>
		</control>
	</controls>
</ajax-response>
 
alignAlignmentType Gibt die Ausrichtung der Spalte an.
  • left = linksbündige Ausrichtung
  • right = rechtsbündige Ausrichtung
  • center = zentrierte Ausrichtung
 
checkAllCheckRange Gibt an ob im Spaltenkopf die Schaltflächen zur Mehrfachselektion von Datensätzen angezeigt werden sollen und auf welche Elemente sich diese Schaltfläche auswirken soll.
  • none = Es wird keine Mehrfachauswahl angeboten. der Anwender kann die Checkboxen nur einzeln auswählen.
  • false = Entspricht "none"
  • page = Es wird eine Schaltfläche zur Mehrfachauswahl angeboten. Ein Klick auf die Schaltfläche wirkt sich aber nur auf die angezeigten Elemente der aktuellen Seite aus.
  • all = Es wird eine Schaltfläche zur Mehrfachauswahl angeboten. Ein Klick auf die Schaltfläche wirkt sich auf alle - also auch die nicht sichtbaren - Elemente aus.
  • true = Entspricht "all"
 
filterBoolean Mit dem filter-Attribut kann die automatische HTML-Codierung des Spalteninhaltes 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.
 
joinJoinMode Verbindet die Zellen der Spalte mit den Zellen der vorangehenden Spalte.

Zellen können nur innerhalb derselben Spaltengruppe verbunden werden!

  • none = Die Spalten werden nicht verbunden
  • false = Entspricht "none"
  • concatenate = Die Spalten werden ohne Zwischenraum zusammengefügt
  • true = Entspricht "concatenate"
  • separator = Die Spalten werden mit einem Zwischenraum zusammengefügt
 
maxlengthInteger Gibt die maximale Zeichenzahl für die Anzeige in Spaltenüberschriften und Zellen an. Weitere Zeichen werden durch "..." angedeutet.
Diese Funktionalität ist unwirksam, wenn das Attribut filter="false" gesetzt ist, da in diesem Fall die tatsächlich sichtbare Zeichenzahl nicht ermittelt werden kann. 		 
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

 
oncheckString Fires when a checkbox is checked

Anmerkung: JavaScript Code

 
oncheckallString Fires when all rows are checked

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

 
onuncheckString Fires when a checkbox is unchecked

Anmerkung: JavaScript Code

 
onuncheckallString Fires when all rows are unchecked

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 Der Name des Properties welches die Daten der Spalte liefert.

Anmerkung: Gültiger Java Bezeichner. Die Zeilenobjekte müssen eine passende Property-Getter Methode implementieren.

 
sortableBoolean Das Attribut gibt an, ob nach dieser Spalte sortiert werden kann. Wird hier der Wert true angegeben, dann kann der Benutzer mit einem Mausklick auf den Spaltenkopf die Sortierung umschalten. Es wird in diesem Fall ein onSort Event ausgelösst.

In den folgenden Fällen kann das Framework das ListDataModel selbstständig sortieren:

  • Das ListDataModel ist von einer Java Collection Klasse abgeleitet
  • Das ListDataModel implementiert das Sortable Interface

In allen übrigen Fällen muss der Anwendungsentwickler eine eigene onSort() Methode zur Verfügung stellen.

 
styleString Über dieses Attribut kann direkt ein HTML-style Attribut für die Zellen der Spalte angegeben werden.

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

 
styleClassString Über dieses Attribut kann direkt ein HTML-class Attribut für die Zellen der Spalte angegeben werden.

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

 
styleIdString Über dieses Attribut kann direkt ein HTML-id Attribut für die Zellen der Spalte angegeben werden.

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

 
targetString Über dieses Attribut kann direkt ein HTML-target Attribut für die Zellen der Spalte angegeben werden.

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

 
targetPropertyString Gibt den Namen eines Properties an, welches als HTML-Target Attribut für die jeweilige Zelle verwendet wird.

Anmerkung: Gültiger Java Bezeichner. Die Zeilenobjekte müssen eine passende Property-Getter Methode implementieren.

 
titleString Gibt die Spaltenüberschrift an.

Die Zeichenkette wird vor der Ausgabe HTML-codiert.

 
tooltipString Gibt den Tooltip Text an

Anmerkung: lokalisierbare Zeichenkettenkonstante

 
tooltipPropertyString Gibt den Namen eines Properties an, mit dessen Hilfe die jeweilige Zelle mit einem HTML-Text Attribut versehen werden kann.

Anmerkung: Gültiger Java Bezeichner. Die Zeilenobjekte müssen eine passende Property-Getter Methode implementieren.

 
transactionBoolean Mit diesem Flag wird angegeben ob ein Transaction Token (siehe Struts Token Dokumentation) an alle Hyperlinks der Spalte angehängt werden soll.

Mit dem Transaction Token können Form Re-submissions (mehrfaches Absenden eines HTML Formulars) erkannt werden.

Funktionsweise: Das Transaction Token is ein "Stempel" mit welchem die Applikation jede generierte HTML Seite stempelt (es wird ein hidden Field bzw. zusätzliche URL Parameter für alle Hyperlinks erzeugt). Bei einem Server Request kann der vom Browser zurückgeliefert Stempel mit dem in der Session gespeicherten Wert verglichen werden. Wenn der Wert übereinstimmt, dann passt die Seite zum aktuellen Applikations Zustand.
Stimmt der Stempel nicht überein, dann sind Applikationszustand und Browser Inhalt asynchron und die Applikation kann auf diesen Fehler - wie auch immer - reagieren. Eine Abweichung entsteht immer dann, wenn der Anwender eine ältere Seite aus der Browser Historie absendet.

 
widthString Setzt die Breite der Spalte. Die Breite kann dabei absolut oder prozentual angegeben werden.

Siehe HTML-Dokumentation.

 
 

[ Server Ereignisse ]

EreignisBeschreibung
Check 
public void control_onCheck(
	ControlActionContext ctx,
	String key,
	SelectMode mode,
	boolean checked) throws Exception
Dieses Event wird ausgelößt, wenn der Anwender eine Checkbox in einer Check-Spalte betätigt.
Liegt in der Verantwortung der Applikation.
Wenn die selektierte Row Bean das Checkable Interface implementiert, dann wird automatisch die Checkable.setCheckState() Methode aufgerufen.

[ Beispiel ]

Erzeugt ein List Control mit einer Check Spalte. Die Row-Beans implementieren das Checkable Interface, daher muss kein property-Attribut angegeben werden.


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

<ctrl:list
   action="personBrowse"
   name="persons"
   title="Person List"
   rows="15">

   <ctrl:columncheck title="Edit"/>
</ctrl:list>

                  
© 2000 - 2007 by www.common-controls.com (erstellt mit Common Controls TLDFactory)