org.apache.struts.taglib.html

Class MultiboxTag

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

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, alt, altKey, bundle, defaultLocale, disabled, doDisabled, doReadonly, errorKey, errorStyle, errorStyleClass, errorStyleId, indexed, locale, log, loopTagStatusClass, loopTagStatusGetIndex, loopTagSupportClass, loopTagSupportGetStatus, messages, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, readonly, style, styleClass, styleId, tabindex, title, titleKey, triedJstlInit, triedJstlSuccess

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, getDisabled, getElementClose, getErrorKey, getErrorStyle, getErrorStyleClass, getErrorStyleId, getIndexValue, getIndexed, getJstlLoopIndex, 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, prepareKeyEvents, prepareMouseEvents, prepareName, prepareOtherAttributes, prepareStyles, prepareTextEvents, release, setAccesskey, setAlt, setAltKey, setBundle, setDisabled, setErrorKey, setErrorStyle, setErrorStyleClass, setErrorStyleId, setIndexed, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey

Field Details

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 Details

doAfterBody

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

doEndTag

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

doStartTag

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

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)
            throws JspException
Render the checked element
Parameters:
results - The StringBuffer that output will be appended to.

prepareName

protected String prepareName()
            throws JspException
Prepare the name element
Overrides:
prepareName in interface BaseHandlerTag
Returns:
The element name.

prepareValue

protected String prepareValue(StringBuffer results)
            throws JspException
Render the value element
Parameters:
results - The StringBuffer that output will be appended to.

release

public void release()
Release any acquired resources.
Overrides:
release in interface BaseHandlerTag

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-2007 - The Apache Software Foundation