org.apache.struts.taglib.html
Class MultiboxTag

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:

Serializable, BodyTag, IterationTag, 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

protected 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 String	name The name of the bean containing our underlying property.
protected String	property The property name for this field.
protected 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

MultiboxTag()

Method Summary

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.
String	getName()
String	getProperty() Return the property name.
String	getValue() Return the server value.
protected void	prepareChecked(StringBuffer results, String value) Render the checked element
protected String	prepareName() Prepare the name element
protected String	prepareValue(StringBuffer results) Render the value element
void	release() Release any acquired resources.
void	setName(String name)
void	setProperty(String property) Set the property name.
void	setValue(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 String constant

The constant String value to be returned when this checkbox is selected and the form is submitted.

name

protected String name

The name of the bean containing our underlying property.

property

protected String property

The property name for this field.

value

protected 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 String getName()

setName

public void setName(String name)

getProperty

public String getProperty()

Return the property name.

setProperty

public void setProperty(String property)

Set the property name.

Parameters:

property - The new property name

getValue

public String getValue()

Return the server value.

setValue

public void setValue(String value)

Set the server value.

Parameters:

value - The new server value

doStartTag

public int doStartTag()
               throws JspException

Process the beginning of this tag.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Throws:

JspException - if a JSP exception has occurred

doAfterBody

public int doAfterBody()
                throws JspException

Save the body contents of this tag as the constant that we will be returning.

Specified by:

doAfterBody in interface IterationTag

Overrides:

doAfterBody in class BodyTagSupport

Throws:

JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws JspException

Render an input element for this tag.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Throws:

JspException - if a JSP exception has occurred

prepareName

protected String prepareName()
                      throws JspException

Prepare the name element

Overrides:

prepareName in class BaseHandlerTag

Returns:

The element name.

Throws:

JspException

prepareValue

protected String prepareValue(StringBuffer results)
                       throws JspException

Render the value element

Parameters:

results - The StringBuffer that output will be appended to.

Throws:

JspException

prepareChecked

protected void prepareChecked(StringBuffer results,
                              String value)
                       throws JspException

Render the checked element

Parameters:

results - The StringBuffer that output will be appended to.

Throws:

JspException

release

public void release()

Release any acquired resources.

Specified by:

release in interface Tag

Overrides:

release in class BaseHandlerTag