public abstract class

SuggestOracle

extends Object
java.lang.Object
   ↳ com.google.gwt.user.client.ui.SuggestOracle
Known Direct Subclasses

Class Overview

A SuggestOracle can be used to create suggestions associated with a specific query string. It is currently used by SuggestBox.

See Also

Summary

Nested Classes
interface SuggestOracle.Callback Callback for SuggestOracle. 
class SuggestOracle.Request A SuggestOracle request. 
class SuggestOracle.Response SuggestOracle response. 
interface SuggestOracle.Suggestion Suggestion supplied by the SuggestOracle. 
Public Constructors
SuggestOracle()
Constructor for SuggestOracle.
Public Methods
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.
abstract void requestSuggestions(SuggestOracle.Request request, SuggestOracle.Callback callback)
Generate a SuggestOracle.Response based on a specific SuggestOracle.Request.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SuggestOracle ()

Constructor for SuggestOracle.

Public Methods

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 abstract 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