Class ComboBox

  extended by org.apache.struts2.components.Component
      extended by org.apache.struts2.components.UIBean
          extended by org.apache.struts2.components.TextField
              extended by org.apache.struts2.components.ComboBox
Direct Known Subclasses:

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.


 <-- Example One -->
 <s:bean name="struts.util.Counter" id="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"/>

 <-- Example Two -->

 <-- Example Two -->

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

Field Summary
protected  String emptyOption
protected  String headerKey
protected  String headerValue
protected  String list
protected  String listKey
protected  String listValue
static String TEMPLATE
Fields inherited from class org.apache.struts2.components.TextField
maxlength, readonly, size
Fields inherited from class org.apache.struts2.components.UIBean
accesskey, cssClass, cssStyle, defaultTemplateDir, defaultUITheme, disabled, key, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, value
Fields inherited from class org.apache.struts2.components.Component
actionMapper, COMPONENT_STACK, id, parameters, stack
Constructor Summary
ComboBox(ValueStack stack, HttpServletRequest request, HttpServletResponse response)
Method Summary
 void evaluateExtraParams()
protected  Object findListValue()
protected  String getDefaultTemplate()
          A contract that requires each concrete UI Tag to specify which template should be used as a default.
 void setEmptyOption(String emptyOption)
 void setHeaderKey(String headerKey)
 void setHeaderValue(String headerValue)
 void setList(String list)
 void setListKey(String listKey)
 void setListValue(String listValue)
Methods inherited from class org.apache.struts2.components.TextField
setMaxlength, setMaxLength, setReadonly, setSize
Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setKey, setLabel, setLabelposition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTheme, setTitle, setTooltip, setTooltipConfig, setValue
Methods inherited from class org.apache.struts2.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setActionMapper, setId, start, toString, usesBody
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail


public static final String TEMPLATE
See Also:
Constant Field Values


protected String list


protected String listKey


protected String listValue


protected String headerKey


protected String headerValue


protected String emptyOption
Constructor Detail


public ComboBox(ValueStack stack,
                HttpServletRequest request,
                HttpServletResponse response)
Method Detail


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.

getDefaultTemplate in class TextField
The name of the template to be used as the default.


public void evaluateExtraParams()
evaluateExtraParams in class TextField


protected Object findListValue()


public void setList(String list)


public void setEmptyOption(String emptyOption)


public void setHeaderKey(String headerKey)


public void setHeaderValue(String headerValue)


public void setListKey(String listKey)


public void setListValue(String listValue)

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.