Class OptionsTag
- All Implemented Interfaces:
DynamicAttributes,IterationTag,JspTag,Tag,TryCatchFinally,Serializable,EditorAwareTag
<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 | 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:
-
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_ATTRIBUTEFields inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
NESTED_PATH_VARIABLE_NAMEFields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTEFields inherited from class jakarta.servlet.jsp.tagext.TagSupport
pageContextFields inherited from interface jakarta.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAINFields inherited from interface jakarta.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected BindStatusGet theBindStatusfor this tag.protected StringGet the name of the property mapped to the label (inner text) of the 'option' tag.protected ObjectgetItems()protected StringReturn the name of the property mapped to the 'value' attribute of the 'option' tag.protected booleanGet the value of the 'disabled' attribute.protected StringAppends a counter to a specified id, since we're dealing with multiple HTML elements.voidsetDisabled(boolean disabled) Set the value of the 'disabled' attribute.voidsetItemLabel(String itemLabel) Set the name of the property mapped to the label (inner text) of the 'option' tag.voidvoidsetItemValue(String itemValue) Set the name of the property mapped to the 'value' attribute of the 'option' tag.protected intwriteTagContent(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, writeOptionalAttributesMethods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
autogenerateId, convertToDisplayString, doFinally, getBoundValue, getEditor, getId, getName, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, setId, setPathMethods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag
createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttributeMethods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag
htmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscapeMethods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
doCatch, doStartTag, getRequestContextMethods inherited from class jakarta.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue
-
Constructor Details
-
OptionsTag
public OptionsTag()
-
-
Method Details
-
setItems
Set theCollection,Mapor array of objects used to generate the inner 'option' tags.Required when wishing to render '
option' tags from an array,CollectionorMap.Typically a runtime expression.
-
getItems
Get theCollection,Mapor array of objects used to generate the inner 'option' tags.Typically a runtime expression.
-
setItemValue
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 orCollection. -
getItemValue
Return the name of the property mapped to the 'value' attribute of the 'option' tag. -
setItemLabel
Set the name of the property mapped to the label (inner text) of the 'option' tag. -
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
Description copied from class:AbstractFormTagSubclasses should implement this method to perform tag content rendering.- Specified by:
writeTagContentin classAbstractFormTag- Returns:
- valid tag render instruction as per
Tag.doStartTag(). - Throws:
JspException
-
resolveId
Appends a counter to a specified id, since we're dealing with multiple HTML elements.- Overrides:
resolveIdin classAbstractDataBoundFormElementTag- Throws:
JspException- See Also:
-
getBindStatus
Description copied from class:AbstractDataBoundFormElementTagGet theBindStatusfor this tag.- Overrides:
getBindStatusin classAbstractDataBoundFormElementTag
-