MultiboxTag (Struts 1.3.10 API)

java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - javax.servlet.jsp.tagext.BodyTagSupport
  - - org.apache.struts.taglib.html.BaseHandlerTag
    - - org.apache.struts.taglib.html.MultiboxTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ELMultiboxTag, NestedMultiboxTag
```
public class MultiboxTag
extends BaseHandlerTag
```
Tag for input fields of type "checkbox". This differs from CheckboxTag because it assumes that the underlying property is an array getter (of any supported primitive type, or String), and the checkbox is initialized to "checked" if the value listed for the "value" attribute is present in the values returned by the property getter.

Version:

$Rev: 471754 $ $Date: 2004-10-16 12:38:42 -0400 (Sat, 16 Oct 2004) $

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`constant` The constant String value to be returned when this checkbox is selected and the form is submitted.
`protected static MessageResources`	`messages` The message resources for this package.
`protected java.lang.String`	`name` The name of the bean containing our underlying property.
`protected java.lang.String`	`property` The property name for this field.
`protected java.lang.String`	`value` The value which will mark this checkbox as "checked" if present in the array returned by our property getter.

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag
accesskey, doDisabled, doReadonly, indexed, tabindex

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

Constructors
Constructor and Description

MultiboxTag()

Constructors
Constructor and Description
`MultiboxTag()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`doAfterBody()` Save the body contents of this tag as the constant that we will be returning.
`int`	`doEndTag()` Render an input element for this tag.
`int`	`doStartTag()` Process the beginning of this tag.
`java.lang.String`	`getName()`
`java.lang.String`	`getProperty()` Return the property name.
`java.lang.String`	`getValue()` Return the server value.
`protected void`	`prepareChecked(java.lang.StringBuffer results, java.lang.String value)` Render the checked element
`protected java.lang.String`	`prepareName()` Prepare the name element
`protected java.lang.String`	`prepareValue(java.lang.StringBuffer results)` Render the value element
`void`	`release()` Release any acquired resources.
`void`	`setName(java.lang.String name)`
`void`	`setProperty(java.lang.String property)` Set the property name.
`void`	`setValue(java.lang.String value)` Set the server value.

Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag
doErrorsExist, getAccesskey, getAlt, getAltKey, getBundle, getDir, getDisabled, getElementClose, getErrorKey, getErrorStyle, getErrorStyleClass, getErrorStyleId, getIndexed, getIndexValue, getLang, getLocale, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getReadonly, getStyle, getStyleClass, getStyleId, getTabindex, getTitle, getTitleKey, isXhtml, lookupProperty, message, prepareAttribute, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareInternationalization, prepareKeyEvents, prepareMouseEvents, prepareOtherAttributes, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDir, setDisabled, setErrorKey, setErrorStyle, setErrorStyleClass, setErrorStyleId, setIndexed, setLang, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent

- Field Detail
  - messages
```
protected static MessageResources messages
```
    The message resources for this package.
  - constant
```
protected java.lang.String constant
```
    The constant String value to be returned when this checkbox is selected and the form is submitted.
  - name
```
protected java.lang.String name
```
    The name of the bean containing our underlying property.
  - property
```
protected java.lang.String property
```
    The property name for this field.
  - value
```
protected java.lang.String value
```
    The value which will mark this checkbox as "checked" if present in the array returned by our property getter.
- Constructor Detail
  - MultiboxTag
```
public MultiboxTag()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
  - setName
```
public void setName(java.lang.String name)
```
  - getProperty
```
public java.lang.String getProperty()
```
    Return the property name.
  - setProperty
```
public void setProperty(java.lang.String property)
```
    Set the property name.
    
    Parameters:
    
    property - The new property name
  - getValue
```
public java.lang.String getValue()
```
    Return the server value.
  - setValue
```
public void setValue(java.lang.String value)
```
    Set the server value.
    
    Parameters:
    
    value - The new server value
  - doStartTag
```
public int doStartTag()
               throws javax.servlet.jsp.JspException
```
    Process the beginning of this tag.
    
    Specified by:
    
    doStartTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException - if a JSP exception has occurred
  - doAfterBody
```
public int doAfterBody()
                throws javax.servlet.jsp.JspException
```
    Save the body contents of this tag as the constant that we will be returning.
    
    Specified by:
    
    doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
    
    Overrides:
    
    doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException - if a JSP exception has occurred
  - doEndTag
```
public int doEndTag()
             throws javax.servlet.jsp.JspException
```
    Render an input element for this tag.
    
    Specified by:
    
    doEndTag in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
    
    Throws:
    
    javax.servlet.jsp.JspException - if a JSP exception has occurred
  - prepareName
```
protected java.lang.String prepareName()
                                throws javax.servlet.jsp.JspException
```
    Prepare the name element
    
    Overrides:
    
    prepareName in class BaseHandlerTag
    
    Returns:
    
    The element name.
    
    Throws:
    
    javax.servlet.jsp.JspException
  - prepareValue
```
protected java.lang.String prepareValue(java.lang.StringBuffer results)
                                 throws javax.servlet.jsp.JspException
```
    Render the value element
    
    Parameters:
    
    results - The StringBuffer that output will be appended to.
    
    Throws:
    
    javax.servlet.jsp.JspException
  - prepareChecked
```
protected void prepareChecked(java.lang.StringBuffer results,
                              java.lang.String value)
                       throws javax.servlet.jsp.JspException
```
    Render the checked element
    
    Parameters:
    
    results - The StringBuffer that output will be appended to.
    
    Throws:
    
    javax.servlet.jsp.JspException
  - release
```
public void release()
```
    Release any acquired resources.
    
    Specified by:
    
    release in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    release in class BaseHandlerTag

Class MultiboxTag

Field Summary

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag

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

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

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Summary

Method Summary

Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.jsp.tagext.Tag

Field Detail

messages

constant

name

property

value

Constructor Detail

MultiboxTag

Method Detail

getName

setName

getProperty

setProperty

getValue

setValue

doStartTag

doAfterBody

doEndTag

prepareName

prepareValue

prepareChecked

release