RadioTag (Struts Taglib 1.3.10 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.taglib.html
Class RadioTag

    java.lang.Object
      javax.servlet.jsp.tagext.TagSupport
          javax.servlet.jsp.tagext.BodyTagSupport
              org.apache.struts.taglib.html.BaseHandlerTag
                  org.apache.struts.taglib.html.RadioTag

All Implemented Interfaces:
  Serializable, BodyTag, IterationTag, Tag

Direct Known Subclasses:
  NestedRadioTag

    public class RadioTag

extends BaseHandlerTag

Tag for input fields of type "radio".

Version:
  $Rev: 471754 $ $Date: 2005-06-14 14:26:17 -0400 (Tue, 14 Jun 2005) $
See Also:
  Serialized Form

Field Summary
`protected 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 String` | `name` The name of the bean containing our underlying property.
`protected String` | `property` The property name for this field.
`protected String` | `text` The body content of this tag (if any).
`protected String` | `value` The server value for this option.

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag
`accesskey, doDisabled, doReadonly, 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_BUFFERED, EVAL_BODY_TAG`

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
`EVAL_BODY_AGAIN`

Fields inherited from interface javax.servlet.jsp.tagext.Tag
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

Constructor Summary
`RadioTag()`

Method Summary
`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.
`String` | `getIdName()` Return the idName.
`String` | `getName()`
`String` | `getProperty()` Return the property name.
`String` | `getValue()` Return the server value.
`protected String` | `prepareName()` Prepare the name element
`void` | `release()` Release any acquired resources.
`protected String` | `renderRadioElement(String serverValue, String checkedValue)` Renders an HTML <input type="radio"> element.
`void` | `setIdName(String idName)` Set the idName.
`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, getDir, getDisabled, getElementClose, getErrorKey, getErrorStyle, getErrorStyleClass, getErrorStyleId, getIndexed, getIndexValue, getLang, 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, prepareInternationalization, prepareKeyEvents, prepareMouseEvents, prepareOtherAttributes, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDir, setDisabled, setErrorKey, setErrorStyle, setErrorStyleClass, setErrorStyleId, setIndexed, setLang, 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

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

### text

    protected String text

  The body content of this tag (if any).

### value

    protected String value

  The server value for this option.

### idName

    protected 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 String getName()

### setName

    public void setName(String name)

### getProperty

    public String getProperty()

  Return the property name.

### setProperty

    public void setProperty(String property)

  Set the property name.

  Parameters:
    `property` - The new property name

### getValue

    public String getValue()

  Return the server value.

### setValue

    public void setValue(String value)

  Set the server value.

  Parameters:
    `value` - The new server value

### getIdName

    public String getIdName()

  Return the idName.

  Since:
    Struts 1.1

### setIdName

    public void setIdName(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]

  Specified by:
    `doStartTag` in interface `Tag`
  Overrides:
    `doStartTag` in class `BodyTagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### renderRadioElement

    protected String renderRadioElement(String serverValue,
                                        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.

  Specified by:
    `doAfterBody` in interface `IterationTag`
  Overrides:
    `doAfterBody` in class `BodyTagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### doEndTag

    public int doEndTag()
                 throws JspException

  Optionally render the associated label from the body content.

  Specified by:
    `doEndTag` in interface `Tag`
  Overrides:
    `doEndTag` in class `BodyTagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### prepareName

    protected String prepareName()
                          throws JspException

  Prepare the name element

  Overrides:
    `prepareName` in class `BaseHandlerTag`
  Returns:
    The element name.
  Throws:
    `JspException`

### release

    public void release()

  Release any acquired resources.

  Specified by:
    `release` in interface `Tag`
  Overrides:
    `release` in class `BaseHandlerTag`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.