|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
com.google.gwt.user.client.ui.SuggestBox
public final class SuggestBox
A SuggestBox
is a text box or text area which displays a
pre-configured set of selections that match the user's input.
Each SuggestBox
is associated with a single SuggestOracle
.
The SuggestOracle
is used to provide a set of selections given a
specific query string.
By default, the SuggestBox
uses a MultiWordSuggestOracle
as
its oracle. Below we show how a MultiWordSuggestOracle
can be
configured:
MultiWordSuggestOracle oracle = new MultiWordSuggestOracle(); oracle.add("Cat"); oracle.add("Dog"); oracle.add("Horse"); oracle.add("Canary"); SuggestBox box = new SuggestBox(oracle);Using the example above, if the user types "C" into the text widget, the oracle will configure the suggestions with the "Cat" and "Canary" suggestions. Specifically, whenever the user types a key into the text widget, the value is submitted to the
MultiWordSuggestOracle
.
Note that there is no method to retrieve the "currently selected suggestion"
in a SuggestBox, because there are points in time where the currently
selected suggestion is not defined. For example, if the user types in some
text that does not match any of the SuggestBox's suggestions, then the
SuggestBox will not have a currently selected suggestion. It is more useful
to know when a suggestion has been chosen from the SuggestBox's list of
suggestions. A SuggestBox fires
SuggestionEvents
whenever a suggestion is chosen, and
handlers for these events can be added using the
addEventHandler(SuggestionHandler)
method.
SuggestOracle
,
MultiWordSuggestOracle
,
TextBoxBase
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled |
Field Summary |
---|
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
SuggestBox()
Constructor for SuggestBox . |
|
SuggestBox(SuggestOracle oracle)
Constructor for SuggestBox . |
|
SuggestBox(SuggestOracle oracle,
TextBoxBase box)
Constructor for SuggestBox . |
Method Summary | |
---|---|
void |
addChangeListener(ChangeListener listener)
Adds a listener to recieve change events on the SuggestBox's text box. |
void |
addClickListener(ClickListener listener)
Adds a listener to recieve click events on the SuggestBox's text box. |
void |
addEventHandler(SuggestionHandler handler)
Adds a handler interface to receive suggestion events. |
void |
addFocusListener(FocusListener listener)
Adds a listener to recieve focus events on the SuggestBox's text box. |
void |
addKeyboardListener(KeyboardListener listener)
Adds a listener to recieve keyboard events on the SuggestBox's text box. |
int |
getLimit()
Gets the limit for the number of suggestions that should be displayed for this box. |
SuggestOracle |
getSuggestOracle()
Gets the suggest box's SuggestOracle . |
int |
getTabIndex()
Gets the widget's position in the tab index. |
java.lang.String |
getText()
Gets this object's text. |
boolean |
isAnimationEnabled()
|
protected void |
onEnsureDebugId(java.lang.String baseID)
Affected Elements: -popup = The popup that appears with suggestions. -items-item# = The suggested item at the specified index. |
void |
removeChangeListener(ChangeListener listener)
Removes a previously added listener interface. |
void |
removeClickListener(ClickListener listener)
Removes a previously added listener interface. |
void |
removeEventHandler(SuggestionHandler handler)
Removes a previously added handler interface. |
void |
removeFocusListener(FocusListener listener)
Removes a previously added listener interface. |
void |
removeKeyboardListener(KeyboardListener listener)
Removes a previously added listener interface. |
void |
setAccessKey(char key)
Sets the widget's 'access key'. |
void |
setAnimationEnabled(boolean enable)
Enable or disable animations. |
void |
setFocus(boolean focused)
Explicitly focus/unfocus this widget. |
void |
setLimit(int limit)
Sets the limit to the number of suggestions the oracle should provide. |
void |
setPopupStyleName(java.lang.String style)
Sets the style name of the suggestion popup. |
void |
setTabIndex(int index)
Sets the widget's position in the tab index. |
void |
setText(java.lang.String text)
Sets this object's text. |
Methods inherited from class com.google.gwt.user.client.ui.Composite |
---|
getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
doAttachChildren, doDetachChildren, getParent, onLoad, onUnload, removeFromParent |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SuggestBox()
SuggestBox
. Creates a
MultiWordSuggestOracle
and TextBox
to use with this
SuggestBox
.
public SuggestBox(SuggestOracle oracle)
SuggestBox
. Creates a TextBox
to use with
this SuggestBox
.
oracle
- the oracle for this SuggestBox
public SuggestBox(SuggestOracle oracle, TextBoxBase box)
SuggestBox
. The text box will be removed from it's
current location and wrapped by the SuggestBox
.
oracle
- supplies suggestions based upon the current contents of the
text widgetbox
- the text widgetMethod Detail |
---|
public void addChangeListener(ChangeListener listener)
addChangeListener
in interface SourcesChangeEvents
listener
- the listener interface to addpublic void addClickListener(ClickListener listener)
addClickListener
in interface SourcesClickEvents
listener
- the listener interface to addpublic void addEventHandler(SuggestionHandler handler)
FiresSuggestionEvents
addEventHandler
in interface FiresSuggestionEvents
handler
- the handler to addpublic void addFocusListener(FocusListener listener)
addFocusListener
in interface SourcesFocusEvents
listener
- the listener interface to addpublic void addKeyboardListener(KeyboardListener listener)
addKeyboardListener
in interface SourcesKeyboardEvents
listener
- the listener interface to addpublic int getLimit()
SuggestOracle
to enforce this
limit.
public SuggestOracle getSuggestOracle()
SuggestOracle
.
SuggestOracle
public int getTabIndex()
HasFocus
getTabIndex
in interface HasFocus
public java.lang.String getText()
HasText
getText
in interface HasText
public boolean isAnimationEnabled()
isAnimationEnabled
in interface HasAnimation
public void removeChangeListener(ChangeListener listener)
SourcesChangeEvents
removeChangeListener
in interface SourcesChangeEvents
listener
- the listener interface to removepublic void removeClickListener(ClickListener listener)
SourcesClickEvents
removeClickListener
in interface SourcesClickEvents
listener
- the listener interface to removepublic void removeEventHandler(SuggestionHandler handler)
FiresSuggestionEvents
removeEventHandler
in interface FiresSuggestionEvents
handler
- the handler to remove.public void removeFocusListener(FocusListener listener)
SourcesFocusEvents
removeFocusListener
in interface SourcesFocusEvents
listener
- the listener interface to removepublic void removeKeyboardListener(KeyboardListener listener)
SourcesKeyboardEvents
removeKeyboardListener
in interface SourcesKeyboardEvents
listener
- the listener interface to removepublic void setAccessKey(char key)
HasFocus
setAccessKey
in interface HasFocus
key
- the widget's access keypublic void setAnimationEnabled(boolean enable)
HasAnimation
setAnimationEnabled
in interface HasAnimation
enable
- true to enable, false to disablepublic void setFocus(boolean focused)
HasFocus
setFocus
in interface HasFocus
focused
- whether this widget should take focus or release itpublic void setLimit(int limit)
limit
- the limit to the number of suggestions providedpublic void setPopupStyleName(java.lang.String style)
style
- the new primary style nameUIObject.setStyleName(String)
public void setTabIndex(int index)
HasFocus
-1
will cause this widget to
be removed from the tab order.
setTabIndex
in interface HasFocus
index
- the widget's tab indexpublic void setText(java.lang.String text)
HasText
setText
in interface HasText
text
- the object's new textprotected void onEnsureDebugId(java.lang.String baseID)
onEnsureDebugId
in class UIObject
baseID
- the base ID used by the main elementUIObject.onEnsureDebugId(String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |