org.gwt.advanced.client.ui.widget

Class SuggestionBox

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

org.gwt.advanced.client.ui.widget.TextButtonPanel<String>

org.gwt.advanced.client.ui.widget.ComboBox<SuggestionBoxDataModel>

org.gwt.advanced.client.ui.widget.SuggestionBox

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasChangeHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, ListModelListener, AdvancedWidget

public class SuggestionBox
extends ComboBox<SuggestionBoxDataModel>

This class implements suggestion box logic.

To use it properly you should specify the data model that is instance of the SuggestionBoxDataModel class. Otherwise it will work as a simple combo box.
See also setModel(org.gwt.advanced.client.datamodel.SuggestionBoxDataModel).

Since:

1.2.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SuggestionBox.ExpressionFocusHandler This is a focus listener that starts / cancels the timer.
protected class	SuggestionBox.ExpressionKeyboardHandler This handler is invoked when a user types any text and sets focus
protected class	SuggestionBox.ExpressionTimer This is a timer that displays the list of items.

Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.ComboBox

ComboBox.ComboBoxKeyboardManager, ComboBox.DelegateHandler

Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.TextButtonPanel

TextButtonPanel.EnterAction

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_REQUEST_TIMEOUT default request timeout between last expression change and getting data

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
SuggestionBox() Constructs a new SuggestionBox.
SuggestionBox(int expressionLength) Constructs an instance of this class and allows specifying the minimal length of the expression.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	add(ListModelEvent event) Additionally cleans the list every time when the first item is added.
protected void	addComponentListeners() This method adds component listeners.
void	addSuggestionBoxListener(SuggestionBoxListener listener) Adds a new suggestion box listener that will be invoked on expression change.
protected void	cancelTimer() Immediately cancels the timer if it's run.
void	cleanSelection() Cleans all the data displayed in the widget.
String	getExpression() This method returns an expression entered by a user for drop down list selection.
SuggestionBox.ExpressionFocusHandler	getExpressionFocusHandler() Getter for property 'focusHandler'.
protected SuggestionBox.ExpressionKeyboardHandler	getExpressionKeyboardHandler() Getter for property 'keyboardHandler'.
int	getExpressionLength() Getter for property 'expressionLength'.
SuggestionBoxDataModel	getModel() Getter for property 'model'.
int	getRequestTimeout() Gets a timeout value between last expression change and getting data.
protected List<SuggestionBoxListener>	getSuggestionBoxListeners() Getter for property 'suggestionBoxListeners'.
protected com.google.gwt.user.client.Timer	getTimer() Getter for property 'timer'.
void	onModelEvent(ListModelEvent event) Additionally listens for events produced by the SuggestionBoxDataModel.
void	refreshList() Deprecated. you don't have to invoke this method since the list is updated on data model changes.
void	removeSuggestionBoxListener(SuggestionBoxListener listener) This method removes the suggestion box listener.
void	setExpression(String expression) Sets the expression value and displays it in the text box.
void	setExpressionLength(int expressionLength) Setter for property 'expressionLength'.
void	setModel(SuggestionBoxDataModel model) Setter for property 'model'.
void	setRequestTimeout(int requestTimeout) Sets the request timeout value.
void	showList(boolean prepareList) This method shows the drop down list.

Methods inherited from class org.gwt.advanced.client.ui.widget.ComboBox

addBlurHandler, addChangeHandler, addClickHandler, addCloseHandler, addFocusHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addValueChangeHandler, clean, getDefaultImageName, getDelegateHandler, getDropDownPosition, getHighlightRow, getItem, getItemCount, getItemIndex, getKeyboardManager, getListItemFactory, getListPanel, getSelected, getSelectedId, getSelectedIndex, getSelectedWidget, getStartItemIndex, getText, getValue, getVisibleRows, hideList, isKeyPressed, isLazyRenderingEnabled, isListPanelOpened, moveCursor, prepareSelectedValue, remove, select, select, setDropDownPosition, setFocus, setHighlightRow, setKeyPressed, setLazyRenderingEnabled, setListItemFactory, setListPopupOpened, setSelectedId, setSelectedIndex, setStartItemIndex, setText, setValue, setValue, setVisibleRows

Methods inherited from class org.gwt.advanced.client.ui.widget.TextButtonPanel

display, getChoiceButton, getChoiceButtonImage, getEnterAction, getHeight, getLayout, getLockingPanel, getMaxLength, getSelectedValue, getWidth, isChoiceButtonVisible, isCustomTextAllowed, isEnabled, isLocked, lock, prepareChoiceButton, setChoiceButtonImage, setChoiceButtonVisible, setCustomTextAllowed, setEnabled, setEnterAction, setHeight, setLocked, setMaxLength, setTabIndex, setWidth, unlock

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

DEFAULT_REQUEST_TIMEOUT

public static final int DEFAULT_REQUEST_TIMEOUT

default request timeout between last expression change and getting data

See Also:

Constant Field Values

Constructor Detail

SuggestionBox

public SuggestionBox()

Constructs a new SuggestionBox.

By default the minimal expression length is 3.

SuggestionBox

public SuggestionBox(int expressionLength)

Constructs an instance of this class and allows specifying the minimal length of the expression.

Parameters:

expressionLength - is an expression length.

Method Detail

getExpressionLength

public int getExpressionLength()

Getter for property 'expressionLength'.

Returns:

Value for property 'expressionLength'.

setExpressionLength

public void setExpressionLength(int expressionLength)

Setter for property 'expressionLength'.

Parameters:

expressionLength - Value to set for property 'expressionLength'.

getRequestTimeout

public int getRequestTimeout()

Gets a timeout value between last expression change and getting data.

Returns:

a request timeout value.

setRequestTimeout

public void setRequestTimeout(int requestTimeout)

Sets the request timeout value.

Set it to control how often the widget will request a server for data.

Parameters:

requestTimeout - is a request timeout value in msc.

setModel

public void setModel(SuggestionBoxDataModel model)

Setter for property 'model'.

Overrides:

setModel in class ComboBox<SuggestionBoxDataModel>

Parameters:

model - Value to set for property 'model'.

getModel

public SuggestionBoxDataModel getModel()

Getter for property 'model'.

Overrides:

getModel in class ComboBox<SuggestionBoxDataModel>

Returns:

Value for property 'model'.

addSuggestionBoxListener

public void addSuggestionBoxListener(SuggestionBoxListener listener)

Adds a new suggestion box listener that will be invoked on expression change.

Parameters:

listener - is a listener to be added.

removeSuggestionBoxListener

public void removeSuggestionBoxListener(SuggestionBoxListener listener)

This method removes the suggestion box listener.

Parameters:

listener - a suggestion box listener instance to remove.

getExpression

public String getExpression()

This method returns an expression entered by a user for drop down list selection.

If the associated model is not SuggestionBoxDataModel it retuns null.

Returns:

an expression value.

setExpression

public void setExpression(String expression)

Sets the expression value and displays it in the text box.

Parameters:

expression - is an expression to be applied.

refreshList

public void refreshList()

Deprecated. you don't have to invoke this method since the list is updated on data model changes.

Immediately refreshes the list of values which may match the expression.

Use this method if whant to open the popup list from the ListCallbackHandler implementation and values are NOT cached on a client side.

cleanSelection

public void cleanSelection()

Cleans all the data displayed in the widget.

Overrides:

cleanSelection in class ComboBox<SuggestionBoxDataModel>

onModelEvent

public void onModelEvent(ListModelEvent event)

Additionally listens for events produced by the SuggestionBoxDataModel.

This method should implement actions which related widgets must do on events.

Specified by:

onModelEvent in interface ListModelListener

Overrides:

onModelEvent in class ComboBox<SuggestionBoxDataModel>

Parameters:

event - an event produced by the model.

add

protected void add(ListModelEvent event)

Additionally cleans the list every time when the first item is added.

In other cases works like the same method in the super class.

Overrides:

add in class ComboBox<SuggestionBoxDataModel>

Parameters:

event - is an event containing data about the added item.

addComponentListeners

protected void addComponentListeners()

This method adds component listeners.

Overrides:

addComponentListeners in class ComboBox<SuggestionBoxDataModel>

getSuggestionBoxListeners

protected List<SuggestionBoxListener> getSuggestionBoxListeners()

Getter for property 'suggestionBoxListeners'.

Returns:

Value for property 'suggestionBoxListeners'.

getTimer

protected com.google.gwt.user.client.Timer getTimer()

Getter for property 'timer'.

Returns:

Value for property 'timer'.

getExpressionFocusHandler

public SuggestionBox.ExpressionFocusHandler getExpressionFocusHandler()

Getter for property 'focusHandler'.

Returns:

Value for property 'focusHandler'.

showList

public void showList(boolean prepareList)

This method shows the drop down list.

Overrides:

showList in class ComboBox<SuggestionBoxDataModel>

Parameters:

prepareList - forces the list to be prepared (refreshed) before displaying.

getExpressionKeyboardHandler

protected SuggestionBox.ExpressionKeyboardHandler getExpressionKeyboardHandler()

Getter for property 'keyboardHandler'.

Returns:

Value for property 'keyboardHandler'.

cancelTimer

protected void cancelTimer()

Immediately cancels the timer if it's run.