multibox (Struts EL Tag library documentation)

Overview | Library | Tag | Help

| FRAMES NO FRAMES

## 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:

- 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.

Tag Information
Tag Class | org.apache.strutsel.taglib.html.ELMultiboxTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
accesskey | false | true | `java.lang.String` | The keyboard character used to move focus immediately to this element.
alt | false | true | `java.lang.String` | The alternate text for this element.
altKey | false | true | `java.lang.String` | The message resources key of the alternate text for this element.

bundle

false

true

`java.lang.String`

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

disabled | false | true | `java.lang.String` | Set to `true`

errorKey

false

true

`java.lang.String`

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

errorStyle

false

true

`java.lang.String`

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

errorStyleClass

false

true

`java.lang.String`

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

errorStyleId

false

true

`java.lang.String`

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

name | false | true | `java.lang.String` | 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.
onblur | false | true | `java.lang.String` | JavaScript event handler executed when this element loses input focus.
onchange | false | true | `java.lang.String` | JavaScript event handler executed when this element loses input focus and its value has changed.
onclick | false | true | `java.lang.String` | JavaScript event handler executed when this element receives a mouse click.
ondblclick | false | true | `java.lang.String` | JavaScript event handler executed when this element receives a mouse double click.
onfocus | false | true | `java.lang.String` | JavaScript event handler executed when this element receives input focus.
onkeydown | false | true | `java.lang.String` | JavaScript event handler executed when this element has focus and a key is depressed.
onkeypress | false | true | `java.lang.String` | JavaScript event handler executed when this element has focus and a key is depressed and released.
onkeyup | false | true | `java.lang.String` | JavaScript event handler executed when this element has focus and a key is released.
onmousedown | false | true | `java.lang.String` | JavaScript event handler executed when this element is under the mouse pointer and a mouse button is depressed.
onmousemove | false | true | `java.lang.String` | JavaScript event handler executed when this element is under the mouse pointer and the pointer is moved.
onmouseout | false | true | `java.lang.String` | JavaScript event handler executed when this element was under the mouse pointer but the pointer was moved outside the element.
onmouseover | false | true | `java.lang.String` | JavaScript event handler executed when this element was not under the mouse pointer but the pointer is moved inside the element.
onmouseup | false | true | `java.lang.String` | JavaScript event handler executed when this element is under the mouse pointer and a mouse button is released.
property | true | true | `java.lang.String` | Name of the request parameter that will be included with this submission, set to the specified value.
style | false | true | `java.lang.String` | 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.
styleClass | false | true | `java.lang.String` | 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.
styleId | false | true | `java.lang.String` | 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.
tabindex | false | true | `java.lang.String` | The tab order (ascending positive integers) for this element.
title | false | true | `java.lang.String` | The advisory title for this element.
titleKey | false | true | `java.lang.String` | The message resources key for the advisory title for this element.
value | false | true | `java.lang.String` | The value to be transmitted if this checkbox is checked when the form is submitted.

Variables
No Variables Defined.

Overview | Library | Tag | Help

| FRAMES NO FRAMES

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.