org.wicketstuff.scriptaculous.autocomplete
Class AjaxAutocompleteBehavior

java.lang.Object
  org.apache.wicket.behavior.AbstractBehavior
      org.apache.wicket.behavior.AbstractAjaxBehavior
          org.apache.wicket.ajax.AbstractDefaultAjaxBehavior
              org.wicketstuff.scriptaculous.ScriptaculousAjaxBehavior
                  org.wicketstuff.scriptaculous.autocomplete.AbstractAutocompleteBehavior
                      org.wicketstuff.scriptaculous.autocomplete.AjaxAutocompleteBehavior

All Implemented Interfaces:

java.io.Serializable, org.apache.wicket.behavior.IBehavior, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IClusterable, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IHeaderContributor

public abstract class AjaxAutocompleteBehavior
extends AbstractAutocompleteBehavior

Ajax autocomplete behavior provides an ajax callback for populating results. The ajax response is formatted as an unordered list of items. ex:

   <ul>
     <li>Red</li>
     <li>Green</li>
     <li>Blue</li>
   </ul>
 

The response can contain non-autocomplete information for display purposes. The results returned can contain additional HTML elements (span, div) marked with a class of informal. These elements will only be used for display and their contents will not be entered into the text field.

When customizing the response to add additional information, users will most likely need to override the AbstractAutocompleteBehavior.getCss() method as well to customize the look and layout.

Author:

Ryan Sonnek

See Also:

http://wiki.script.aculo.us/scriptaculous/show/Ajax.Autocompleter, Serialized Form

Field Summary

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

INDICATOR

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

INTERFACE

Constructor Summary

AjaxAutocompleteBehavior()

Method Summary

protected java.lang.String	getAutocompleteType() subclasses need to declare the scriptaculous autocomplete type.
protected abstract java.lang.String[]	getResults(java.lang.String input) extension point to lookup results for user's input.
protected java.lang.String	getThirdAutocompleteArgument() Subclasses need to define this optional argument.
protected void	respond(org.apache.wicket.ajax.AjaxRequestTarget target)
void	setIndicator(Indicator indicator) set an indicator to be used during ajax calls.

Methods inherited from class org.wicketstuff.scriptaculous.autocomplete.AbstractAutocompleteBehavior

addOption, getCss, onBind, onComponentRendered

Methods inherited from class org.wicketstuff.scriptaculous.ScriptaculousAjaxBehavior

newJavascriptBindingBehavior, renderHead

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, onComponentTag, onComponentTag, onRendered, onRenderHeadContribution, onRenderHeadInitContribution

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxAutocompleteBehavior

public AjaxAutocompleteBehavior()

Method Detail

getAutocompleteType

protected java.lang.String getAutocompleteType()

Description copied from class: AbstractAutocompleteBehavior

subclasses need to declare the scriptaculous autocomplete type.

Specified by:

getAutocompleteType in class AbstractAutocompleteBehavior

Returns:

getThirdAutocompleteArgument

protected java.lang.String getThirdAutocompleteArgument()

Description copied from class: AbstractAutocompleteBehavior

Subclasses need to define this optional argument. each implementation requires a different value.

Specified by:

getThirdAutocompleteArgument in class AbstractAutocompleteBehavior

Returns:

setIndicator

public void setIndicator(Indicator indicator)

set an indicator to be used during ajax calls.

Parameters:

indicator -

respond

protected void respond(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

respond in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

getResults

protected abstract java.lang.String[] getResults(java.lang.String input)

extension point to lookup results for user's input.

Parameters:

input - value currently input by the user

Returns:

results to autocomplete for the user