spring-framework / org.springframework.web.servlet.tags.form / OptionsTag

OptionsTag

open class OptionsTag : AbstractHtmlElementTag

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

Must be used within a SelectTag.

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.

false

true

HTML Standard Attribute

itemLabel

false

true

Name of the property mapped to the inner text of the 'option' tag

items

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

Author
Rob Harrop

Author
Juergen Hoeller

Author
Scott Andrews

Since
2.0

Constructors

<init>

OptionsTag()

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

Must be used within a SelectTag.

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.

false

true

HTML Standard Attribute

itemLabel

false

true

Name of the property mapped to the inner text of the 'option' tag

items

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

Functions

setDisabled	`open fun setDisabled(disabled: Boolean): Unit` Set the value of the '`disabled`' attribute.
setItemLabel	`open fun setItemLabel(itemLabel: String): Unit` Set the name of the property mapped to the label (inner text) of the '`option`' tag.
setItemValue	`open fun setItemValue(itemValue: String): Unit` 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 java.util.Collection.
setItems	`open fun setItems(items: Any): Unit` Set the java.util.Collection, java.util.Map or array of objects used to generate the inner '`option`' tags. Required when wishing to render '`option`' tags from an array, java.util.Collection or java.util.Map. Typically a runtime expression.