org.apache.struts.taglib.html

Class MultiboxTag

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: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

Field Summary
protected Stringconstant
The constant String value to be returned when this checkbox is selected and the form is submitted.
protected static MessageResourcesmessages
The message resources for this package.
protected Stringname
The name of the bean containing our underlying property.
protected Stringproperty
The property name for this field.
protected Stringvalue
The value which will mark this checkbox as "checked" if present in the array returned by our property getter.
Method Summary
intdoAfterBody()
Save the body contents of this tag as the constant that we will be returning.
intdoEndTag()
Render an input element for this tag.
intdoStartTag()
Process the beginning of this tag.
StringgetName()
StringgetProperty()
Return the property name.
StringgetValue()
Return the server value.
protected voidprepareChecked(StringBuffer results, String value)
Render the checked element
protected StringprepareName()
Prepare the name element
protected StringprepareValue(StringBuffer results)
Render the value element
voidrelease()
Release any acquired resources.
voidsetName(String name)
voidsetProperty(String property)
Set the property name.
voidsetValue(String value)
Set the server value.

Field Detail

constant

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

Method Detail

doAfterBody

public int doAfterBody()
Save the body contents of this tag as the constant that we will be returning.

Throws: JspException if a JSP exception has occurred

doEndTag

public int doEndTag()
Render an input element for this tag.

Throws: JspException if a JSP exception has occurred

doStartTag

public int doStartTag()
Process the beginning of this tag.

Throws: JspException if a JSP exception has occurred

getName

public String getName()

getProperty

public String getProperty()
Return the property name.

getValue

public String getValue()
Return the server value.

prepareChecked

protected void prepareChecked(StringBuffer results, String value)
Render the checked element

Parameters: results The StringBuffer that output will be appended to.

prepareName

protected String prepareName()
Prepare the name element

Returns: The element name.

prepareValue

protected String prepareValue(StringBuffer results)
Render the value element

Parameters: results The StringBuffer that output will be appended to.

release

public void release()
Release any acquired resources.

setName

public void setName(String name)

setProperty

public void setProperty(String property)
Set the property name.

Parameters: property The new property name

setValue

public void setValue(String value)
Set the server value.

Parameters: value The new server value

Copyright B) 2000-2009 - The Apache Software Foundation