The Common-Controls Tag Library

<ctrl:columntree>

Generates a tree structure column for the TreeNodeDataModel of the control element.
The <columntree>-tag may only be used within a Taghandler which implements the com.cc.framework.taglib.controls.ColumnContainerTag Interface. These are e.g. the <list>- or the <treelist>-tag.
../images/images/columntree_small.gif

Body content: JSP
Tag class: ColumnTreeTag
 

[ Syntax ]

Standard Syntax
<ctrl:columntree
[ ajax = "Boolean" ]
[ align = "{left | right | center}" ]
[ converter = "Java class or Converter Id" ]
[ filter = "boolean" ]
[ imagemap = "String" ]
[ imageProperty = "String" ]
[ join = "{none | false | concatenate | true | separator}" ]
[ maxlength = "Integer" ]
[ onblur = "String" ]
[ onchange = "String" ]
[ oncheck = "String" ]
[ onclick = "String" ]
[ oncollapse = "String" ]
[ oncontextmenu = "String" ]
[ ondblclick = "String" ]
[ onexpand = "String" ]
[ onexpandex = "String" ]
[ onfocus = "String" ]
[ onkeydown = "String" ]
[ onkeypress = "String" ]
[ onkeyup = "String" ]
[ onmousedown = "String" ]
[ onmousemove = "String" ]
[ onmouseout = "String" ]
[ onmouseover = "String" ]
[ onmouseup = "String" ]
[ onuncheck = "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:columntree>
 

[ Attributes ]

AttributeTypeDescriptionReq.RTExp
ajaxBoolean Activates the AJAX function of the column. With AJAX all control events will be sent asynchronously to the application server where the processing takes place.

The event processing on the server is the same as without AJAX enabled. However the application developer has the possibility to control the response output through some additional methods of the AjaxRequest interface (the base class for ActionContext).

The normal AJAX server processing (-> AjaxRequest.isAjaxCanceled() == false) will send back a XML stream to the Web Browser. This stream contains only the HTML code for the dirty controls, which will be merged in the Browser through a JavaScript handler into the current HTML DOM Tree. So the Server will not transmit the full HTML page!

  • (+) The transfered HTML code is much smaller.
  • (+) The HTML page stays in the Browser window while the server request is being processed. So the screen will not "flicker".
  • (-) The browser will not keep track of AJAX requests in the navigation history!
  • (-) AJAX depends on JavaScript. Without JavaScript the event will result in a normal browser - server round trip.

Most of the Controls will add themselves to the dirty list of the ActionContext. This is done through a call to AjaxRequest.markDirty(). With this method the application developer has the opportunity to add additional controls to the dirty list and send them back to the browser in the XML stream. This is necessary when an event handler changes the state of a second control that was not the originator of the request.

In some cases it is not sufficient to send back only the dirty control because the whole HTML page has to be changed. In this cases the application developer can cancel AJAX server event processing by calling the AjaxRequest.cancelAjaxRequest() method. When the AJAY request is canceled the framework will send a full HTML page back to the Browser - as if this was a normal HTTP request.

The Common-Controls AJAX XML Protocol has the following format:


<?xml version="1.0" encoding="UTF-8" ?>
<ajax-response>
	<token/>
	<controls>
		<control styleId="" class="" name="">
			<html>
				<[CDATA[...]] >
			</html>
		</control>
	</controls>
</ajax-response>
 
alignAlignmentType Specifies the alignment of the column.
  • left = left alignment
  • right = right alignment
  • center = centered alignment
 
converterJava class or Converter Id Specifies the Converter which should be used to convert the data for the control. If the attribute is not set the framework will use a default converter which matches the controls data type (ConverterRegistry.lookup()).

A converter can be specified in different ways:

  • The public Converter Id is set.
  • Or a full qualified Java class name for the converter is specified. The class must implement the interface Converter

Annotation: The class must to implement the interface Converter!

 
filterboolean The automatic HTML coding of the column contents can be activated or disabled with the filter-attribute.  
imagemapString Specifies the name of an Imagemap which must be saved in the request. The values that the ImageProperty returns are mapped to the entries of this Imagemap. The mapping is done with the help of the regular expression, which is assigned to every entry of the Imagemap.

The Framework appends, in the case of group nodes, to the value of the ImageProperty the character strings .open or .closed, in order to be able to distinguish between the open and closed states.

By default, the framework uses a folder icon as the image for group nodes.

Annotation: Under the name, there must be an Imagemap saved in the request.

 
imagePropertyString Specifies the property using which an image can be assigned to every Row-Bean.

The image names do not designate any direct HTML-resources; rather, they are translated into the actual resource names with the help of the Imagemap.

Annotation: Valid Java designator/label for a property which has to be implemented by every Row-Bean.

 
joinJoinMode This attribute will join the cell within the column with the cell of the previous column.

If the cell is embedded within a column group it can only be joined with cells within this column group

  • none = The cells will not be joined
  • false = The cells will not be joined (same as "none")
  • concatenate = The cells will be joined without a spacing
  • true = Same as "concatenate"
  • separator = The cells will be joined with a space
 
maxlengthInteger Specifies the maximal number of characters which should be displayed in the column header and content. If the maxlength is exceeded, a hint "..." is displayed.
This functionality is not provided if the filter attribute is set to false. In this case the number of visible characters can not be detected, because the String can contain some html data. 		 
onblurString Fires when the object loses the input focus.

Annotation: JavaScript Code

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

Annotation: JavaScript Code

 
oncheckString Fires when a checkbox is checked

Annotation: JavaScript Code

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

Annotation: JavaScript Code

 
oncollapseString Fires when a tree node is collapsed

Annotation: JavaScript Code

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

Annotation: JavaScript Code

 
ondblclickString Fires when the user double-clicks the object.

Annotation: JavaScript Code

 
onexpandString Fires when a tree node is expanded

Annotation: JavaScript Code

 
onexpandexString Fires when a tree node with unknown child count is expanded

Annotation: JavaScript Code

 
onfocusString Fires when the object receives focus.

Annotation: JavaScript Code

 
onkeydownString Fires when the user presses a key.

Annotation: JavaScript Code

 
onkeypressString Fires when the user presses an alphanumeric key.

Annotation: JavaScript Code

 
onkeyupString Fires when the user releases a key.

Annotation: JavaScript Code

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

Annotation: JavaScript Code

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

Annotation: JavaScript Code

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

Annotation: JavaScript Code

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

Annotation: JavaScript Code

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

Annotation: JavaScript Code

 
onuncheckString Fires when a checkbox is unchecked

Annotation: JavaScript Code

 
permissionACL With this attribute, access to the element can be restricted.

Authorizations are checked using the com.cc.framework.security.Principal object in the user session. The principal object is registered in the session with the method com.cc.framework.security.SecurityUtil#registerPrincipal(HttpSession, Principal). It is made available by the application developer by implementing the principal interface. In this manner, any authorization system can be very easily connected within the framework.

Authorizations are always specified in the form of an Access Control List (ACL). What is involved here is a semicolon-delimited list with individual authorizations. The framweork supports the following authorization types, which, however, can be expanded at will by the application developer:

Literal
true|false -> com.cc.framework.security.StaticPermission
Role
#rolename -> com.cc.framework.security.RoleBasedPermission
Function
$functionname -> com.cc.framework.security.FunctionBasedPermission

 
propertyString The name of the property that contains the data of the column. There must be a corresponding property-getter implemented in the Row Bean.

With some column types, by returning a Boolean value, the relevant line can be activated or deactivated

Annotation: Valid Java identifier/label. The Row-Bean must implement a suitable property-getter method.

 
sortableboolean The attribute indicates whether sorting can be carried out according to this column. Here, if the value true is specified, then the user can toggle the sorting order with a click on the column header.  
styleString An HTML-style can be directly specified with this attribute.

Annotation: See HTML documentation for the attribute style.

 
styleClassString The HTML-class attribute of the element can be specified with this attribute.

Annotation: See HTML documentation for the attribute class.

 
styleIdString The HTML-id attribute of the element can be specified with this attribute.

Annotation: See HTML documentation for the attribute id.

 
targetString The HTML-target attribute of the element can be specified with this attribute.

Annotation: See HTML documentation for the attribute target.

 
targetPropertyString Specifies the name of a property with the help of which the relevant line can generate an HTML-target attribute.

Annotation: Valid Java identifier/label. The Row-Bean must implement a suitable property-getter method.

 
titleString Specifies the column title.

The character string is HTML-coded before outputting.

 
tooltipString Sets the tooltip text

Annotation: String literal or resource key

 
tooltipPropertyString Specifies the name of a property with the help of which the relevant line can generate an HTML-text attribute.

Annotation: Valid Java identifier/label. The Row-Bean must implement a suitable property-getter method.

 
transactionBoolean This flag directs the framework to append a transaction token to all generated hyperlinks of the column. The transactio token allows the detection of form re-submissions (multiple submission of the same HTTP form).  
widthString Sets the width of the column. The width may be specified in absolute or percent terms.

See the HTML-documentation.

 

[ Example ]

Generates a TreeList Control with an ImageMap and a Tree column.


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

<util:imagemap name="im_region">
   <util:imagemapping rule="country" src="images/imgItem.gif" width="16" height="16"/>
</util:imagemap>

<ctrl:treelist
   id="treelist13"
   name="regions"
   title="Region Hierarchy"
   rows="15"
   expandMode="multiple"
   buttons="true"
   lines="true"
   linesAtRoot="false"
   root="true" refreshButton="true">
   
   <ctrl:columntree  title="Region"  property="region"  width="150"  imageProperty="type"  imagemap="im_region"/>
</ctrl:treelist>

                  
© 2000 - 2007 by www.common-controls.com (build with Common Controls TLDFactory)