html:checkbox

---

<html:checkbox />

The <html:checkbox /> tag is used to render an HTML <input> element with an input type of checkbox. The<html:checkbox /> tag has a body type of JSP and supports 27 attributes, described in Table 16.4.

Table 16.4: <html:checkbox /> Tag Attributes

Attribute	Description
property	Identifies the name of the input field being processed. (required)
accessKey	Identifies a keyboard character to be used to immediately move focus to the HTML element defined by this tag. (optional)
alt	Defines an alternate text string for this element. (optional)
altKey	Defines a resources key (to be retrieved from a resource bundle) that references an alternate text string for this element. (optional)
disabled	If set to true, causes this HTML input element to be disabled. The default value is false. (optional)
indexed	If set to true, then the name of the HTML tag is rendered as propertyName[indexnumber]. The [] characters surrounding the index are generated for every iteration and taken from its ancestor, the <logic:iterate /> tag. The indexed attribute is valid only when the tag using it is nested with a <logic:iterate /> tag. (optional)
name	Identifies a JavaBean to use when defaulting the value of the input field. (optional)
onblur	Specifies a JavaScript function that is executed when the containing element loses its focus. (optional)
onchange	Specifies a JavaScript function that is executed when this element loses input focus and its value has changed. (optional)
onclick	Specifies a JavaScript function that is executed when this element receives a mouse click. (optional)
ondblclick	Specifies a JavaScript function that is executed when this element receives a mouse double-click. (optional)
onfocus	Specifies a JavaScript function that is executed when this element receives input focus. (optional)
onkeydown	Specifies a JavaScript function that is executed when this element has focus and a key is pressed. (optional)
onkeypress	Specifies a JavaScript function that is executed when this element has focus and a key is pressed and released. (optional)
onkeyup	Specifies a JavaScript function that is executed when this element has focus and a key is released. (optional)
onmousedown	Specifies a JavaScript function that is executed when this element is under the mouse pointer and a mouse button is pressed. (optional)
onmousemove	Specifies a JavaScript function that is executed when this element is under the mouse pointer and the pointer is moved. (optional)
onmouseout	Specifies a JavaScript function that is executed when this element is under the mouse pointer but the pointer is then moved outside the element. (optional)
onmouseover	Specifies a JavaScript function that is executed when this element is not under the mouse pointer but the pointer is then moved inside the element. (optional)
onmouseup	Specifies a JavaScript function that is executed when this element is under the mouse pointer and a mouse button is released. (optional)
style	Specifies a Cascading Style Sheet style to apply to this HTML element. (optional)
styleClass	Specifies a Cascading Style Sheet class to apply to this HTML element. (optional)
styleId	Specifies an HTML identifier to be associated with this HTML element. (optional)
tabindex	Identifies the tab order of this element in relation to the other elements of the containing Form. (optional)
title	Specifies the advisory title for this HTML element. (required)
titleKey	Specifies a resources key (to be retrieved from a resource bundle) that references a title string for this element. (optional)
value	Specifies the label to be placed on the request if this checkbox is selected. The default value is on. (optional)

The <html:checkbox /> tag must be nested inside the body of an <html:form /> tag. Another thing to note about this tag is that, in order to correctly recognize deselected checkboxes, the ActionForm bean associated with the parent form must include a reset() method that sets the property corresponding to this checkbox to false.

The body of this tag can also be used as the element label.

---