org.got5.tapestry5.jquery.mixins

Class Autocomplete

java.lang.Object

org.got5.tapestry5.jquery.mixins.Autocomplete

@Events(value="provideCompletions")
public class Autocomplete
extends Object

A mixin for a text field that allows for autocompletion of text fields. This is based on Prototype's autocompleter control.

The mixin renders an (initially invisible) progress indicator after the field (it will also be after the error icon most fields render). The progress indicator is made visible during the request to the server. The mixin then renders a <div> that will be filled in on the client side with dynamically obtained selections.

Multiple selection on the client is enabled by binding the tokens parameter (however, the mixin doesn't help split multiple selections up on the server, that is still your code's responsibility).

The container is responsible for providing an event handler for event "providecompletions". The context will be the partial input string sent from the client. The return value should be an array or list of completions, in presentation order. I.e.

 String[] onProvideCompletionsFromMyField(String input)
 {
   return . . .;
 }
 

See Also:

jQuery UI Official Documentation

Constructor Summary

Constructors

Constructor and Description
Autocomplete()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure(org.apache.tapestry5.json.JSONObject config)
protected org.apache.tapestry5.json.JSONArray	generateResponseJSON(List matches) Transforms the matches into a JSONArray

Methods inherited from class java.lang.Object

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

Constructor Detail

Autocomplete

public Autocomplete()

Method Detail

configure

protected void configure(org.apache.tapestry5.json.JSONObject config)

Parameters:

config - parameters object

generateResponseJSON

protected org.apache.tapestry5.json.JSONArray generateResponseJSON(List matches)

Transforms the matches into a JSONArray

Returns:

JSONArray of available responses