com.ideo.sweetdev.presentation.struts.tag.checkboxtable
Class CheckBoxTableTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.ideo.sweetdev.presentation.struts.tag.checkboxtable.CheckBoxTableTag

All Implemented Interfaces:

ICustomTag, ITag, ITemplateTag, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class CheckBoxTableTag

extends javax.servlet.jsp.tagext.TagSupport

implements ICustomTag, ITemplateTag

The class CheckBoxTableTag is a Tag used to draw a table of checkboxes in a JSP.

This tag has the following attributes :

• checkBoxAlign : the allowed values are : LEFT or RIGHT. It is used to align the checkbox in the table. This attribute is optional, default value is LEFT.
• columnCount : the table's number of column. This attribute is optional, default value is 3.
• controlname : used for the habilitation and context services. This attribute is optional.
• displaymode : used for the habilitation and context services. This attribute is optional.
• name : the ActionForm's session key. This ActionForm contains the datas used by the tag.
• scope : the scope used to find the ActionForm. The allowed values are SESSION, REQUEST, APPLICATION. This attribute is optional, default value is SESSION.
• displayProperty : the method name which returns the checkboxes displayed values. The method must returns a List of String. This method must not return null.
• valueProperty : the method name which returns the checkboxes returned values. The method must returns a List of Object. This method must not return null.
• checkedProperty : the method name which returns the selected checkboxes values. The method must returns a List of Object. This method must not return null.
• msgNoValue : the message to show if there is no checkbox in displayProperty.
• drawer : the name of a class implementing ICheckBoxTableDrawer used to draw the html code.
• witdh : the checkbox table width.

See Also:

Serialized Form

Jsp.tag:

name = "checkboxtable" display-name = "CheckBox Table" small-icon = "com/ideo/sweetdev/presentation/struts/tag/resources/checkbox-table.gif" body-content = "JSP" description = ""

Field Summary

static java.lang.String

CHECKBOX_PREFIX prefix used for all checkbox name in the html code

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface com.ideo.sweetdev.presentation.struts.tag.ITag

SKIN_CSS, SKIN_CSS_PATH, SKIN_IMAGE_PATH, SKIN_JS_PATH

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

CheckBoxTableTag()
Constructor

Method Summary

int	doStartTag() This method is called at the beginning of the tag.
java.lang.String	getCheckBoxAlign() retrieves the checkBoxAlign attribute
java.lang.String	getCheckedProperty() retrieves the checkedProperty attribute
java.lang.String	getColumnCount() retrieves the columnCount attribute
javax.servlet.jsp.PageContext	getContext() Deprecated. use getPageContext() instead.
java.lang.String	getControlname() retrieves the controlname attribute
java.lang.String	getDisplaymode() get the display mode
java.lang.String	getDisplayProperty() retrieves the displayProperty attribute
java.lang.String	getDrawer() retrieves the drawer attribute
java.lang.String	getId()
java.lang.String	getMsgNoValue() retrieves the msgNoValue attribute
java.lang.String	getName() retrieves the name attribute
javax.servlet.jsp.PageContext	getPageContext() Method declaration
java.util.Map	getParameters()
java.lang.String	getScope() retrieves the scope attribute
java.lang.String	getStyleId()
java.lang.String	getTooltipProperty() retrieves the tooltipProperty attribute
java.lang.String	getValueProperty() retrieves the valueProperty attribute
java.lang.String	getWidth() retrieves the width attribute
void	release()
void	setCheckBoxAlign(java.lang.String _checkBoxAlign) sets the checkBoxAlign attribute
void	setCheckedProperty(java.lang.String _checkedProperty) sets the checkedProperty attribute
void	setColumnCount(java.lang.String _columnCount) sets the columnCount attribute
void	setControlname(java.lang.String _controlname) sets the controlname attribute
void	setDisplaymode(java.lang.String _displaymode) sets the displaymode attribute
void	setDisplayProperty(java.lang.String _displayProperty) sets the displayProperty attribute
void	setDrawer(java.lang.String _drawer) sets the drawer attribute
void	setId(java.lang.String _id)
void	setMsgNoValue(java.lang.String _msgNoValue) sets the msgNoValue attribute
void	setName(java.lang.String _name) sets the name attribute
void	setParent(javax.servlet.jsp.tagext.Tag tag)
void	setScope(java.lang.String _scope) sets the scope attribute
void	setStyleId(java.lang.String _styleId)
void	setTooltipProperty(java.lang.String _tooltipProperty) sets the tooltipProperty attribute
void	setValueProperty(java.lang.String _valueProperty) sets the valueProperty attribute
void	setWidth(java.lang.String _width) sets the width attribute
protected void	validateAttributes() This method validates optional attributes

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHECKBOX_PREFIX

public static final java.lang.String CHECKBOX_PREFIX

prefix used for all checkbox name in the html code

See Also:

Constant Field Values

Constructor Detail

CheckBoxTableTag

public CheckBoxTableTag()

Constructor

Method Detail

setCheckBoxAlign

public void setCheckBoxAlign(java.lang.String _checkBoxAlign)

sets the checkBoxAlign attribute

Parameters:

_checkBoxAlign - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the alignement of checkboxes LEFT or RIGHT (LEFT by default)"

setColumnCount

public void setColumnCount(java.lang.String _columnCount)

sets the columnCount attribute

Parameters:

_columnCount - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the number of column in the table (3 by default)"

setControlname

public void setControlname(java.lang.String _controlname)

sets the controlname attribute

Specified by:

setControlname in interface ICustomTag

Parameters:

_controlname - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="sets the controlname attribute"

setDisplaymode

public void setDisplaymode(java.lang.String _displaymode)

sets the displaymode attribute

Specified by:

setDisplaymode in interface ICustomTag

Parameters:

_displaymode - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="sets the displaymode attribute"

setName

public void setName(java.lang.String _name)

sets the name attribute

Parameters:

_name - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the attribute name of the bean whose property is accessed to retrieve the value specified by property (if specified)"

setScope

public void setScope(java.lang.String _scope)

sets the scope attribute

Parameters:

_scope - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the variable scope searched to retrieve the bean specified by name"

setDisplayProperty

public void setDisplayProperty(java.lang.String _displayProperty)

sets the displayProperty attribute

Parameters:

_displayProperty - new value

Jsp.attribute:

required="true" rtexprvalue="true" type="java.lang.String" description="Specifies the name of the property to be accessed on the bean specified by name. It returns the checkbox values to render as Object List (not null)"

setValueProperty

public void setValueProperty(java.lang.String _valueProperty)

sets the valueProperty attribute

Parameters:

_valueProperty - new value

Jsp.attribute:

required="true" rtexprvalue="true" type="java.lang.String" description="Specifies the name of the property to be accessed on the bean specified by name. It returns the checkboxe values as Object List. (not null)"

setCheckedProperty

public void setCheckedProperty(java.lang.String _checkedProperty)

sets the checkedProperty attribute

Parameters:

_checkedProperty - new value

Jsp.attribute:

required="true" rtexprvalue="true" type="java.lang.String" description="Specifies the name of the property to be accessed on the bean specified by name. It returns the selected checkbox values as Object List (not null)"

setTooltipProperty

public void setTooltipProperty(java.lang.String _tooltipProperty)

sets the tooltipProperty attribute

Parameters:

_tooltipProperty - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the name of the property to be accessed on the bean specified by name. It returns the checkboxes tooltip values as String List"

setMsgNoValue

public void setMsgNoValue(java.lang.String _msgNoValue)

sets the msgNoValue attribute

Parameters:

_msgNoValue - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the message displayed if there is no data"

setDrawer

public void setDrawer(java.lang.String _drawer)

sets the drawer attribute

Parameters:

_drawer - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the drawer name if it is diffenrent of default drawer (it must implement com.ideo.sweetdev.presentation.struts.tag.checkboxtable.drawer.ICheckBoxTableDrawer)"

setWidth

public void setWidth(java.lang.String _width)

sets the width attribute

Parameters:

_width - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Specifies the table width"

setStyleId

public void setStyleId(java.lang.String _styleId)

Parameters:

_styleId - new value

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Identifier to be assigned to this HTML element (renders an "id" attribute)."

setId

public void setId(java.lang.String _id)

Jsp.attribute:

required="false" rtexprvalue="true" type="java.lang.String" description="Allow severall checkBoxTable on a page (renders an "name" attribute in inputs tag)."

getCheckBoxAlign

public java.lang.String getCheckBoxAlign()

retrieves the checkBoxAlign attribute

Returns:

checkBoxAlign attribute

getColumnCount

public java.lang.String getColumnCount()

retrieves the columnCount attribute

Returns:

columnCount attribute

getControlname

public java.lang.String getControlname()

retrieves the controlname attribute

Specified by:

getControlname in interface ICustomTag

Returns:

controlname attribute

getDisplaymode

public java.lang.String getDisplaymode()

Description copied from interface: ICustomTag

get the display mode

Specified by:

getDisplaymode in interface ICustomTag

Returns:

the display mode

See Also:

ICustomTag.getDisplaymode()

getName

public java.lang.String getName()

retrieves the name attribute

Returns:

name attribute

getScope

public java.lang.String getScope()

retrieves the scope attribute

Returns:

scope attribute

getDisplayProperty

public java.lang.String getDisplayProperty()

retrieves the displayProperty attribute

Returns:

displayProperty attribute

getValueProperty

public java.lang.String getValueProperty()

retrieves the valueProperty attribute

Returns:

valueProperty attribute

getCheckedProperty

public java.lang.String getCheckedProperty()

retrieves the checkedProperty attribute

Returns:

checkedProperty attribute

getTooltipProperty

public java.lang.String getTooltipProperty()

retrieves the tooltipProperty attribute

Returns:

tooltipProperty attribute

getMsgNoValue

public java.lang.String getMsgNoValue()

retrieves the msgNoValue attribute

Returns:

msgNoValue attribute

getDrawer

public java.lang.String getDrawer()

retrieves the drawer attribute

Returns:

drawer attribute

getWidth

public java.lang.String getWidth()

retrieves the width attribute

Returns:

width attribute

getStyleId

public java.lang.String getStyleId()

getId

public java.lang.String getId()

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

Method declaration

Specified by:

getPageContext in interface ITag

Returns:

PageContext

doStartTag

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

This method is called at the beginning of the tag.

Specified by:

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

Throws:

javax.servlet.jsp.JspException

Returns:

int The returned value must be EVAL_BODY_INCLUDE or SKIP_BODY

getContext

public javax.servlet.jsp.PageContext getContext()

Deprecated. use getPageContext() instead.

Returns the page context of the habilitation tag

Returns:

the page context

validateAttributes

protected void validateAttributes()
                           throws TechnicalException

This method validates optional attributes

Throws:

TechnicalException - this exception is thrown if at least one optional attribute's value is invalid

getParameters

public java.util.Map getParameters()

Specified by:

getParameters in interface ITemplateTag

See Also:

ITemplateTag.getParameters()

setParent

public void setParent(javax.servlet.jsp.tagext.Tag tag)

Specified by:

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

release

public void release()

Specified by:

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

See Also:

ImgTag.release()