Package org.apache.struts2.components

Class ComboBox

java.lang.Object
org.apache.struts2.components.Component
org.apache.struts2.components.UIBean
org.apache.struts2.components.TextField
org.apache.struts2.components.ComboBox
public class ComboBox extends TextField

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 <form>.

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.

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" )

  • Field Details

  • Constructor Details

    • ComboBox

      public ComboBox(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

  • Method Details

    • getDefaultTemplate

      protected String getDefaultTemplate()
      Description copied from class: UIBean
      A contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.
      Overrides:
      getDefaultTemplate in class TextField
      Returns:
      The name of the template to be used as the default.

    • evaluateExtraParams

      public void evaluateExtraParams()
      Overrides:
      evaluateExtraParams in class TextField

    • findListValue

      protected Object findListValue()

    • setList

      public void setList(String list)

    • setEmptyOption

      public void setEmptyOption(String emptyOption)

    • setHeaderKey

      public void setHeaderKey(String headerKey)

    • setHeaderValue

      public void setHeaderValue(String headerValue)

    • setListKey

      public void setListKey(String listKey)

    • setListValue

      public void setListValue(String listValue)