The Common-Controls Tag Library

<forms:description>

The tag generates a description element. The description text is graphically assigned to the preceding form element.

The description text can be specified as an attribute (description) or directly in the tag body. In the tag-body, all the HTML elements can be used for formatting.

The tag may only be used within a com.cc.framework.taglib.forms.FormElementContainerTag. Examples of this are <forms:form>, <forms:section> and <forms:buttonsection>. The description element always refers to the immediately preceding form element.
../images/images/formdescription_small.gif

Body content: JSP
Tag class: FormElementDescriptionTag
 

[ Syntax ]

Standard Syntax
<forms:description
[ align = "{left | right | center}" ]
[ colspan = "Integer" ]
[ description = "String" ]
[ filter = "boolean" ]
[ height = "String" ]
[ imageref = "String" ]
[ join = "Boolean" ]
[ label = "String" ]
[ permission = "ACL" ]
[ valign = "{top | bottom | center}" ]
[ width = "String" ]
>
...Body Content...

</forms:description>
 

[ Attributes ]

AttributeTypeDescriptionReq.RTExp
alignAlignmentType Specifies the horizontal alignment of the element.
  • left = left alignment
  • right = right alignment
  • center = center alignment
 
colspanInteger Specifies the column span of a form element within a multi column form  
descriptionString The description text.  
filterboolean The automatic HTML coding of the element can be activated or disabled with the filter-attribute.  
heightString Sets the height of the form element. The height may be specified in absolute or percent terms.

Annotation: See HTML documentation for the attribute height.

 
imagerefString Pointer to an element of the Imagemap of the form. The image is drawn before the label of the element.  
joinBoolean Indicates that two adjacent form elements should be joined together  
labelString The label of the form element.  
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

 
valignAlignmentType Specifies the vertical alignment of the element.
  • top = top alignment
  • bottom = bottom alignment
  • center = center alignment
 
widthString Sets the width of the form element. The width may be specified in absolute or percent terms.

Annotation: See HTML documentation for the attribute width.

 

[ Example ]

Form element with an additional description text.


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

<forms:form  type="edit"  caption="Userprofile - Edit"  formid="frmEdit"  width="550">

    <forms:text  label="Mappings"  property="mappings"  maxlength="256"  size="70"/>

    <forms:description>
        Semicolon delimited list of currency mappings with the following format:
        <br/><b>[currency code in file]=[currency code in the database]</b>
    </forms:description>
</forms:form>

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