org.apache.wicket.extensions.ajax.markup.html.autocomplete
Class AutoCompleteBehavior<T>

java.lang.Object
  org.apache.wicket.behavior.AbstractBehavior
      org.apache.wicket.behavior.AbstractAjaxBehavior
          org.apache.wicket.ajax.AbstractDefaultAjaxBehavior
              org.apache.wicket.extensions.ajax.markup.html.autocomplete.AbstractAutoCompleteBehavior
                  org.apache.wicket.extensions.ajax.markup.html.autocomplete.AutoCompleteBehavior<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, IBehavior, IBehaviorListener, IComponentConfigurationBehavior, IClusterable, IRequestListener, IHeaderContributor

public abstract class AutoCompleteBehavior<T>
extends AbstractAutoCompleteBehavior

This behavior builds on top of AbstractAutoCompleteBehavior by introducing the concept of a IAutoCompleteRenderer to make response writing easier.

Since:

1.2

Author:

Igor Vaynberg (ivaynberg), Janne Hietamäki (jannehietamaki)

See Also:

IAutoCompleteRenderer, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.extensions.ajax.markup.html.autocomplete.AbstractAutoCompleteBehavior

preselect, settings

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

AutoCompleteBehavior(IAutoCompleteRenderer<T> renderer)
Constructor

AutoCompleteBehavior(IAutoCompleteRenderer<T> renderer, AutoCompleteSettings settings)
Constructor

AutoCompleteBehavior(IAutoCompleteRenderer<T> renderer, boolean preselect)
Constructor

Method Summary

protected abstract Iterator<T>	getChoices(String input) Callback method that should return an iterator over all possible choice objects.
protected void	onRequest(String val, RequestCycle requestCycle) Callback for the ajax event generated by the javascript.

Methods inherited from class org.apache.wicket.extensions.ajax.markup.html.autocomplete.AbstractAutoCompleteBehavior

constructSettingsJS, onBind, renderHead, respond

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, generateCallbackScript, getAjaxCallDecorator, getCallbackScript, getCallbackScript, getChannelName, getFailureScript, getPreconditionScript, getSuccessScript, onRequest, throttleScript

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

bind, getCallbackUrl, getCallbackUrl, getComponent, getImplementationId, getStatelessHint, onComponentRendered, onComponentTag, onComponentTag, onRendered, onRenderHeadContribution, onRenderHeadInitContribution

Methods inherited from class org.apache.wicket.behavior.AbstractBehavior

afterRender, beforeRender, cleanup, detach, detachModel, exception, isEnabled, isTemporary, onConfigure, onException, rendered

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoCompleteBehavior

public AutoCompleteBehavior(IAutoCompleteRenderer<T> renderer)

Constructor

Parameters:

renderer - renderer that will be used to generate output

AutoCompleteBehavior

public AutoCompleteBehavior(IAutoCompleteRenderer<T> renderer,
                            boolean preselect)

Constructor

Parameters:

renderer - renderer that will be used to generate output

preselect - highlight/preselect the first item in the autocomplete list automatically

AutoCompleteBehavior

public AutoCompleteBehavior(IAutoCompleteRenderer<T> renderer,
                            AutoCompleteSettings settings)

Constructor

Parameters:

renderer - renderer that will be used to generate output

settings - settings for the autocomplete list

Method Detail

onRequest

protected final void onRequest(String val,
                               RequestCycle requestCycle)

Description copied from class: AbstractAutoCompleteBehavior

Callback for the ajax event generated by the javascript. This is where we need to generate our response.

Specified by:

onRequest in class AbstractAutoCompleteBehavior

Parameters:

val - the input entered so far

requestCycle - current request cycle

getChoices

protected abstract Iterator<T> getChoices(String input)

Callback method that should return an iterator over all possible choice objects. These objects will be passed to the renderer to generate output. Usually it is enough to return an iterator over strings.

Parameters:

input - current input

Returns:

iterator over all possible choice objects