org.hdiv.taglib.html
Class MultiboxTagHDIV

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.apache.struts.taglib.html.BaseHandlerTag
              org.apache.struts.taglib.html.MultiboxTag
                  org.hdiv.taglib.html.MultiboxTagHDIV

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ELMultiboxTagHDIV, NestedMultiboxTagHDIV

public class MultiboxTagHDIV
extends org.apache.struts.taglib.html.MultiboxTag

Renders an HTML <input> element of type checkbox, whose "checked" status is initialized based on whether the specified value matches one of the elements of the underlying property's array of current values. This element is useful when you have large numbers of checkboxes, and prefer to combine the values into a single array-valued property instead of multiple boolean properties. This tag is only valid when nested inside a form tag body.

WARNING: In order to correctly recognize cases where none of the associated checkboxes are selected, the ActionForm bean associated with this form must include a statement setting the corresponding array to zero length in the reset() method.

The value to be returned to the server, if this checkbox is selected, must be defined by one of the following methods:

• Specify a value attribute, whose contents will be used literally as the value to be returned.
• Specify no value attribute, and the nested body content of this tag will be used as the value to be returned.

Author:

Aritz Rabadan, Gorka Vicente

See Also:

MultiboxTag, Serialized Form

Field Summary

Fields inherited from class org.apache.struts.taglib.html.MultiboxTag

constant, messages, name, property, value

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag

accesskey, defaultLocale, indexed, tabindex

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

MultiboxTagHDIV()

Method Summary

int	doEndTag() Render an input element for this tag.
protected void	prepareAttribute(java.lang.StringBuffer handlers, java.lang.String name, java.lang.Object value) Prepares an attribute if the value is not null, appending it to the the given StringBuffer.
protected void	prepareChecked(java.lang.StringBuffer results, java.lang.String value) Render the checked element
protected java.lang.String	prepareName() Prepare the name element
protected java.lang.String	prepareValue(java.lang.StringBuffer results) Render the value element

Methods inherited from class org.apache.struts.taglib.html.MultiboxTag

doAfterBody, doStartTag, getName, getProperty, getValue, release, setName, setProperty, setValue

Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag

getAccesskey, getAlt, getAltKey, getBundle, getDisabled, getElementClose, getIndexed, getLocale, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getReadonly, getStyle, getStyleClass, getStyleId, getTabindex, getTitle, getTitleKey, isXhtml, lookupProperty, message, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareKeyEvents, prepareMouseEvents, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDisabled, setIndexed, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey

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, setPageContext, 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, setPageContext, setParent

Constructor Detail

MultiboxTagHDIV

public MultiboxTagHDIV()

Method Detail

doEndTag

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

Render an input element for this tag.

Specified by:

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

Overrides:

doEndTag in class org.apache.struts.taglib.html.MultiboxTag

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

prepareName

protected java.lang.String prepareName()
                                throws javax.servlet.jsp.JspException

Prepare the name element

Returns:

The element name.

Throws:

javax.servlet.jsp.JspException

prepareValue

protected java.lang.String prepareValue(java.lang.StringBuffer results)
                                 throws javax.servlet.jsp.JspException

Render the value element

Parameters:

results - The StringBuffer that output will be appended to.

Throws:

javax.servlet.jsp.JspException

See Also:

org.hdiv.composer.IDataComposer#compose(String, String, boolean)

prepareChecked

protected void prepareChecked(java.lang.StringBuffer results,
                              java.lang.String value)
                       throws javax.servlet.jsp.JspException

Render the checked element

Parameters:

results - The StringBuffer that output will be appended to.

Throws:

javax.servlet.jsp.JspException

prepareAttribute

protected void prepareAttribute(java.lang.StringBuffer handlers,
                                java.lang.String name,
                                java.lang.Object value)

Prepares an attribute if the value is not null, appending it to the the given StringBuffer.

Parameters:

handlers - The StringBuffer that output will be appended to.