Package com.google.gwt.user.client.ui

Class AbstractSuggestBoxNewEditor

java.lang.Object

com.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.AbstractSuggestBoxNewEditor

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllKeyHandlers, 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.HasSelectionHandlers<com.google.gwt.user.client.ui.SuggestOracle.Suggestion>, 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.Focusable, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

Direct Known Subclasses:

SuggestBoxNewEditor

public abstract class AbstractSuggestBoxNewEditor
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.event.logical.shared.HasSelectionHandlers<com.google.gwt.user.client.ui.SuggestOracle.Suggestion>

Abstract suggest box implementation based on googles implementation, as binding between new and old world.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay	The default implementation of AbstractSuggestBoxNewEditor.SuggestionDisplay displays suggestions in a PopupPanel beneath the AbstractSuggestBoxNewEditor.
static interface	AbstractSuggestBoxNewEditor.SuggestionCallback	The callback used when a user selects a SuggestOracle.Suggestion.
static class	AbstractSuggestBoxNewEditor.SuggestionDisplay	Used to display suggestions to the user.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected com.google.gwt.user.client.ui.SuggestOracle.Callback	callback
protected String	currentText
protected AbstractSuggestBoxNewEditor.SuggestionDisplay	display
protected int	limit
protected com.google.gwt.user.client.ui.SuggestOracle	oracle
protected boolean	selectsFirstItem
protected static String	STYLENAME_DEFAULT

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSuggestBoxNewEditor(AbstractSuggestBoxNewEditor.SuggestionDisplay display)

Method Summary

Modifier and Type	Method	Description
protected void	addEventsToTextBox()
protected abstract void	addEventsToTextBox(com.google.gwt.event.shared.EventHandler events)
com.google.gwt.event.shared.HandlerRegistration	addKeyDownHandler(com.google.gwt.event.dom.client.KeyDownHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addKeyUpHandler(com.google.gwt.event.dom.client.KeyUpHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<com.google.gwt.user.client.ui.SuggestOracle.Suggestion> handler)
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
protected abstract com.google.gwt.user.client.ui.FocusWidget	getBoxAsFoucsWidget()
int	getLimit()	Gets the limit for the number of suggestions that should be displayed for this box.
AbstractSuggestBoxNewEditor.SuggestionDisplay	getSuggestionDisplay()	Get the AbstractSuggestBoxNewEditor.SuggestionDisplay used to display suggestions.
com.google.gwt.user.client.ui.SuggestOracle	getSuggestOracle()	Gets the suggest box's SuggestOracle.
abstract int	getTabIndex()
abstract String	getText()
abstract String	getValue()
void	hideSuggestionList()	Deprecated. use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.hideSuggestions() instead
boolean	isAnimationEnabled()	Deprecated. use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.isAnimationEnabled() instead
boolean	isAutoSelectEnabled()	Returns whether or not the first suggestion will be automatically selected.
boolean	isSuggestionListShowing()	Check if the AbstractSuggestBoxNewEditor.SuggestionDisplay is showing.
protected void	onEnsureDebugId(String baseID)
void	refreshSuggestionList()	Refreshes the current list of suggestions.
abstract void	setAccessKey(char key)
void	setAnimationEnabled(boolean enable)	Deprecated. use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.setAnimationEnabled(boolean) instead
void	setAutoSelectEnabled(boolean selectsFirstItem)	Turns on or off the behavior that automatically selects the first suggested item.
void	setEnabled(boolean enabled)	Sets whether this widget is enabled.
abstract void	setFocus(boolean focused)
void	setLimit(int limit)	Sets the limit to the number of suggestions the oracle should provide.
protected void	setOracle(com.google.gwt.user.client.ui.SuggestOracle oracle)	Sets the suggestion oracle used to create suggestions.
void	setPopupStyleName(String style)	Deprecated. use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.setPopupStyleName(String) instead
void	showSuggestionList()	Show the current list of suggestions.

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.Focusable

setTabIndex

Methods inherited from interface com.google.gwt.user.client.ui.HasEnabled

isEnabled

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

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.HasText

setText

Methods inherited from interface com.google.gwt.user.client.ui.HasValue

setValue, setValue

Field Detail

STYLENAME_DEFAULT

protected static final String STYLENAME_DEFAULT

See Also:

Constant Field Values

limit

protected int limit

selectsFirstItem

protected boolean selectsFirstItem

oracle

protected com.google.gwt.user.client.ui.SuggestOracle oracle

currentText

protected String currentText

display

protected final AbstractSuggestBoxNewEditor.SuggestionDisplay display

callback

protected final com.google.gwt.user.client.ui.SuggestOracle.Callback callback

Constructor Detail

AbstractSuggestBoxNewEditor

protected AbstractSuggestBoxNewEditor(AbstractSuggestBoxNewEditor.SuggestionDisplay display)

Method Detail

getBoxAsFoucsWidget

protected abstract com.google.gwt.user.client.ui.FocusWidget getBoxAsFoucsWidget()

addKeyDownHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyDownHandler(com.google.gwt.event.dom.client.KeyDownHandler handler)

Specified by:

addKeyDownHandler in interface com.google.gwt.event.dom.client.HasKeyDownHandlers

addKeyPressHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler handler)

Specified by:

addKeyPressHandler in interface com.google.gwt.event.dom.client.HasKeyPressHandlers

addKeyUpHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyUpHandler(com.google.gwt.event.dom.client.KeyUpHandler handler)

Specified by:

addKeyUpHandler in interface com.google.gwt.event.dom.client.HasKeyUpHandlers

addSelectionHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<com.google.gwt.user.client.ui.SuggestOracle.Suggestion> handler)

Specified by:

addSelectionHandler in interface com.google.gwt.event.logical.shared.HasSelectionHandlers<com.google.gwt.user.client.ui.SuggestOracle.Suggestion>

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)

Specified by:

addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>

getLimit

public int getLimit()

Gets the limit for the number of suggestions that should be displayed for this box. It is up to the current SuggestOracle to enforce this limit.

Returns:

the limit for the number of suggestions

getSuggestionDisplay

public AbstractSuggestBoxNewEditor.SuggestionDisplay getSuggestionDisplay()

Get the AbstractSuggestBoxNewEditor.SuggestionDisplay used to display suggestions.

Returns:

the AbstractSuggestBoxNewEditor.SuggestionDisplay

getSuggestOracle

public com.google.gwt.user.client.ui.SuggestOracle getSuggestOracle()

Gets the suggest box's SuggestOracle.

Returns:

the SuggestOracle

getTabIndex

public abstract int getTabIndex()

Specified by:

getTabIndex in interface com.google.gwt.user.client.ui.Focusable

getText

public abstract String getText()

Specified by:

getText in interface com.google.gwt.user.client.ui.HasText

getValue

public abstract String getValue()

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<String>

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<String>

hideSuggestionList

@Deprecated
public void hideSuggestionList()

Deprecated.

use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.hideSuggestions() instead

Hide current suggestions in the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay. Note that this method is a no-op unless the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay is used.

isAnimationEnabled

@Deprecated
public boolean isAnimationEnabled()

Deprecated.

use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.isAnimationEnabled() instead

Check whether or not the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay has animations enabled. Note that this method only has a meaningful return value when the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay is used.

Specified by:

isAnimationEnabled in interface com.google.gwt.user.client.ui.HasAnimation

isAutoSelectEnabled

public boolean isAutoSelectEnabled()

Returns whether or not the first suggestion will be automatically selected. This behavior is on by default.

Returns:

true if the first suggestion will be automatically selected

isSuggestionListShowing

public boolean isSuggestionListShowing()

Check if the AbstractSuggestBoxNewEditor.SuggestionDisplay is showing.

Returns:

true if the list of suggestions is currently showing, false if not

refreshSuggestionList

public void refreshSuggestionList()

Refreshes the current list of suggestions.

setAccessKey

public abstract void setAccessKey(char key)

Specified by:

setAccessKey in interface com.google.gwt.user.client.ui.Focusable

setAnimationEnabled

@Deprecated
public void setAnimationEnabled(boolean enable)

Deprecated.

use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.setAnimationEnabled(boolean) instead

Enable or disable animations in the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay. Note that this method is a no-op unless the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay is used.

Specified by:

setAnimationEnabled in interface com.google.gwt.user.client.ui.HasAnimation

setAutoSelectEnabled

public void setAutoSelectEnabled(boolean selectsFirstItem)

Turns on or off the behavior that automatically selects the first suggested item. This behavior is on by default.

Parameters:

selectsFirstItem - Whether or not to automatically select the first suggestion

setEnabled

public void setEnabled(boolean enabled)

Sets whether this widget is enabled.

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Parameters:

enabled - true to enable the widget, false to disable it

setFocus

public abstract void setFocus(boolean focused)

Specified by:

setFocus in interface com.google.gwt.user.client.ui.Focusable

setLimit

public void setLimit(int limit)

Sets the limit to the number of suggestions the oracle should provide. It is up to the oracle to enforce this limit.

Parameters:

limit - the limit to the number of suggestions provided

setPopupStyleName

@Deprecated
public void setPopupStyleName(String style)

Deprecated.

use AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay.setPopupStyleName(String) instead

Sets the style name of the suggestion popup in the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay. Note that this method is a no-op unless the AbstractSuggestBoxNewEditor.DefaultSuggestionDisplay is used.

Parameters:

style - the new primary style name

See Also:

UIObject.setStyleName(String)

showSuggestionList

public void showSuggestionList()

Show the current list of suggestions.

onEnsureDebugId

protected void onEnsureDebugId(String baseID)

Overrides:

onEnsureDebugId in class com.google.gwt.user.client.ui.UIObject

addEventsToTextBox

protected void addEventsToTextBox()

addEventsToTextBox

protected abstract void addEventsToTextBox(com.google.gwt.event.shared.EventHandler events)

setOracle

protected void setOracle(com.google.gwt.user.client.ui.SuggestOracle oracle)

Sets the suggestion oracle used to create suggestions.

Parameters:

oracle - the oracle