com.cc.framework.taglib.controls
Class ColumnHeaderTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.cc.framework.taglib.ScriptBodyTagSupport
              com.cc.framework.taglib.controls.ColumnHeaderTag

All Implemented Interfaces:

AjaxSupportTag, javax.servlet.jsp.tagext.BodyTag, InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class ColumnHeaderTag

extends ScriptBodyTagSupport

implements InnerTag, AjaxSupportTag

Base class for column header tag handler

Since:

1.0

Version:

$Revision: 1.11 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private ColumnHeaderDesignModel	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

ColumnHeaderTag()
Constructor

Method Summary

int	doAfterBody()
protected ColumnHeaderDesignModel	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.
protected ColumnHeaderDesignModel	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	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	setImageref(java.lang.String imageRef) Sets the Reference to an Image in an ImageMap, which should be display in front of the Label
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	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	setTitle(java.lang.String title) Specifies the column title
void	setTooltip(java.lang.String tooltip) Specifies a static tooltip text.
void	setTransaction(java.lang.String transaction) Directs the framework to include a transaction token (if any) in all generated hyperlinks for this column.

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

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 ColumnHeaderDesignModel designModel

The DesignModel of the column

Constructor Detail

ColumnHeaderTag

public ColumnHeaderTag()

Constructor

Method Detail

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)

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

See Also:

Tag.release()

releaseDesignModel

protected void releaseDesignModel()

This method gets called when the design model is not longer needed

doCreateDesignModel

protected ColumnHeaderDesignModel doCreateDesignModel()

This method is called to create the DesignModel for the column

Returns:

A concrete DesignModel

getDesignModel

protected ColumnHeaderDesignModel getDesignModel()

Returns the DesignModel for the column

Returns:

ColumnDesignModel

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()

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Throws:

javax.servlet.jsp.JspException

See Also:

IterationTag.doAfterBody()

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()

setTitle

public void setTitle(java.lang.String title)

Specifies the column title

Parameters:

title - The column title

setAlign

public void setAlign(java.lang.String alignment)
              throws javax.servlet.jsp.JspException

Specifies the alignment of the column:

• left = left alignment.
• right = right alignment.
• center = the column contents are centered.

Parameters:

alignment - The alignment of the column

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted to an AlignmentType

setFilter

public void setFilter(java.lang.String filter)
               throws javax.servlet.jsp.JspException

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.

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

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

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

setTooltip

public void setTooltip(java.lang.String tooltip)

Specifies a static tooltip text.

Parameters:

tooltip - Tooltip Text

setImageref

public void setImageref(java.lang.String imageRef)

Sets the Reference to an Image in an ImageMap, which should be display in front of the Label

Parameters:

imageRef - Reference to an Image in an ImageMap

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

setMaxlength

public void setMaxlength(java.lang.String maxlength)
                  throws javax.servlet.jsp.JspException

Specifies the maximum number of characters for the data input or display.

Parameters:

maxlength - The maximum number of characters

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to int

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

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)

Description copied from interface: AjaxSupportTag

Directs the framework to add additional AJAX handlers to the control.

Specified by:

setAjax in interface AjaxSupportTag

Parameters:

ajax - true to enable AJAX

See Also:

AjaxSupportTag.setAjax(boolean)