Module org.apache.wicket.extensions
Class AutoCompleteBehavior<T>
java.lang.Object
org.apache.wicket.behavior.Behavior
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
,IComponentAwareEventSink
,IRequestListener
,IComponentAwareHeaderContributor
,IClusterable
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:
-
Field Summary
Fields inherited from class org.apache.wicket.extensions.ajax.markup.html.autocomplete.AbstractAutoCompleteBehavior
AUTOCOMPLETE_JS, settings
Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior
INDICATOR
-
Constructor Summary
ConstructorDescriptionAutoCompleteBehavior
(IAutoCompleteRenderer<T> renderer) ConstructorAutoCompleteBehavior
(IAutoCompleteRenderer<T> renderer, boolean preselect) ConstructorAutoCompleteBehavior
(IAutoCompleteRenderer<T> renderer, AutoCompleteSettings settings) Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
Allows the behavior to detach any state it has attached during request processing.getChoices
(String input) Callback method that should return an iterator over all possible choice objects.protected void
onBind()
Subclasses should call super.onBind()protected final 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, renderHead, respond, updateAjaxAttributes
Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior
findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, onMethodMismatch, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes
Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior
afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind
Methods inherited from class org.apache.wicket.behavior.Behavior
beforeRender, canCallListener, getStatelessHint, isEnabled, isTemporary, onAttribute, onConfigure, onEvent, onException, onRemove, onTag
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.wicket.IRequestListener
rendersPage
-
Constructor Details
-
AutoCompleteBehavior
Constructor- Parameters:
renderer
- renderer that will be used to generate output
-
AutoCompleteBehavior
Constructor- Parameters:
renderer
- renderer that will be used to generate outputpreselect
- highlight/preselect the first item in the autocomplete list automatically
-
AutoCompleteBehavior
Constructor- Parameters:
renderer
- renderer that will be used to generate outputsettings
- settings for the autocomplete list
-
-
Method Details
-
onBind
Description copied from class:AbstractDefaultAjaxBehavior
Subclasses should call super.onBind()- Overrides:
onBind
in classAbstractDefaultAjaxBehavior
- See Also:
-
onRequest
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 classAbstractAutoCompleteBehavior
- Parameters:
val
- the input entered so farrequestCycle
- current request cycle
-
getChoices
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
-
detach
Description copied from class:Behavior
Allows the behavior to detach any state it has attached during request processing.
-