org.springframework.web.servlet.tags.form
Class CheckboxesTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.springframework.web.servlet.tags.RequestContextAwareTag
          org.springframework.web.servlet.tags.HtmlEscapingAwareTag
              org.springframework.web.servlet.tags.form.AbstractFormTag
                  org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
                      org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
                          org.springframework.web.servlet.tags.form.AbstractHtmlInputElementTag
                              org.springframework.web.servlet.tags.form.AbstractCheckboxTag
                                  org.springframework.web.servlet.tags.form.CheckboxesTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag, TryCatchFinally, EditorAwareTag

public class CheckboxesTag
extends AbstractCheckboxTag

Databinding-aware JSP tag for rendering multiple HTML 'input' elements with a 'type' of 'checkbox'.

Intended to be used with a Collection as the getItems() bound value}.

Since:

2.5

Author:

Thomas Risberg, Mark Fisher

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlInputElementTag

ACCESSKEY_ATTRIBUTE, DISABLED_ATTRIBUTE, ONBLUR_ATTRIBUTE, ONCHANGE_ATTRIBUTE, ONFOCUS_ATTRIBUTE, READONLY_ATTRIBUTE

Fields inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

CLASS_ATTRIBUTE, DIR_ATTRIBUTE, LANG_ATTRIBUTE, ONCLICK_ATTRIBUTE, ONDBLCLICK_ATTRIBUTE, ONKEYDOWN_ATTRIBUTE, ONKEYPRESS_ATTRIBUTE, ONKEYUP_ATTRIBUTE, ONMOUSEDOWN_ATTRIBUTE, ONMOUSEMOVE_ATTRIBUTE, ONMOUSEOUT_ATTRIBUTE, ONMOUSEOVER_ATTRIBUTE, ONMOUSEUP_ATTRIBUTE, STYLE_ATTRIBUTE, TABINDEX_ATTRIBUTE, TITLE_ATTRIBUTE

Fields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

NESTED_PATH_VARIABLE_NAME

Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE

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

pageContext

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

CheckboxesTag()

Method Summary

String	getDelimiter() Return the delimiter to be used between each 'input type="checkbox"' tag.
String	getElement() Get the HTML element used to enclose 'input type="checkbox"' tag.
protected String	getItemLabel() Get the value to be displayed as part of the 'input type="checkbox"' tag.
protected Object	getItems() Get the Collection, Map or array of objects used to generate the 'input type="checkbox"' tags.
protected String	getItemValue() Get the name of the property mapped to the 'value' attribute of the 'input type="checkbox"' tag.
void	setDelimiter(String delimiter) Set the delimiter to be used between each 'input type="checkbox"' tag.
void	setElement(String element) Set the HTML element used to enclose the 'input type="checkbox"' tag.
void	setItemLabel(String itemLabel) Set the value to be displayed as part of the 'input type="checkbox"' tag.
void	setItems(Object items) Set the Collection, Map or array of objects used to generate the 'input type="checkbox"' tags.
void	setItemValue(String itemValue) Set the name of the property mapped to the 'value' attribute of the 'input type="checkbox"' tag.
protected int	writeTagContent(TagWriter tagWriter) Writes the 'input(checkbox)' to the supplied TagWriter, marking it as 'checked' if appropriate.

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractCheckboxTag

autogenerateId, renderFromBoolean, renderFromCollection, renderSingleValue

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlInputElementTag

getAccesskey, getDisabled, getOnblur, getOnchange, getOnfocus, getReadonly, isDisabled, isReadonly, setAccesskey, setDisabled, setOnblur, setOnchange, setOnfocus, setReadonly, writeOptionalAttributes

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

getCssClass, getCssErrorClass, getCssStyle, getDir, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, resolveCssClass, setCssClass, setCssErrorClass, setCssStyle, setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

doFinally, getBindStatus, getBoundValue, getEditor, getId, getName, getNestedPath, getPath, getPropertyEditor, getPropertyPath, setId, setPath

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag

createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute

Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag

isHtmlEscape, setHtmlEscape

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

doCatch, doStartTag, getRequestContext

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckboxesTag

public CheckboxesTag()

Method Detail

setItems

public void setItems(Object items)

Set the Collection, Map or array of objects used to generate the 'input type="checkbox"' tags.

Typically a runtime expression.

Parameters:

items - said items

Throws:

IllegalArgumentException - if the supplied items instance is null

getItems

protected Object getItems()

Get the Collection, Map or array of objects used to generate the 'input type="checkbox"' tags.

Typically a runtime expression.

setItemValue

public void setItemValue(String itemValue)

Set the name of the property mapped to the 'value' attribute of the 'input type="checkbox"' tag.

May be a runtime expression.

getItemValue

protected String getItemValue()

Get the name of the property mapped to the 'value' attribute of the 'input type="checkbox"' tag.

setItemLabel

public void setItemLabel(String itemLabel)

Set the value to be displayed as part of the 'input type="checkbox"' tag.

May be a runtime expression.

getItemLabel

protected String getItemLabel()

Get the value to be displayed as part of the 'input type="checkbox"' tag.

setDelimiter

public void setDelimiter(String delimiter)

Set the delimiter to be used between each 'input type="checkbox"' tag.

By default, there is no delimiter.

getDelimiter

public String getDelimiter()

Return the delimiter to be used between each 'input type="checkbox"' tag.

setElement

public void setElement(String element)

Set the HTML element used to enclose the 'input type="checkbox"' tag.

Defaults to an HTML '<span/>' tag.

getElement

public String getElement()

Get the HTML element used to enclose 'input type="checkbox"' tag.

writeTagContent

protected int writeTagContent(TagWriter tagWriter)
                       throws JspException

Description copied from class: AbstractCheckboxTag

Writes the 'input(checkbox)' to the supplied TagWriter, marking it as 'checked' if appropriate.

Specified by:

writeTagContent in class AbstractCheckboxTag

Returns:

valid tag render instruction as per Tag.doStartTag().

Throws:

JspException