com.cc.framework.taglib.controls
Class ColumnBaseTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended bycom.cc.framework.taglib.ScriptBodyTagSupport
              extended bycom.cc.framework.taglib.controls.ColumnBaseTag
All Implemented Interfaces:
AjaxSupportTag, javax.servlet.jsp.tagext.BodyTag, ConversionSupportTag, DesignRuleContainerTag, InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
ColumnAddTag, ColumnBaseBodyTag, ColumnButtonTag, ColumnCheckTag, ColumnDeleteTag, ColumnDrilldownTag, ColumnEditTag, ColumnGroupTag, ColumnImageTag, ColumnLinkTag, ColumnSelectorTag, ColumnTextareaTag, ColumnTextTag, ColumnTreeTag

public abstract class ColumnBaseTag
extends ScriptBodyTagSupport
implements InnerTag, DesignRuleContainerTag, ConversionSupportTag, AjaxSupportTag

Base class for column tag handler

Since:
1.0
Version:
$Revision: 1.50 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  ColumnContainerTag container
          The Parent Container Tag
private  ColumnDesignModel designModel
          The DesignModel of the column
private static long serialVersionUID
          Serial Version UID
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
ColumnBaseTag()
          Constructor
 
Method Summary
 void addDesignRule(DesignRule rule)
          Adds a new design rule to the container
 void assignConverter(Converter converter)
          Assigns a converter to the Tag
protected abstract  ColumnDesignModel doCreateDesignModel()
          This method is called to create the DesignModel for the column
 int doEndTag()
           
 int doStartTag()
           
 ClientHandler getClientHandler()
          Returns the ClientHandler interface of the controls design model.
 ColumnContainerTag getContainer()
          Returns te container in which this column is nested
protected  ColumnDesignModel getDesignModel()
          Returns the DesignModel for the column
 void release()
           
protected  void releaseDesignModel()
          This method gets called when the design model is not longer needed
 void setAjax(boolean ajax)
          Directs the framework to add additional AJAX handlers to the control.
 void setAjax(java.lang.String ajax)
          Directs the framework to add additional AJAX handlers to the column.
 void setAlign(java.lang.String alignment)
          Specifies the alignment of the column: left = left alignment.
 void setAnchor(java.lang.String anchor)
          The HTML-Anchor attribute of the element can be specified with this attribute.
 void setAnchorProperty(java.lang.String anchorProperty)
          Specifies the name of a property with the help of which the relevant line can generate an HTML-Anchor attribute.
 void setConverter(java.lang.String converter)
          Sets the Converter that should be used to convert Java Objects into their localized String representation.
 void setDisabled(java.lang.String disabled)
          Sets the columns disable mode
 void setDisableProperty(java.lang.String property)
          Sets the property which should be used to disable the column
 void setEditable(java.lang.String editable)
          Sets the columns edit mode
 void setEditableProperty(java.lang.String property)
          Sets the property which should be used to make the column editable or not
 void setEnableProperty(java.lang.String value)
          Indicates the name of a property, with the help of which the column function can be disabled in the relevant line.
 void setFilter(java.lang.String filter)
          The automatic HTML coding of the column contents can be activated or disabled with the filter-attribute.
 void setImagemap(java.lang.String mapName)
          Specifies the name of an Imagemap which must be saved in the request.
 void setImageProperty(java.lang.String property)
          Sets the ImageProperty.
 void setJoin(java.lang.String join)
          Joins the column with the previous column
 void setLinkName(java.lang.String linkName)
          The HTML-Anchor name attribute of the element can be specified with this attribute.
 void setLinkNameProperty(java.lang.String linkNameProperty)
          Specifies the name of a property with the help of which the relevant line can generate an HTML-Anchor name attribute.
 void setMaxlength(java.lang.String maxlength)
          Specifies the maximum number of characters for the data input or display.
 void setPageContext(javax.servlet.jsp.PageContext pc)
           
 void setPermission(java.lang.String permission)
          With this attribute, access to the element can be restricted.
 void setProperty(java.lang.String property)
          The name of the property that contains the data of the column.
 void setRunat(java.lang.String runat)
          This attribute specifies whether, for the control element, Clientside JavaScript should be used, or whether the control element should work purely with Server Roundtrips.
 void setSortable(java.lang.String value)
          The attribute indicates whether sorting can be carried out according to this column.
 void setStyle(java.lang.String style)
          An HTML-style can be directly specified with this attribute.
 void setStyleClass(java.lang.String styleClass)
          The HTML-class attribute of the element can be specified with this attribute.
 void setStyleId(java.lang.String id)
          The HTML-id attribute of the element can be specified with this attribute.
 void setTarget(java.lang.String target)
          The HTML-target attribute of the element can be specified with this attribute.
 void setTargetProperty(java.lang.String targetProperty)
          Specifies the name of a property with the help of which the relevant line can generate an HTML-target attribute.
 void setTitle(java.lang.String title)
          Specifies the column title
 void setTooltip(java.lang.String tooltip)
          Specifies a static tooltip text.
 void setTooltipProperty(java.lang.String tooltipProperty)
          Specifies the name of a property with the help of which the relevant line can generate an HTML-text attribute for the tooltip.
 void setTransaction(java.lang.String transaction)
          Directs the framework to include a transaction token (if any) in all generated hyperlinks for this column.
 void setType(java.lang.String type)
          Specifies the rowbean java type
 void setWidth(java.lang.String newWidth)
          Sets the width of the column (pixel or %)
 
Methods inherited from class com.cc.framework.taglib.ScriptBodyTagSupport
setOnabort, setOnactivate, setOnafterprint, setOnafterupdate, setOnbeforeactivate, setOnbeforecopy, setOnbeforecut, setOnbeforedeactivate, setOnbeforeeditfocus, setOnbeforepaste, setOnbeforeprint, setOnbeforeunload, setOnbeforeupdate, setOnblur, setOnbounce, setOncellchange, setOnchange, setOncheck, setOncheckall, setOnclick, setOncollapse, setOncontextmenu, setOncontrolselect, setOncopy, setOncut, setOndataavailable, setOndatasetchanged, setOndatasetcomplete, setOndblclick, setOndeactivate, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOnerror, setOnerrorupdate, setOnexpand, setOnexpandex, setOnfilterchange, setOnfinish, setOnfocus, setOnfocusin, setOnfocusout, setOnhelp, setOnkeydown, setOnkeypress, setOnkeyup, setOnlayoutcomplete, setOnload, setOnlosecapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmove, setOnmoveend, setOnmovestart, setOnpaste, setOnpropertychange, setOnreadystatechange, setOnreset, setOnresize, setOnresizeend, setOnresizestart, setOnrowenter, setOnrowexit, setOnrowsdelete, setOnrowsinserted, setOnscroll, setOnselect, setOnselectionchange, setOnselectstart, setOnspindown, setOnspinup, setOnstart, setOnstop, setOnsubmit, setOnuncheck, setOnuncheckall, setOnunload
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setParent
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serial Version UID

See Also:
Constant Field Values

designModel

private ColumnDesignModel designModel
The DesignModel of the column


container

private ColumnContainerTag container
The Parent Container Tag

Constructor Detail

ColumnBaseTag

public ColumnBaseTag()
Constructor

Method Detail

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
See Also:
Tag.release()

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pc)
Specified by:
setPageContext in interface javax.servlet.jsp.tagext.Tag
See Also:
Tag.setPageContext(PageContext pc)

getDesignModel

protected ColumnDesignModel getDesignModel()
Returns the DesignModel for the column

Returns:
ColumnDesignModel

doCreateDesignModel

protected abstract ColumnDesignModel doCreateDesignModel()
This method is called to create the DesignModel for the column

Returns:
A concrete DesignModel

releaseDesignModel

protected void releaseDesignModel()
This method gets called when the design model is not longer needed


getClientHandler

public ClientHandler getClientHandler()
Description copied from interface: ScriptSupport
Returns the ClientHandler interface of the controls design model.

Specified by:
getClientHandler in interface ScriptSupport
Returns:
ClientHandler
See Also:
ScriptSupport.getClientHandler()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Throws:
javax.servlet.jsp.JspException
See Also:
Tag.doStartTag()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Throws:
javax.servlet.jsp.JspException
See Also:
Tag.doEndTag()

getContainer

public ColumnContainerTag getContainer()
Returns te container in which this column is nested

Returns:
Container

setType

public void setType(java.lang.String type)
Specifies the rowbean java type

Parameters:
type - The row bean type

setTitle

public void setTitle(java.lang.String title)
Specifies the column title

Parameters:
title - The column title

setProperty

public void setProperty(java.lang.String property)
                 throws javax.servlet.jsp.JspException
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

Parameters:
property - Name of the property that contains the data of the column
Throws:
javax.servlet.jsp.JspException

setWidth

public void setWidth(java.lang.String newWidth)
Sets the width of the column (pixel or %)

Parameters:
newWidth - The Width

setAlign

public void setAlign(java.lang.String alignment)
Specifies the alignment of the column:

Parameters:
alignment - The alignment of the column

setSortable

public void setSortable(java.lang.String value)
                 throws javax.servlet.jsp.JspException
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.

Parameters:
value - true if the column can be sorted
Throws:
javax.servlet.jsp.JspException - If the argument can't be parsed

setFilter

public void setFilter(java.lang.String filter)
The automatic HTML coding of the column contents can be activated or disabled with the filter-attribute. The default is true

Parameters:
filter - true if the column content should be HTML encoded.

setEditable

public void setEditable(java.lang.String editable)
Sets the columns edit mode

Parameters:
editable - true if the column is editable

setEditableProperty

public void setEditableProperty(java.lang.String property)
Sets the property which should be used to make the column editable or not

Parameters:
property - the name of the property

setDisabled

public void setDisabled(java.lang.String disabled)
Sets the columns disable mode

Parameters:
disabled - true if the column is disabled

setDisableProperty

public void setDisableProperty(java.lang.String property)
Sets the property which should be used to disable the column

Parameters:
property - the name of the property

setEnableProperty

public void setEnableProperty(java.lang.String value)
Indicates the name of a property, with the help of which the column function can be disabled in the relevant line. For this, the Row-Bean must provide a corresponding Property Getter, which returns a Boolean data type.

Parameters:
value - enable

setMaxlength

public void setMaxlength(java.lang.String maxlength)
Specifies the maximum number of characters for the data input or display.

Parameters:
maxlength - The maximum number of characters

setStyleId

public void setStyleId(java.lang.String id)
The HTML-id attribute of the element can be specified with this attribute. Note: See HTML documentation for the attribute id.

Parameters:
id - The HTML-id attribute

setPermission

public void setPermission(java.lang.String permission)
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. 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.

Parameters:
permission - String witch stands for the required authorization
See Also:
SecurityUtil

setRunat

public void setRunat(java.lang.String runat)
              throws javax.servlet.jsp.JspException
This attribute specifies whether, for the control element, Clientside JavaScript should be used, or whether the control element should work purely with Server Roundtrips.

Parameters:
runat - "client" or "server"
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to an object of type RunAt

setStyle

public void setStyle(java.lang.String style)
An HTML-style can be directly specified with this attribute. Note: See HTML documentation for the attribute style.

Parameters:
style - An HTML-style

setStyleClass

public void setStyleClass(java.lang.String styleClass)
The HTML-class attribute of the element can be specified with this attribute. Note: See HTML documentation for the attribute class.

Parameters:
styleClass - The HTML-class attribute

setTarget

public void setTarget(java.lang.String target)
The HTML-target attribute of the element can be specified with this attribute. Note: See HTML documentation for the attribute target.

Parameters:
target - The HTML-target attribute

setTargetProperty

public void setTargetProperty(java.lang.String targetProperty)
Specifies the name of a property with the help of which the relevant line can generate an HTML-target attribute. Note: The Row-Bean must implement a suitable property-getter method.

Parameters:
targetProperty - Name of a property

setTooltip

public void setTooltip(java.lang.String tooltip)
Specifies a static tooltip text.

Parameters:
tooltip - Tooltip Text

setTooltipProperty

public void setTooltipProperty(java.lang.String tooltipProperty)
Specifies the name of a property with the help of which the relevant line can generate an HTML-text attribute for the tooltip. Note: The Row-Bean must implement a suitable property-getter method.

Parameters:
tooltipProperty - TooltipProperty

setImageProperty

public void setImageProperty(java.lang.String property)
Sets the ImageProperty. The ImageProperty identifies the Prperty which should be evaluated to referenz an Image in an ImageMap

Parameters:
property - Property

setImagemap

public void setImagemap(java.lang.String mapName)
                 throws javax.servlet.jsp.JspException
Specifies the name of an Imagemap which must be saved in the request. The values that the property-attribute 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. Note: Under the name, there must be an Imagemap saved in the request.

Parameters:
mapName - Name of the Imagemap
Throws:
javax.servlet.jsp.JspException - If the Image Map could not be found

setTransaction

public void setTransaction(java.lang.String transaction)
                    throws javax.servlet.jsp.JspException
Directs the framework to include a transaction token (if any) in all generated hyperlinks for this column. The Transaction token is used to track form re-submissions.

Parameters:
transaction - include transaction token
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

setAnchor

public void setAnchor(java.lang.String anchor)
The HTML-Anchor attribute of the element can be specified with this attribute.

Parameters:
anchor - The HTML-Anchor attribute

setAnchorProperty

public void setAnchorProperty(java.lang.String anchorProperty)
Specifies the name of a property with the help of which the relevant line can generate an HTML-Anchor attribute. Note: The Row-Bean must implement a suitable property-getter method.

Parameters:
anchorProperty - Name of a property

setLinkName

public void setLinkName(java.lang.String linkName)
The HTML-Anchor name attribute of the element can be specified with this attribute.

Parameters:
linkName - The HTML-Anchor name attribute

setLinkNameProperty

public void setLinkNameProperty(java.lang.String linkNameProperty)
Specifies the name of a property with the help of which the relevant line can generate an HTML-Anchor name attribute. Note: The Row-Bean must implement a suitable property-getter method.

Parameters:
linkNameProperty - Name of a property

setConverter

public void setConverter(java.lang.String converter)
                  throws javax.servlet.jsp.JspException
Sets the Converter that should be used to convert Java Objects into their localized String representation. If no converter is specified the framework will use a default Converter that matches the row beans column property.

The Converter is set for all rows of the columns. It is not possible to set individual converters for each row in a column!

Parameters:
converter - Converters class Name
Throws:
javax.servlet.jsp.JspException - If the Converter is invalid

assignConverter

public void assignConverter(Converter converter)
Description copied from interface: ConversionSupportTag
Assigns a converter to the Tag

Specified by:
assignConverter in interface ConversionSupportTag
Parameters:
converter - Converter Instance
See Also:
ConversionSupportTag.assignConverter(com.cc.framework.convert.Converter)

addDesignRule

public void addDesignRule(DesignRule rule)
Description copied from interface: DesignRuleContainerTag
Adds a new design rule to the container

Specified by:
addDesignRule in interface DesignRuleContainerTag
Parameters:
rule - Design rule
See Also:
DesignRuleContainerTag.addDesignRule(com.cc.framework.ui.model.DesignRule)

setJoin

public void setJoin(java.lang.String join)
Joins the column with the previous column

Parameters:
join - the columns join mode

setAjax

public void setAjax(java.lang.String ajax)
             throws javax.servlet.jsp.JspException
Description copied from interface: AjaxSupportTag
Directs the framework to add additional AJAX handlers to the column.

Specified by:
setAjax in interface AjaxSupportTag
Parameters:
ajax - enable AJAX
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean
See Also:
AjaxSupportTag.setAjax(java.lang.String)

setAjax

public void setAjax(boolean ajax)
Directs the framework to add additional AJAX handlers to the control.

Specified by:
setAjax in interface AjaxSupportTag
Parameters:
ajax - enable AJAX


Copyright © 2000-2005 SCC Informationssysteme GmbH. All Rights Reserved.