public class

MultiWordSuggestOracle

extends SuggestOracle
java.lang.Object
   ↳ com.google.gwt.user.client.ui.SuggestOracle
     ↳ com.google.gwt.user.client.ui.MultiWordSuggestOracle

Class Overview

The default SuggestOracle. The default oracle returns potential suggestions based on breaking the query into separate words and looking for matches. It also modifies the returned text to show which prefix matched the query term. The matching is case insensitive. All suggestions are sorted before being passed into a response.

Example Table

All Suggestions Query string Matching Suggestions
John Smith, Joe Brown, Jane Doe, Jane Smith, Bob Jones Jo John Smith, Joe Brown, Bob Jones
John Smith, Joe Brown, Jane Doe, Jane Smith, Bob Jones Smith John Smith, Jane Smith
Georgia, New York, California g Georgia

Summary

Nested Classes
class MultiWordSuggestOracle.MultiWordSuggestion Suggestion class for MultiWordSuggestOracle. 
Public Constructors
MultiWordSuggestOracle()
Constructor for MultiWordSuggestOracle.
MultiWordSuggestOracle(String whitespaceChars)
Constructor for MultiWordSuggestOracle which takes in a set of whitespace chars that filter its input.
Public Methods
void add(String suggestion)
Adds a suggestion to the oracle.
final void addAll(Collection<String> collection)
Adds all suggestions specified.
void clear()
Removes all of the suggestions from the oracle.
boolean isDisplayStringHTML()
Should SuggestOracle.Suggestion display strings be treated as HTML? If true, this all suggestions' display strings will be interpreted as HTML, otherwise as text.
void requestDefaultSuggestions(SuggestOracle.Request request, SuggestOracle.Callback callback)
Generate a SuggestOracle.Response based on a default request.
void requestSuggestions(SuggestOracle.Request request, SuggestOracle.Callback callback)
Generate a SuggestOracle.Response based on a specific SuggestOracle.Request.
void setDefaultSuggestions(Collection<SuggestOracle.Suggestion> suggestionList)
Sets the default suggestion collection.
final void setDefaultSuggestionsFromText(Collection<String> suggestionList)
A convenience method to set default suggestions using plain text strings.
Protected Methods
MultiWordSuggestOracle.MultiWordSuggestion createSuggestion(String replacementString, String displayString)
Creates the suggestion based on the given replacement and display strings.
[Expand]
Inherited Methods
From class com.google.gwt.user.client.ui.SuggestOracle
From class java.lang.Object

Public Constructors

public MultiWordSuggestOracle ()

Constructor for MultiWordSuggestOracle. This uses a space as the whitespace character.

See Also

public MultiWordSuggestOracle (String whitespaceChars)

Constructor for MultiWordSuggestOracle which takes in a set of whitespace chars that filter its input.

Example: If ".," is passed in as whitespace, then the string "foo.bar" would match the queries "foo", "bar", "foo.bar", "foo...bar", and "foo, bar". If the empty string is used, then all characters are used in matching. For example, the query "bar" would match "bar", but not "foo bar".

Parameters
whitespaceChars the characters to treat as word separators

Public Methods

public void add (String suggestion)

Adds a suggestion to the oracle. Each suggestion must be plain text.

Parameters
suggestion the suggestion

public final void addAll (Collection<String> collection)

Adds all suggestions specified. Each suggestion must be plain text.

Parameters
collection the collection

public void clear ()

Removes all of the suggestions from the oracle.

public boolean isDisplayStringHTML ()

Should SuggestOracle.Suggestion display strings be treated as HTML? If true, this all suggestions' display strings will be interpreted as HTML, otherwise as text.

Returns
  • by default, returns false

public void requestDefaultSuggestions (SuggestOracle.Request request, SuggestOracle.Callback callback)

Generate a SuggestOracle.Response based on a default request. The request query must be null as it represents the results the oracle should return based on no query string.

After the SuggestOracle.Response is created, it is passed into onSuggestionsReady(com.google.gwt.user.client.ui.SuggestOracle.Request, com.google.gwt.user.client.ui.SuggestOracle.Response) .

Parameters
request the request
callback the callback to use for the response

public void requestSuggestions (SuggestOracle.Request request, SuggestOracle.Callback callback)

Generate a SuggestOracle.Response based on a specific SuggestOracle.Request. After the SuggestOracle.Response is created, it is passed into onSuggestionsReady(com.google.gwt.user.client.ui.SuggestOracle.Request, com.google.gwt.user.client.ui.SuggestOracle.Response).

Parameters
request the request
callback the callback to use for the response

public void setDefaultSuggestions (Collection<SuggestOracle.Suggestion> suggestionList)

Sets the default suggestion collection.

Parameters
suggestionList the default list of suggestions

public final void setDefaultSuggestionsFromText (Collection<String> suggestionList)

A convenience method to set default suggestions using plain text strings. Note to use this method each default suggestion must be plain text.

Parameters
suggestionList the default list of suggestions

Protected Methods

protected MultiWordSuggestOracle.MultiWordSuggestion createSuggestion (String replacementString, String displayString)

Creates the suggestion based on the given replacement and display strings.

Parameters
replacementString the string to enter into the SuggestBox's text box if the suggestion is chosen
displayString the display string
Returns
  • the suggestion created