Edit on GitHub << back to Tag Reference

# combobox

Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.

## Description

The combo box is basically an HTML INPUT of type text and HTML SELECT grouped together to give you a combo box functionality. You can place text in the INPUT control by using the SELECT control or type it in directly in the text field.

In this example, the SELECT will be populated from id=year attribute. Counter is itself an Iterator. It will span from first to last. The population is done via javascript, and requires that this tag be surrounded by a

Note that unlike the `<s:select/>` tag, there is no ability to define the individual `<option>` tags’ id attribute or content separately. Each of these is simply populated from the toString() method of the list item. Presumably this is because the select box isn’t intended to actually submit useful data, but to assist the user in filling out the text field.

Widget that fills a text box from a select

## Attributes

#### Dynamic Attributes Allowed: false
#### Name | #### Required | #### Default | #### Evaluated | #### Type | #### Description
--- | --- | --- | --- | --- | ---
accesskey | false |  | false | String | Set the html accesskey attribute on rendered html element
cssClass | false |  | false | String | The css class to use for element
cssErrorClass | false |  | false | String | The css error class to use for element
cssErrorStyle | false |  | false | String | The css error style definitions for element to use
cssStyle | false |  | false | String | The css style definitions for element to use
disabled | false |  | false | String | Set the html disabled attribute on rendered html element
emptyOption | false |  | false | String | Decide if an empty option is to be inserted. Default false.
errorPosition | false |  | false | String | Define error position of form element (top|bottom)
headerKey | false |  | false | String | Set the header key for the header option.
headerValue | false |  | false | String | Set the header value for the header option.
id | false |  | false | String | HTML id attribute
javascriptTooltip | false | false | false | Boolean | Use JavaScript to generate tooltips
key | false |  | false | String | Set the key (name, value, label) for this particular component
label | false |  | false | String | Label expression used for rendering an element specific label
labelPosition | false |  | false | String | Define label position of form element (top/left)
labelSeparator | false | : | false | String | String that will be appended to the label
list | true |  | false | String | Iterable source to populate from. If this is missing, the select widget is simply not displayed.
listKey | false |  | false | String | Set the key used to retrieve the option key.
listValue | false |  | false | String | Set the value used to retrieve the option value.
maxLength | false |  | false | Integer | Deprecated. Use maxlength instead.
maxlength | false |  | false | Integer | HTML maxlength attribute
name | false |  | false | String | The name to set for element
onblur | false |  | false | String | Set the html onblur attribute on rendered html element
onchange | false |  | false | String | Set the html onchange attribute on rendered html element
onclick | false |  | false | String | Set the html onclick attribute on rendered html element
ondblclick | false |  | false | String | Set the html ondblclick attribute on rendered html element
onfocus | false |  | false | String | Set the html onfocus attribute on rendered html element
onkeydown | false |  | false | String | Set the html onkeydown attribute on rendered html element
onkeypress | false |  | false | String | Set the html onkeypress attribute on rendered html element
onkeyup | false |  | false | String | Set the html onkeyup attribute on rendered html element
onmousedown | false |  | false | String | Set the html onmousedown attribute on rendered html element
onmousemove | false |  | false | String | Set the html onmousemove attribute on rendered html element
onmouseout | false |  | false | String | Set the html onmouseout attribute on rendered html element
onmouseover | false |  | false | String | Set the html onmouseover attribute on rendered html element
onmouseup | false |  | false | String | Set the html onmouseup attribute on rendered html element
onselect | false |  | false | String | Set the html onselect attribute on rendered html element
performClearTagStateForTagPoolingServers | false | false | false | Boolean | Whether to clear all tag state during doEndTag() processing (if applicable)
readonly | false | false | false | Boolean | Whether the input is readonly
requiredLabel | false | false | false | Boolean | If set to true, the rendered element will indicate that input is required
requiredPosition | false |  | false | String | Define required position of required form element (left|right)
size | false |  | false | Integer | HTML size attribute
style | false |  | false | String | The css style definitions for element to use - it's an alias of cssStyle attribute.
tabindex | false |  | false | String | Set the html tabindex attribute on rendered html element
template | false |  | false | String | The template (other than default) to use for rendering the element
templateDir | false |  | false | String | The template directory.
theme | false |  | false | String | The theme (other than default) to use for rendering the element
title | false |  | false | String | Set the html title attribute on rendered html element
tooltip | false |  | false | String | Set the tooltip of this particular component
tooltipConfig | false |  | false | String | Deprecated. Use individual tooltip configuration attributes instead.
tooltipCssClass | false | StrutsTTClassic | false | String | CSS class applied to JavaScrip tooltips
tooltipDelay | false | Classic | false | String | Delay in milliseconds, before showing JavaScript tooltips
tooltipIconPath | false |  | false | String | Icon path used for image that will have the tooltip
type | false | text | false | String | Specifies the html5 type element to display. e.g. text, email, url
value | false |  | false | String | Preset the value of input element.

## Examples

### JSP:

    <-- Example One -->
    <s:bean name="struts.util.Counter" var="year">
      <s:param name="first" value="text('firstBirthYear')"/>
      <s:param name="last" value="2000"/>

      <s:combobox label="Birth year" size="6" maxlength="4" name="birthYear" list="#year"/>
    </s:bean>

    <-- Example Two -->
    <s:combobox
        label="My Favourite Fruit"
        name="myFavouriteFruit"
        list="{'apple','banana','grape','pear'}"
        headerKey="-1"
        headerValue="--- Please Select ---"
        emptyOption="true"
        value="banana" />

    <-- Example Two -->
    <s:combobox
       label="My Favourite Color"
       name="myFavouriteColor"
       list="#{'red':'red','green':'green','blue':'blue'}"
       headerKey="-1"
       headerValue="--- Please Select ---"
       emptyOption="true"
       value="green" />

### Velocity:

    #tag( ComboBox "label=Birth year" "size=6" "maxlength=4" "name=birthYear" "list=#year" )