com.jgeppert.struts2.jquery.components

Class Autocompleter

java.lang.Object

org.apache.struts2.components.Component

org.apache.struts2.components.UIBean

org.apache.struts2.components.ClosingUIBean

com.jgeppert.struts2.jquery.components.AbstractTopicsBean

com.jgeppert.struts2.jquery.components.AbstractRemoteBean

com.jgeppert.struts2.jquery.components.AbstractContainer

com.jgeppert.struts2.jquery.components.AbstractFormElement

com.jgeppert.struts2.jquery.components.AbstractFormListElement

com.jgeppert.struts2.jquery.components.Autocompleter

All Implemented Interfaces:

DraggableBean, DroppableBean, ResizableBean, SelectableBean, SortableBean

public class Autocompleter
extends AbstractFormListElement

A tag that creates an Autocompleter.

Examples

Autocompleter handle a String Array

 <sj:autocompleter id="languages" list="%{languages}"/>
 

Autocompleter that handle a JSON Result

  <s:url id="remoteurl" action="jsonlanguages"/>
  <sj:autocompleter
     id="languages"
     href="%{remoteurl}"
     delay="50"
     loadMinimumCount="2"
   />
 

Autocompleter as Select Box

          <sj:autocompleter
           id="customers"
           name="echo"
           list="%{customers}"
           listValue="name"
           listKey="id"
           selectBox="true"
         />
 

Author:

Johannes Geppert

Field Summary

Fields

Modifier and Type	Field and Description
protected String	autoFocus
protected String	delay
protected String	forceValidOption
static String	JQUERYACTION
protected String	listLabel
protected String	loadMinimumCount
protected static com.opensymphony.xwork2.util.logging.Logger	LOG
protected String	maxlength
protected String	multiple
protected String	onFocusTopics
protected String	onSearchTopics
protected String	onSelectTopics
static String	OPEN_TEMPLATE
protected String	readonly
protected String	selectBox
protected String	selectBoxIcon
protected String	size
static String	TEMPLATE
protected String	valueWidget

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractFormListElement

list, listKey, listValue, throwExceptionOnNullValueAttribute

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractFormElement

parentTheme

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractContainer

bindOn, deferredLoading, draggable, draggableAddClasses, draggableAppendTo, draggableAxis, draggableCancel, draggableContainment, draggableCursor, draggableDelay, draggableDistance, draggableHandle, draggableHelper, draggableIframeFix, draggableOnDragTopics, draggableOnStartTopics, draggableOnStopTopics, draggableOpacity, draggableRefreshPositions, draggableRevert, draggableRevertDuration, draggableScope, draggableScroll, draggableScrollSensitivity, draggableScrollSpeed, draggableSnap, draggableSnapMode, draggableSnapTolerance, draggableZindex, droppable, droppableAccept, droppableActiveClass, droppableAddClasses, droppableGreedy, droppableHoverClass, droppableOnActivateTopics, droppableOnDeactivateTopics, droppableOnDropTopics, droppableOnOutTopics, droppableOnOverTopics, droppableScope, droppableTolerance, events, reloadTopics, resizable, resizableAnimate, resizableAnimateDuration, resizableAnimateEasing, resizableAspectRatio, resizableAutoHide, resizableContainment, resizableDelay, resizableDistance, resizableGhost, resizableHandles, resizableHelper, resizableMaxHeight, resizableMaxWidth, resizableMinHeight, resizableMinWidth, resizableOnResizeTopics, resizableOnStartTopics, resizableOnStopTopics, selectable, selectableAutoRefresh, selectableCancel, selectableDelay, selectableDistance, selectableFilter, selectableOnSelectedTopics, selectableOnSelectingTopics, selectableOnStartTopics, selectableOnStopTopics, selectableOnUnselectedTopics, selectableOnUnselectingTopics, selectableTolerance, sortable, sortableAppendTo, sortableAxis, sortableCancel, sortableConnectWith, sortableContainment, sortableCursor, sortableCursorAt, sortableDelay, sortableDistance, sortableDropOnEmpty, sortableForceHelperSize, sortableForcePlaceholderSize, sortableGrid, sortableHandle, sortableHelper, sortableItems, sortableOnActivateTopics, sortableOnBeforeStopTopics, sortableOnChangeTopics, sortableOnDeactivateTopics, sortableOnOutTopics, sortableOnOverTopics, sortableOnReceiveTopics, sortableOnRemoveTopics, sortableOnSortTopics, sortableOnStartTopics, sortableOnStopTopics, sortableOnUpdateTopics, sortableOpacity, sortablePlaceholder, sortableRevert, sortableScroll, sortableScrollSensitivity, sortableScrollSpeed, sortableTolerance, sortableZindex

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractRemoteBean

dataType, effect, effectDuration, effectMode, effectOptions, errorElementId, errorText, formIds, href, indicator, listenTopics, loadingText, onEffectCompleteTopics, requestType, targets, timeout

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractTopicsBean

onAfterValidationTopics, onAlwaysTopics, onBeforeTopics, onBlurTopics, onChangeTopics, onCompleteTopics, onDisableTopics, onEnableTopics, onErrorTopics, onSuccessTopics

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

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

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

actionMapper, COMPONENT_STACK, parameters, stack, throwExceptionOnELFailure

Constructor Summary

Constructors

Constructor and Description
Autocompleter(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

Methods

Modifier and Type	Method and Description
void	evaluateParams()
String	getDefaultOpenTemplate()
protected String	getDefaultTemplate()
String	getTheme()
void	setAutoFocus(String autoFocus)
void	setDelay(String delay)
void	setForceValidOption(String forceValidOption)
void	setListLabel(String listLabel)
void	setLoadMinimumCount(String loadMinimumCount)
void	setMaxlength(String maxlength)
void	setMultiple(String multiple)
void	setOnFocusTopics(String onFocusTopics)
void	setOnSearchTopics(String onSearchTopics)
void	setOnSelectTopics(String onSelectTopics)
void	setReadonly(String readonly)
void	setSelectBox(String selectBox)
void	setSelectBoxIcon(String selectBoxIcon)
void	setSize(String size)
void	setTheme(String theme)
void	setValueWidget(String valueWidget)

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractFormListElement

contains, evaluateExtraParams, getValueClassType, setList, setListKey, setListValue, setThrowExceptionOnNullValueAttribute

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractFormElement

setParentTheme

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractContainer

setBindOn, setDeferredLoading, setDraggable, setDraggableAddClasses, setDraggableAppendTo, setDraggableAxis, setDraggableCancel, setDraggableContainment, setDraggableCursor, setDraggableDelay, setDraggableDistance, setDraggableHandle, setDraggableHelper, setDraggableIframeFix, setDraggableOnDragTopics, setDraggableOnStartTopics, setDraggableOnStopTopics, setDraggableOpacity, setDraggableRefreshPositions, setDraggableRevert, setDraggableRevertDuration, setDraggableScope, setDraggableScroll, setDraggableScrollSensitivity, setDraggableScrollSpeed, setDraggableSnap, setDraggableSnapMode, setDraggableSnapTolerance, setDraggableZindex, setDroppable, setDroppableAccept, setDroppableActiveClass, setDroppableAddClasses, setDroppableGreedy, setDroppableHoverClass, setDroppableOnActivateTopics, setDroppableOnDeactivateTopics, setDroppableOnDropTopics, setDroppableOnOutTopics, setDroppableOnOverTopics, setDroppableScope, setDroppableTolerance, setEvents, setOnCompleteTopics, setOnErrorTopics, setOnSuccessTopics, setReloadTopics, setResizable, setResizableAnimate, setResizableAnimateDuration, setResizableAnimateEasing, setResizableAspectRatio, setResizableAutoHide, setResizableContainment, setResizableDelay, setResizableDistance, setResizableGhost, setResizableHandles, setResizableHelper, setResizableMaxHeight, setResizableMaxWidth, setResizableMinHeight, setResizableMinWidth, setResizableOnResizeTopics, setResizableOnStartTopics, setResizableOnStopTopics, setSelectable, setSelectableAutoRefresh, setSelectableCancel, setSelectableDelay, setSelectableDistance, setSelectableFilter, setSelectableOnSelectedTopics, setSelectableOnSelectingTopics, setSelectableOnStartTopics, setSelectableOnStopTopics, setSelectableOnUnselectedTopics, setSelectableOnUnselectingTopics, setSelectableTolerance, setSortable, setSortableAppendTo, setSortableAxis, setSortableCancel, setSortableConnectWith, setSortableContainment, setSortableCursor, setSortableCursorAt, setSortableDelay, setSortableDistance, setSortableDropOnEmpty, setSortableForceHelperSize, setSortableForcePlaceholderSize, setSortableGrid, setSortableHandle, setSortableHelper, setSortableItems, setSortableOnActivateTopics, setSortableOnBeforeStopTopics, setSortableOnChangeTopics, setSortableOnDeactivateTopics, setSortableOnOutTopics, setSortableOnOverTopics, setSortableOnReceiveTopics, setSortableOnRemoveTopics, setSortableOnSortTopics, setSortableOnStartTopics, setSortableOnStopTopics, setSortableOnUpdateTopics, setSortableOpacity, setSortablePlaceholder, setSortableRevert, setSortableScroll, setSortableScrollSensitivity, setSortableScrollSpeed, setSortableTolerance, setSortableZindex

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractRemoteBean

setDataType, setEffect, setEffectDuration, setEffectMode, setEffectOptions, setErrorElementId, setErrorText, setFormIds, setHref, setIndicator, setListenTopics, setLoadingText, setOnEffectCompleteTopics, setRequestType, setTargets, setTimeout

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractTopicsBean

setOnAfterValidationTopics, setOnAlwaysTopics, setOnBeforeTopics, setOnBlurTopics, setOnChangeTopics, setOnDisableTopics, setOnEnableTopics

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

setOpenTemplate, start

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

addFormParameter, buildTemplateName, copyParams, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, getId, getStandardAttributes, getTemplate, getTemplateDir, getTooltipConfig, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setErrorPosition, setId, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequiredLabel, setRequiredPosition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setValue

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

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

Methods inherited from class java.lang.Object

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

Field Detail

JQUERYACTION

public static final String JQUERYACTION

See Also:

Constant Field Values

TEMPLATE

public static final String TEMPLATE

See Also:

Constant Field Values

OPEN_TEMPLATE

public static final String OPEN_TEMPLATE

See Also:

Constant Field Values

LOG

protected static final com.opensymphony.xwork2.util.logging.Logger LOG

delay

protected String delay

loadMinimumCount

protected String loadMinimumCount

selectBox

protected String selectBox

selectBoxIcon

protected String selectBoxIcon

onSelectTopics

protected String onSelectTopics

onFocusTopics

protected String onFocusTopics

onSearchTopics

protected String onSearchTopics

maxlength

protected String maxlength

readonly

protected String readonly

size

protected String size

multiple

protected String multiple

listLabel

protected String listLabel

forceValidOption

protected String forceValidOption

autoFocus

protected String autoFocus

valueWidget

protected String valueWidget

Constructor Detail

Autocompleter

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

Method Detail

getDefaultOpenTemplate

public String getDefaultOpenTemplate()

Specified by:

getDefaultOpenTemplate in class org.apache.struts2.components.ClosingUIBean

getDefaultTemplate

protected String getDefaultTemplate()

Specified by:

getDefaultTemplate in class org.apache.struts2.components.UIBean

evaluateParams

public void evaluateParams()

Overrides:

evaluateParams in class org.apache.struts2.components.UIBean

setTheme

public void setTheme(String theme)

Overrides:

setTheme in class org.apache.struts2.components.UIBean

getTheme

public String getTheme()

Overrides:

getTheme in class org.apache.struts2.components.UIBean

setDelay

public void setDelay(String delay)

setLoadMinimumCount

public void setLoadMinimumCount(String loadMinimumCount)

setSelectBox

public void setSelectBox(String selectBox)

setSelectBoxIcon

public void setSelectBoxIcon(String selectBoxIcon)

setOnSelectTopics

public void setOnSelectTopics(String onSelectTopics)

setOnFocusTopics

public void setOnFocusTopics(String onFocusTopics)

Overrides:

setOnFocusTopics in class AbstractTopicsBean

setOnSearchTopics

public void setOnSearchTopics(String onSearchTopics)

setMaxlength

public void setMaxlength(String maxlength)

setReadonly

public void setReadonly(String readonly)

setSize

public void setSize(String size)

setMultiple

public void setMultiple(String multiple)

setListLabel

public void setListLabel(String listLabel)

setForceValidOption

public void setForceValidOption(String forceValidOption)

setAutoFocus

public void setAutoFocus(String autoFocus)

setValueWidget

public void setValueWidget(String valueWidget)