Home » struts-2.1.8.1-src » org.apache » struts2 » components » [javadoc | source]

org.apache.struts2.components
public class: Autocompleter [javadoc | source]

java.lang.Object
   org.apache.struts2.components.Component
      org.apache.struts2.components.UIBean
         org.apache.struts2.components.TextField
            org.apache.struts2.components.ComboBox
               org.apache.struts2.components.Autocompleter

The autocomplete tag is a combobox that can autocomplete text entered on the input box. When used on the "simple" theme, the autocompleter can be used like the ComboBox. When used on the "ajax" theme, the list can be retieved from an action.

THE FOLLOWING IS ONLY VALID WHEN AJAX IS CONFIGURED

• href
• errorText
• listenTopics
• notifyTopics
• listenTopics
• formId
• formFilter
• indicator
• loadOnTextChange
• loadMinimumCount
• showDownArrow
• searchType

'dropdownWidth' width in pixels of the drodpdown, same as autocompleter's width by default

'dropdownHeight' height in pixels of the drodown, 120 px by default

'forceValidOption' if invalid option is selected, clear autocompleter's text when focus is lost

'autoComplete', if true, make suggestions on the textbox

'formId' is the id of the html form whose fields will be seralized and passed as parameters in the request.

'formFilter' is the name of a function which will be used to filter the fields that will be seralized. This function takes as a parameter the element and returns true if the element should be included.

'listenTopics' comma separated list of topics names, that will trigger a request 'indicator' element to be shown while the request executing 'showErrorTransportText': whether errors should be displayed (on 'targets')

'loadOnTextChange' options will be reloaded everytime a character is typed on the textbox

'loadMinimumCount' minimum number of characters that will force the content to be loaded

'showDownError' show or hide the down arrow button

'searchType' how the search must be performed, options are: "startstring", "startword" and "substring"

'keyName' name of the field to which the selected key will be assigned

'iconPath' path of icon used for the dropdown

'templateCssPath' path to css file used to customize Dojo's widget

'dataFieldName' name of the field to be used as the list in the returned JSON string

'notifyTopics' comma separated list of topics names, that will be published. Three parameters are passed:

• data: selected value when type='valuechanged'
• type: 'before' before the request is made, 'valuechanged' when selection changes, 'load' when the request succeeds, or 'error' when it fails
• request: request javascript object, when type='load' or type='error'

Autocompleter that gets its list from an action:

<s:autocompleter name="test" href="%{jsonList}" autoComplete="false"/>


Autocompleter that uses a list:

<s:autocompleter name="test" list="{'apple','banana','grape','pear'}" autoComplete="false"/>


Field Summary
public static final  String	TEMPLATE
protected  String	forceValidOption
protected  String	searchType
protected  String	autoComplete
protected  String	delay
protected  String	disabled
protected  String	href
protected  String	dropdownWidth
protected  String	dropdownHeight
protected  String	formId
protected  String	formFilter
protected  String	listenTopics
protected  String	notifyTopics
protected  String	indicator
protected  String	loadOnTextChange
protected  String	loadMinimumCount
protected  String	showDownArrow
protected  String	templateCssPath
protected  String	iconPath
protected  String	keyName
protected  String	dataFieldName
protected  String	resultsLimit

Fields inherited from org.apache.struts2.components.ComboBox:
TEMPLATE,  list,  listKey,  listValue,  headerKey,  headerValue,  emptyOption

Fields inherited from org.apache.struts2.components.TextField:
TEMPLATE,  maxlength,  readonly,  size

Fields inherited from org.apache.struts2.components.UIBean:

request,  response,  templateSuffix,  template,  templateDir,  theme,  key,  id,  cssClass,  cssStyle,  cssErrorClass,  cssErrorStyle,  disabled,  label,  labelPosition,  labelSeparator,  requiredposition,  name,  required,  tabindex,  value,  title,  onclick,  ondblclick,  onmousedown,  onmouseup,  onmouseover,  onmousemove,  onmouseout,  onfocus,  onblur,  onkeypress,  onkeydown,  onkeyup,  onselect,  onchange,  accesskey,  tooltip,  tooltipConfig,  javascriptTooltip,  tooltipDelay,  tooltipCssClass,  tooltipIconPath,  dynamicAttributes,  defaultTemplateDir,  defaultUITheme,  templateEngineManager

Fields inherited from org.apache.struts2.components.Component:
COMPONENT_STACK,  stack,  parameters,  actionMapper,  throwExceptionOnELFailure

Constructor:
public Autocompleter(ValueStack stack, HttpServletRequest request, HttpServletResponse response) { super(stack, request, response); }

Method from org.apache.struts2.components.Autocompleter Summary:

evaluateExtraParams,   findListValue,   getComponentName,   getDefaultTemplate,   setAutoComplete,   setDataFieldName,   setDelay,   setDisabled,   setDropdownHeight,   setDropdownWidth,   setForceValidOption,   setFormFilter,   setFormId,   setHref,   setIconPath,   setIndicator,   setKeyName,   setList,   setListenTopics,   setLoadMinimumCount,   setLoadOnTextChange,   setNotifyTopics,   setResultsLimit,   setSearchType,   setShowDownArrow,   setTemplateCssPath

Methods from org.apache.struts2.components.ComboBox:
evaluateExtraParams,   findListValue,   getDefaultTemplate,   setEmptyOption,   setHeaderKey,   setHeaderValue,   setList,   setListKey,   setListValue

Methods from org.apache.struts2.components.TextField:
evaluateExtraParams,   getDefaultTemplate,   setMaxLength,   setMaxlength,   setReadonly,   setSize

Methods from org.apache.struts2.components.UIBean:

addFormParameter,   buildTemplateName,   enableAncestorFormCustomOnsubmit,   end,   ensureAttributeSafelyNotEscaped,   escape,   evaluateExtraParams,   evaluateNameValue,   evaluateParams,   getDefaultTemplate,   getId,   getTemplate,   getTemplateDir,   getTheme,   getTooltipConfig,   getValueClassType,   mergeTemplate,   populateComponentHtmlId,   setAccesskey,   setCssClass,   setCssErrorClass,   setCssErrorStyle,   setCssStyle,   setDefaultTemplateDir,   setDefaultUITheme,   setDisabled,   setDynamicAttributes,   setId,   setJavascriptTooltip,   setKey,   setLabel,   setLabelSeparator,   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,   setTooltipCssClass,   setTooltipDelay,   setTooltipIconPath,   setValue

Methods from org.apache.struts2.components.Component:

addAllParameters,   addParameter,   altSyntax,   altSyntax,   completeExpressionIfAltSyntax,   copyParams,   determineActionURL,   determineNamespace,   end,   end,   fieldError,   findAncestor,   findString,   findString,   findStringIfAltSyntax,   findValue,   findValue,   findValue,   getComponentStack,   getParameters,   getStack,   popComponentStack,   setActionMapper,   setThrowExceptionsOnELFailure,   start,   stripExpressionIfAltSyntax,   stripExpressionIfAltSyntax,   toString,   usesBody

Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.struts2.components.Autocompleter Detail:
public void evaluateExtraParams() { super.evaluateExtraParams(); if (forceValidOption != null) addParameter("forceValidOption", findValue(forceValidOption, Boolean.class)); if (searchType != null) { String type = findString(searchType); if(type != null) addParameter("searchType", type.toUpperCase()); } if (autoComplete != null) addParameter("autoComplete", findValue(autoComplete, Boolean.class)); if (delay != null) addParameter("delay", findValue(delay, Integer.class)); if (disabled != null) addParameter("disabled", findValue(disabled, Boolean.class)); if (href != null) { addParameter("href", findString(href)); addParameter("mode", "remote"); } if (dropdownHeight != null) addParameter("dropdownHeight", findValue(dropdownHeight, Integer.class)); if (dropdownWidth != null) addParameter("dropdownWidth", findValue(dropdownWidth, Integer.class)); if (formFilter != null) addParameter("formFilter", findString(formFilter)); if (formId != null) addParameter("formId", findString(formId)); if (listenTopics != null) addParameter("listenTopics", findString(listenTopics)); if (notifyTopics != null) addParameter("notifyTopics", findString(notifyTopics)); if (indicator != null) addParameter("indicator", findString(indicator)); if (loadOnTextChange != null) addParameter("loadOnTextChange", findValue(loadOnTextChange, Boolean.class)); if (loadMinimumCount != null) addParameter("loadMinimumCount", findValue(loadMinimumCount, Integer.class)); if (showDownArrow != null) addParameter("showDownArrow", findValue(showDownArrow, Boolean.class)); else addParameter("showDownArrow", Boolean.TRUE); if(templateCssPath != null) addParameter("templateCssPath", findString(templateCssPath)); if(iconPath != null) addParameter("iconPath", findString(iconPath)); if(dataFieldName != null) addParameter("dataFieldName", findString(dataFieldName)); if(keyName != null) addParameter("keyName", findString(keyName)); else { keyName = name + "Key"; addParameter("keyName", findString(keyName)); } String keyNameExpr = "%{" + keyName + "}"; addParameter("key", findString(keyNameExpr)); if(resultsLimit != null) addParameter("searchLimit", findString(resultsLimit)); }
protected Object findListValue() { return (list != null) ? findValue(list, Object.class) : null; }
public String getComponentName() { return COMPONENT_NAME; }
protected String getDefaultTemplate() { return TEMPLATE; }
public void setAutoComplete(String autoComplete) { this.autoComplete = autoComplete; }
public void setDataFieldName(String dataFieldName) { this.dataFieldName = dataFieldName; }
public void setDelay(String searchDelay) { this.delay = searchDelay; }
public void setDisabled(String disabled) { this.disabled = disabled; }
public void setDropdownHeight(String height) { this.dropdownHeight = height; }
public void setDropdownWidth(String width) { this.dropdownWidth = width; }
public void setForceValidOption(String forceValidOption) { this.forceValidOption = forceValidOption; }
public void setFormFilter(String formFilter) { this.formFilter = formFilter; }
public void setFormId(String formId) { this.formId = formId; }
public void setHref(String href) { this.href = href; }
public void setIconPath(String iconPath) { this.iconPath = iconPath; }
public void setIndicator(String indicator) { this.indicator = indicator; }
public void setKeyName(String keyName) { this.keyName = keyName; }
public void setList(String list) { super.setList(list); }
public void setListenTopics(String listenTopics) { this.listenTopics = listenTopics; }
public void setLoadMinimumCount(String loadMinimumCount) { this.loadMinimumCount = loadMinimumCount; }
public void setLoadOnTextChange(String loadOnType) { this.loadOnTextChange = loadOnType; }
public void setNotifyTopics(String onValueChangedPublishTopic) { this.notifyTopics = onValueChangedPublishTopic; }
public void setResultsLimit(String resultsLimit) { this.resultsLimit = resultsLimit; }
public void setSearchType(String searchType) { this.searchType = searchType; }
public void setShowDownArrow(String showDownArrow) { this.showDownArrow = showDownArrow; }
public void setTemplateCssPath(String templateCssPath) { this.templateCssPath = templateCssPath; }