Java Doc for Autocompleter.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » components » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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.

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

'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"/>