org.springframework.web.servlet.tags.form

Class OptionsTag

  • All Implemented Interfaces:
    java.io.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
    • Constructor Detail

      • OptionsTag

        public OptionsTag()
    • Method Detail

      • setItems

        public void setItems(java.lang.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 java.lang.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(java.lang.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 java.lang.String getItemValue()
        Return the name of the property mapped to the 'value' attribute of the 'option' tag.
      • setItemLabel

        public void setItemLabel(java.lang.String itemLabel)
        Set the name of the property mapped to the label (inner text) of the 'option' tag.
      • getItemLabel

        @Nullable
        protected java.lang.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.