public class InputCheckBoxTag extends InputTagSupport implements javax.servlet.jsp.tagext.BodyTag
Implements an HTML tag that generates form fields of type <input type="checkbox"/>. Since a single checkbox widget on a HTML page can have only a single value, the value tag attribute must always resolve to a scalar value which will be converted to a String using the Stripes Formatting system, or by caling toString() if an appropriate Formatter is not found.
Checkboxes perform automatic (re-)population of state. They prefer, in order, values in the HttpServletRequest, values in the ActionBean and lastly values set using checked="" on the page. The "checked" attribute is a complex attribute and may be a Collection, an Array or a scalar Java Object. In the first two cases a check is performed to see if the value in the value="foo" attribute is one of the elements in the checked collection or array. In the last case, the value is matched directly against the String form of the checked attribute. If in any case a checkbox's value matches then a checked="checked" attribute will be added to the HTML written.
The tag may include a body and if present the body is converted to a String and overrides the checked tag attribute.
errorRenderer, fieldErrors
pageContext, parentTag
Constructor and Description |
---|
InputCheckBoxTag()
Basic constructor that sets the input tag's type attribute to "checkbox".
|
Modifier and Type | Method and Description |
---|---|
int |
doAfterBody()
Ensure that the body is evaluated only once.
|
int |
doEndInputTag()
Does the main work of the tag, including determining the tags state (checked or not) and
writing out a singleton tag representing the checkbox.
|
void |
doInitBody()
Does nothing.
|
int |
doStartInputTag()
Does nothing.
|
java.lang.Object |
getChecked()
Returns the value originally set using setChecked().
|
java.lang.Object |
getValue()
Returns the value that this checkbox will submit if it is checked.
|
java.lang.Object |
getValueOnPage()
Returns the body of the tag if it is present and not empty, otherwise returns
the value of the 'checked' attribute.
|
void |
setChecked(java.lang.Object checked)
Sets the default checked values for checkboxes with this name.
|
void |
setValue(java.lang.Object value)
Sets the value that this checkbox will submit if it is checked.
|
doCatch, doEndTag, doFinally, doStartTag, format, format, getActionBean, getDisabled, getFieldErrors, getFormatPattern, getFormatType, getLocalizedFieldName, getLocalizedFieldName, getName, getOverrideValueOrValues, getParentFormTag, getReadonly, getSingleOverrideValue, getSize, getValidationMetadata, hasErrors, isItemSelected, loadErrors, makeFocused, registerWithParentForm, setDisabled, setFocus, setFormatPattern, setFormatType, setName, setReadonly, setSize
evaluateExpression, get, getAccesskey, getAttributes, getBodyContent, getBodyContentAsString, getCssClass, getDir, getId, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getTabindex, getTitle, release, set, setAccesskey, setBodyContent, setClass, setCssClass, setDir, setDynamicAttribute, setId, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setStyle, setTabindex, setTitle, toString, writeAttributes, writeCloseTag, writeOpenTag, writeSingletonTag
getActionBeanType, getActionBeanUrl, getPageContext, getParent, getParentTag, getTagStack, popPageContextAttributes, pushPageContextAttributes, setPageContext, setParent
public InputCheckBoxTag()
public void setChecked(java.lang.Object checked)
checked
- may be either a Collection or Array of checked values, or a single Checked
value. Values do not have to be Strings, but will need to be convertible to String
using the toString() method.public java.lang.Object getChecked()
public void setValue(java.lang.Object value)
public java.lang.Object getValue()
public int doStartInputTag() throws javax.servlet.jsp.JspException
doStartInputTag
in class InputTagSupport
javax.servlet.jsp.JspException
public void doInitBody() throws javax.servlet.jsp.JspException
doInitBody
in interface javax.servlet.jsp.tagext.BodyTag
javax.servlet.jsp.JspException
public int doAfterBody() throws javax.servlet.jsp.JspException
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
javax.servlet.jsp.JspException
public java.lang.Object getValueOnPage()
getValueOnPage
in class InputTagSupport
public int doEndInputTag() throws javax.servlet.jsp.JspException
doEndInputTag
in class InputTagSupport
javax.servlet.jsp.JspException
- if the checkbox is not contained inside a stripes InputFormTag, or has
problems writing to the output.? Copyright 2005-2006, Stripes Development Team.