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:

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

Direct Known Subclasses:

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:

$Revision: 1.1 $ $Date$

Author:

Ralph Schaer, Craig R. McClanahan

See Also:

Serialized Form

Field Summary

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, defaultLocale, 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_TAG

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.
java.lang.String	getName()
java.lang.String	getProperty() Return the property name.
java.lang.String	getValue() Return the server value.
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

getAccesskey, getAlt, getAltKey, getBundle, getDisabled, getElementClose, getIndexed, 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, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareKeyEvents, prepareMouseEvents, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDisabled, setIndexed, 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

constant

protected java.lang.String constant

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

messages

protected static MessageResources messages

The message resources for this package.

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

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

release

public void release()

Release any acquired resources.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class BaseHandlerTag