org.apache.struts.taglib.html
Class RadioTag

java.lang.Object
  extended byBodyTagSupport
      extended byorg.apache.struts.taglib.html.BaseHandlerTag
          extended byorg.apache.struts.taglib.html.RadioTag
Direct Known Subclasses:
NestedRadioTag

public class RadioTag
extends BaseHandlerTag

Tag for input fields of type "radio".

Version:
$Revision: 1.23 $ $Date: 2003/05/18 18:57:13 $
Author:
Craig R. McClanahan, Ted Husted, David Graham
See Also:
Serialized Form

Field Summary
protected  java.lang.String idName
          Name of the bean (in some scope) that will return the value of the radio tag.
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
RadioTag()
           
 
Method Summary
private  java.lang.String currentValue()
          Acquire the current value of the bean specified by the name attribute and the property specified by the property attribute.
 int doAfterBody()
          Save the associated label from the body content.
 int doEndTag()
          Optionally render the associated label from the body content.
 int doStartTag()
          Generate the required input tag.
 java.lang.String getIdName()
          Return the idName.
 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.
protected  java.lang.String renderRadioElement(java.lang.String serverValue, java.lang.String checkedValue)
          Renders an HTML <input type="radio"> element.
private  java.lang.String serverValue()
          Return the String to be used in the radio tag's value attribute that gets sent to the server on form submission.
 void setIdName(java.lang.String idName)
          Set the idName.
 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.


idName

protected java.lang.String idName
Name of the bean (in some scope) that will return the value of the radio tag.

If an iterator is used to render a series of radio tags, this field may be used to specify the name of the bean exposed by the iterator. In this case, the value attribute is used as the name of a property on the idName bean that returns the value of the radio tag in this iteration.

Constructor Detail

RadioTag

public RadioTag()
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

getIdName

public java.lang.String getIdName()
Return the idName.

Since:
Struts 1.1

setIdName

public void setIdName(java.lang.String idName)
Set the idName.

Parameters:
idName - The new idName
Since:
Struts 1.1

doStartTag

public int doStartTag()
               throws JspException
Generate the required input tag. [Indexed property since Struts 1.1]

Throws:
JspException - if a JSP exception has occurred

serverValue

private java.lang.String serverValue()
                              throws JspException
Return the String to be used in the radio tag's value attribute that gets sent to the server on form submission.

Throws:
JspException

currentValue

private java.lang.String currentValue()
                               throws JspException
Acquire the current value of the bean specified by the name attribute and the property specified by the property attribute. This radio button with this value will be checked.

Throws:
JspException

renderRadioElement

protected java.lang.String renderRadioElement(java.lang.String serverValue,
                                              java.lang.String checkedValue)
                                       throws JspException
Renders an HTML <input type="radio"> element.

Parameters:
serverValue - The data to be used in the tag's value attribute and sent to the server when the form is submitted.
checkedValue - If the serverValue equals this value the radio button will be checked.
Returns:
A radio input element.
Throws:
JspException
Since:
Struts 1.1

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
Optionally render the associated label from the body content.

Throws:
JspException - if a JSP exception has occurred

release

public void release()
Release any acquired resources.

Overrides:
release in class BaseHandlerTag


Copyright ? 2000-2004 - Apache Software Foundation