java.lang.Object
- javax.servlet.jsp.tagext.TagSupport
- - org.springframework.web.servlet.tags.RequestContextAwareTag
  - - org.springframework.web.servlet.tags.HtmlEscapingAwareTag
    - - org.springframework.web.servlet.tags.form.AbstractFormTag
      - org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
        org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
        org.springframework.web.servlet.tags.form.OptionsTag

All Implemented Interfaces:: Serializable, DynamicAttributes, IterationTag, JspTag, Tag, TryCatchFinally, EditorAwareTag

public class OptionsTag
extends AbstractHtmlElementTag

The <options> tag renders a list of HTML 'option' tags. Sets 'selected' as appropriate based on bound value.

Must be used within a 'select' tag.

Attribute Summary
Attribute	Required?	Runtime Expression?	Description
cssClass	false	true	HTML Optional Attribute
cssErrorClass	false	true	HTML Optional Attribute. Used when the bound field has errors.
cssStyle	false	true	HTML Optional Attribute
dir	false	true	HTML Standard Attribute
disabled	false	true	HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
htmlEscape	false	true	Enable/disable HTML escaping of rendered values.
id	false	true	HTML Standard Attribute
itemLabel	false	true	Name of the property mapped to the inner text of the 'option' tag
items	true	true	The Collection, Map or array of objects used to generate the inner 'option' tags
itemValue	false	true	Name of the property mapped to 'value' attribute of the 'option' tag
lang	false	true	HTML Standard Attribute
onclick	false	true	HTML Event Attribute
ondblclick	false	true	HTML Event Attribute
onkeydown	false	true	HTML Event Attribute
onkeypress	false	true	HTML Event Attribute
onkeyup	false	true	HTML Event Attribute
onmousedown	false	true	HTML Event Attribute
onmousemove	false	true	HTML Event Attribute
onmouseout	false	true	HTML Event Attribute
onmouseover	false	true	HTML Event Attribute
onmouseup	false	true	HTML Event Attribute
tabindex	false	true	HTML Standard Attribute
title	false	true	HTML Standard Attribute

Since:: 2.0
Author:: Rob Harrop, Juergen Hoeller, Scott Andrews
See Also:: Serialized Form

Field Summary
- Fields inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
  CLASS_ATTRIBUTE, DIR_ATTRIBUTE, LANG_ATTRIBUTE, ONCLICK_ATTRIBUTE, ONDBLCLICK_ATTRIBUTE, ONKEYDOWN_ATTRIBUTE, ONKEYPRESS_ATTRIBUTE, ONKEYUP_ATTRIBUTE, ONMOUSEDOWN_ATTRIBUTE, ONMOUSEMOVE_ATTRIBUTE, ONMOUSEOUT_ATTRIBUTE, ONMOUSEOVER_ATTRIBUTE, ONMOUSEUP_ATTRIBUTE, STYLE_ATTRIBUTE, TABINDEX_ATTRIBUTE, TITLE_ATTRIBUTE
- Fields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
  NESTED_PATH_VARIABLE_NAME
- Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
  logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
- Fields inherited from class javax.servlet.jsp.tagext.TagSupport
  pageContext
- 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
Constructors
Constructor Description
OptionsTag()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected BindStatus`	`getBindStatus()`	Get the `BindStatus` for this tag.
`protected String`	`getItemLabel()`	Get the name of the property mapped to the label (inner text) of the '`option`' tag.
`protected Object`	`getItems()`	Get the `Collection`, `Map` or array of objects used to generate the inner '`option`' tags.
`protected String`	`getItemValue()`	Return the name of the property mapped to the '`value`' attribute of the '`option`' tag.
`protected boolean`	`isDisabled()`	Get the value of the '`disabled`' attribute.
`protected String`	`resolveId()`	Appends a counter to a specified id, since we're dealing with multiple HTML elements.
`void`	`setDisabled(boolean disabled)`	Set the value of the '`disabled`' attribute.
`void`	`setItemLabel(String itemLabel)`	Set the name of the property mapped to the label (inner text) of the '`option`' tag.
`void`	`setItems(Object items)`	Set the `Collection`, `Map` or array of objects used to generate the inner '`option`' tags.
`void`	`setItemValue(String itemValue)`	Set the name of the property mapped to the '`value`' attribute of the '`option`' tag.
`protected int`	`writeTagContent(TagWriter tagWriter)`	Subclasses should implement this method to perform tag content rendering.

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
getCssClass, getCssErrorClass, getCssStyle, getDir, getDynamicAttributes, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, isValidDynamicAttribute, resolveCssClass, setCssClass, setCssErrorClass, setCssStyle, setDir, setDynamicAttribute, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes, writeOptionalAttributes

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
autogenerateId, convertToDisplayString, doFinally, getBoundValue, getEditor, getId, getName, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, setId, setPath

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag
createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute

Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag
htmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscape

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
doCatch, doStartTag, getRequestContext

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OptionsTag
```
public OptionsTag()
```
- Method Detail
  - setItems
```
public void setItems(Object items)
```
    Set the Collection, Map or array of objects used to generate the inner 'option' tags.
    Required when wishing to render 'option' tags from an array, Collection or Map.
    Typically a runtime expression.
  - getItems
```
@Nullable
protected Object getItems()
```
    Get the Collection, Map or array of objects used to generate the inner 'option' tags.
    Typically a runtime expression.
  - setItemValue
```
public void setItemValue(String itemValue)
```
    Set the name of the property mapped to the 'value' attribute of the 'option' tag.
    Required when wishing to render 'option' tags from an array or Collection.
  - getItemValue
```
@Nullable
protected String getItemValue()
```
    Return the name of the property mapped to the 'value' attribute of the 'option' tag.
  - setItemLabel
```
public void setItemLabel(String itemLabel)
```
    Set the name of the property mapped to the label (inner text) of the 'option' tag.
  - getItemLabel
```
@Nullable
protected String getItemLabel()
```
    Get the name of the property mapped to the label (inner text) of the 'option' tag.
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Set the value of the 'disabled' attribute.
  - isDisabled
```
protected boolean isDisabled()
```
    Get the value of the 'disabled' attribute.
  - writeTagContent
```
protected int writeTagContent(TagWriter tagWriter)
                       throws JspException
```
    Description copied from class: AbstractFormTag
    Subclasses should implement this method to perform tag content rendering.
    Specified by:
    writeTagContent in class AbstractFormTag
    Returns:
    valid tag render instruction as per Tag.doStartTag().
    Throws:
    JspException
  - resolveId
```
protected String resolveId()
                    throws JspException
```
    Appends a counter to a specified id, since we're dealing with multiple HTML elements.
    Overrides:
    resolveId in class AbstractDataBoundFormElementTag
    Throws:
    JspException
    See Also:
    AbstractDataBoundFormElementTag.getId(), AbstractDataBoundFormElementTag.autogenerateId()
  - getBindStatus
```
protected BindStatus getBindStatus()
```
    Description copied from class: AbstractDataBoundFormElementTag
    Get the BindStatus for this tag.
    Overrides:
    getBindStatus in class AbstractDataBoundFormElementTag

Class OptionsTag

Field Summary

Fields inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

Fields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

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

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag

Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

Methods inherited from class java.lang.Object

Constructor Detail

OptionsTag

Method Detail

setItems

getItems

setItemValue

getItemValue

setItemLabel

getItemLabel

setDisabled

isDisabled

writeTagContent

resolveId

getBindStatus