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" 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"/>
 </s:bean>
 
 <-- Example Two -->
 
     
 <-- Example Two -->
 

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

Field Summary

protected java.lang.String	emptyOption
protected java.lang.String	headerKey
protected java.lang.String	headerValue
protected java.lang.String	list
protected java.lang.String	listKey
protected java.lang.String	listValue
static java.lang.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, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value

Fields inherited from class org.apache.struts2.components.Component

COMPONENT_STACK, id, parameters, stack

Constructor Summary

ComboBox(com.opensymphony.xwork2.util.OgnlValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

void	evaluateExtraParams()
protected java.lang.String	getDefaultTemplate() A contract that requires each concrete UI Tag to specify which template should be used as a default.
void	setEmptyOption(java.lang.String emptyOption) Decide if an empty option is to be inserted.
void	setHeaderKey(java.lang.String headerKey) set the header key for the header option.
void	setHeaderValue(java.lang.String headerValue) set the header value for the header option.
void	setList(java.lang.String list) Iteratable source to populate from.
void	setListKey(java.lang.String listKey) set the key used to retrive the option key.
void	setListValue(java.lang.String listValue) set the value used to retrive the option value.

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, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue

Methods inherited from class org.apache.struts2.components.Component

addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString, usesBody

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE

See Also:

Constant Field Values

list

protected java.lang.String list

listKey

protected java.lang.String listKey

listValue

protected java.lang.String listValue

headerKey

protected java.lang.String headerKey

headerValue

protected java.lang.String headerValue

emptyOption

protected java.lang.String emptyOption

Constructor Detail

ComboBox

public ComboBox(com.opensymphony.xwork2.util.OgnlValueStack stack,
                javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response)

Method Detail

getDefaultTemplate

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

setList

public void setList(java.lang.String list)

Iteratable source to populate from. If this is missing, the select widget is simply not displayed.

setEmptyOption

public void setEmptyOption(java.lang.String emptyOption)

Decide if an empty option is to be inserted. Default false.

setHeaderKey

public void setHeaderKey(java.lang.String headerKey)

set the header key for the header option.

setHeaderValue

public void setHeaderValue(java.lang.String headerValue)

set the header value for the header option.

setListKey

public void setListKey(java.lang.String listKey)

set the key used to retrive the option key.

setListValue

public void setListValue(java.lang.String listValue)

set the value used to retrive the option value.