org.apache.struts.taglib.html
Class CheckboxTag

java.lang.Object
  BodyTagSupport
      org.apache.struts.taglib.html.BaseHandlerTag
          org.apache.struts.taglib.html.CheckboxTag

Direct Known Subclasses:

NestedCheckboxTag

public class CheckboxTag
extends BaseHandlerTag

Tag for input fields of type "checkbox".

Version:

$Revision: 1.24 $ $Date: 2004/03/14 06:23:46 $

Field Summary

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	text The body content of this tag (if any).
protected java.lang.String	value The server value for this option.

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

accesskey, defaultLocale, indexed, tabindex

Constructor Summary

CheckboxTag()

Method Summary

int	doAfterBody() Save the associated label from the body content.
int	doEndTag() Process the remainder of this page normally.
int	doStartTag() Generate the required input tag.
java.lang.String	getName()
java.lang.String	getProperty() Return the property name.
java.lang.String	getValue() Return the server value.
protected boolean	isChecked() Determines if the checkbox should be checked.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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.

text

protected java.lang.String text

The body content of this tag (if any).

value

protected java.lang.String value

The server value for this option.

Constructor Detail

CheckboxTag

public CheckboxTag()

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 JspException

Generate the required input tag.

Support for indexed property since Struts 1.1

Throws:

JspException - if a JSP exception has occurred

isChecked

protected boolean isChecked()
                     throws JspException

Determines if the checkbox should be checked.

Returns:

true if checked="checked" should be rendered.

Throws:

JspException

Since:

Struts 1.2

doAfterBody

public int doAfterBody()
                throws JspException

Save the associated label from the body content.

Throws:

JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws JspException

Process the remainder of this page normally.

Throws:

JspException - if a JSP exception has occurred

release

public void release()

Release any acquired resources.

Overrides:

release in class BaseHandlerTag