html
Tag multibox


Render A Checkbox Input Field

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:

Also note that a map backed attribute cannot be used to hold a the String[] for a group of multibox tags.



Tag Information
Tag Classorg.apache.struts.taglib.html.MultiboxTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
accesskey
The keyboard character used to move focus immediately to this element.
 
Required: false
Request-time: false
Type: java.lang.String
alt

The alternate text for this element.

 
Required: false
Request-time: false
Type: java.lang.String
altKey

The message resources key of the alternate text for this element.

 
Required: false
Request-time: false
Type: java.lang.String
bundle
The servlet context attributes key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet.
Since:
Struts 1.2.5
 
Required: false
Request-time: false
Type: java.lang.String
disabled
Set to true if this input field should be disabled.
 
Required: false
Request-time: false
Type: java.lang.String
errorKey

Name of the bean (in any scope) under which our error messages have been stored. If not present, the name specified by the Globals.ERROR_KEY constant string will be used.

N.B. This is used in conjunction with the errorStyle, errorStyleClass and errorStyleId attributes and should be set to the same value as the name attribute on the <html:errors/> tag.

Since:
Struts 1.2.5
 
Required: false
Request-time: false
Type: java.lang.String
errorStyle

CSS styles to be applied to this HTML element if an error exists for it.

N.B. If present, this overrides the style attribute in the event of an error.

Since:
Struts 1.2.5
 
Required: false
Request-time: false
Type: java.lang.String
errorStyleClass

CSS stylesheet class to be applied to this HTML element if an error exists for it (renders a "class" attribute).

N.B. If present, this overrides the styleClass attribute in the event of an error.

Since:
Struts 1.2.5
 
Required: false
Request-time: false
Type: java.lang.String
errorStyleId

Identifier to be assigned to this HTML element if an error exists for it (renders an "id" attribute).

N.B. If present, this overrides the styleId attribute in the event of an error.

Since:
Struts 1.2.5
 
Required: false
Request-time: false
Type: java.lang.String
name
The attribute name of the bean whose properties are consulted when rendering the current value of this input field. If not specified, the bean associated with the form tag we are nested within is utilized.
 
Required: false
Request-time: false
Type: java.lang.String
onblur
JavaScript event handler executed when this element loses input focus.
 
Required: false
Request-time: false
Type: java.lang.String
onchange
JavaScript event handler executed when this element loses input focus and its value has changed.
 
Required: false
Request-time: false
Type: java.lang.String
onclick
JavaScript event handler executed when this element receives a mouse click.
 
Required: false
Request-time: false
Type: java.lang.String
ondblclick
JavaScript event handler executed when this element receives a mouse double click.
 
Required: false
Request-time: false
Type: java.lang.String
onfocus
JavaScript event handler executed when this element receives input focus.
 
Required: false
Request-time: false
Type: java.lang.String
onkeydown
JavaScript event handler executed when this element has focus and a key is depressed.
 
Required: false
Request-time: false
Type: java.lang.String
onkeypress
JavaScript event handler executed when this element has focus and a key is depressed and released.
 
Required: false
Request-time: false
Type: java.lang.String
onkeyup
JavaScript event handler executed when this element has focus and a key is released.
 
Required: false
Request-time: false
Type: java.lang.String
onmousedown
JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed.
 
Required: false
Request-time: false
Type: java.lang.String
onmousemove
JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved.
 
Required: false
Request-time: false
Type: java.lang.String
onmouseout
JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element.
 
Required: false
Request-time: false
Type: java.lang.String
onmouseover
JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element.
 
Required: false
Request-time: false
Type: java.lang.String
onmouseup
JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released.
 
Required: false
Request-time: false
Type: java.lang.String
property
Name of the request parameter that will be included with this submission, set to the specified value.
 
Required: true
Request-time: false
Type: java.lang.String
style

CSS styles to be applied to this HTML element.

N.B. If present, the errorStyle overrides this attribute in the event of an error for the element.

 
Required: false
Request-time: false
Type: java.lang.String
styleClass

CSS stylesheet class to be applied to this HTML element (renders a "class" attribute).

N.B. If present, the errorStyleClass overrides this attribute in the event of an error for the element.

 
Required: false
Request-time: false
Type: java.lang.String
styleId

Identifier to be assigned to this HTML element (renders an "id" attribute).

N.B. If present, the errorStyleId overrides this attribute in the event of an error for the element.

 
Required: false
Request-time: false
Type: java.lang.String
tabindex
The tab order (ascending positive integers) for this element.
 
Required: false
Request-time: false
Type: java.lang.String
title

The advisory title for this element.

 
Required: false
Request-time: false
Type: java.lang.String
titleKey

The message resources key for the advisory title for this element.

 
Required: false
Request-time: false
Type: java.lang.String
value
The value to be transmitted if this checkbox is checked when the form is submitted.
 
Required: false
Request-time: false
Type: java.lang.String

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.