Package io.jmix.ui.widget.client.suggestionfield

Class JmixSuggestionFieldWidget

java.lang.Object

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

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

com.google.gwt.user.client.ui.Composite

io.jmix.ui.widget.client.suggestionfield.JmixSuggestionFieldWidget

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<JmixSuggestionFieldWidget.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.HasEnabled, 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:

JmixTagFieldWidget

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JmixSuggestionFieldWidget.JmixTextFieldEvents
class	JmixSuggestionFieldWidget.Suggestion
protected class	JmixSuggestionFieldWidget.SuggestionPopup
protected class	JmixSuggestionFieldWidget.SuggestionTimer

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
Consumer<String>	arrowDownActionHandler
protected int	asyncSearchDelayMs
Runnable	cancelSearchHandler
Consumer<String>	enterActionHandler
protected boolean	focused
boolean	iePreventBlur
protected int	minSearchStringLength
protected static final String	MODIFIED_STYLENAME
protected String	popupStylename
protected String	popupWidth
protected String	prevQuery
Consumer<String>	searchExecutor
protected boolean	selectFirstSuggestionOnShow
protected static final String	SUGGESTION_CAPTION
protected static final String	SUGGESTION_ID
protected static final String	SUGGESTION_STYLE_NAME
protected List<JmixSuggestionFieldWidget.Suggestion>	suggestions
protected final SuggestionsContainer	suggestionsContainer
Consumer<JmixSuggestionFieldWidget.Suggestion>	suggestionSelectedHandler
protected final JmixSuggestionFieldWidget.SuggestionPopup	suggestionsPopup
protected JmixSuggestionFieldWidget.SuggestionTimer	suggestionTimer
protected final com.vaadin.client.ui.VTextField	textField
protected static final String	V_FILTERSELECT_SUGGESTPOPUP
protected String	value

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
JmixSuggestionFieldWidget()

Method Summary

Modifier and Type	Method	Description
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<JmixSuggestionFieldWidget.Suggestion> handler)
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
protected void	cancelSearch()
protected JmixSuggestionFieldWidget.SuggestionPopup	createSuggestionPopup(SuggestionsContainer suggestionsContainer)
protected void	disableAutocompletion()
protected static double	getMarginBorderPaddingWidth(com.google.gwt.dom.client.Element element)
int	getTabIndex()
String	getValue()
protected void	handleArrowDownKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)
protected void	handleArrowUpKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)
protected void	handleEnterKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)
protected void	handleEscKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)
protected void	handleOnBlur(com.google.gwt.event.dom.client.BlurEvent event)
protected void	handleOnFocus(com.google.gwt.event.dom.client.FocusEvent event)
protected void	initTextField()
protected boolean	isActive()
boolean	isEnabled()
boolean	isFocused()
boolean	isReadonly()
boolean	isSelectFirstSuggestionOnShow()
protected void	preventEvent(com.google.gwt.event.dom.client.KeyCodeEvent event)
protected void	resetComponentState()
protected void	scheduleQuery(String query)
protected void	searchSuggestions(String query)
protected void	selectSuggestion()
protected void	selectSuggestion(JmixSuggestionFieldWidget.Suggestion newSuggestion)
void	setAccessKey(char key)
protected void	setAsyncSearchDelayMs(int asyncSearchDelayMs)
void	setEnabled(boolean enabled)
void	setFocus(boolean focused)
void	setInputPrompt(String inputPrompt)
protected void	setMinSearchStringLength(int minSearchStringLength)
void	setPopupStyleName(List<String> styleName)
void	setPopupWidth(String popupWidth)
void	setReadonly(boolean readonly)
void	setSelectFirstSuggestionOnShow(boolean selectFirstSuggestionOnShow)
void	setTabIndex(int index)
protected void	setupComposition()
void	setValue(String newValue)
void	setValue(String value, boolean fireEvents)
protected void	showSuggestions(boolean userOriginated)
protected void	showSuggestions(elemental.json.JsonArray suggestions, boolean userOriginated)

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, onEnsureDebugId, 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.event.shared.HasHandlers

fireEvent

Field Details

V_FILTERSELECT_SUGGESTPOPUP

protected static final String V_FILTERSELECT_SUGGESTPOPUP

See Also:

• Constant Field Values

MODIFIED_STYLENAME

protected static final String MODIFIED_STYLENAME

See Also:

• Constant Field Values

SUGGESTION_CAPTION

protected static final String SUGGESTION_CAPTION

See Also:

• Constant Field Values

SUGGESTION_ID

protected static final String SUGGESTION_ID

See Also:

• Constant Field Values

SUGGESTION_STYLE_NAME

protected static final String SUGGESTION_STYLE_NAME

See Also:

• Constant Field Values

asyncSearchDelayMs

protected int asyncSearchDelayMs

minSearchStringLength

protected int minSearchStringLength

textField

protected final com.vaadin.client.ui.VTextField textField

suggestionsPopup

protected final JmixSuggestionFieldWidget.SuggestionPopup suggestionsPopup

suggestionsContainer

protected final SuggestionsContainer suggestionsContainer

suggestionTimer

protected JmixSuggestionFieldWidget.SuggestionTimer suggestionTimer

searchExecutor

public Consumer<String> searchExecutor

arrowDownActionHandler

public Consumer<String> arrowDownActionHandler

enterActionHandler

public Consumer<String> enterActionHandler

suggestionSelectedHandler

public Consumer<JmixSuggestionFieldWidget.Suggestion> suggestionSelectedHandler

cancelSearchHandler

public Runnable cancelSearchHandler

value

protected String value

prevQuery

protected String prevQuery

iePreventBlur

public boolean iePreventBlur

suggestions

protected List<JmixSuggestionFieldWidget.Suggestion> suggestions

popupStylename

protected String popupStylename

popupWidth

protected String popupWidth

focused

protected boolean focused

selectFirstSuggestionOnShow

protected boolean selectFirstSuggestionOnShow

Constructor Details

JmixSuggestionFieldWidget

public JmixSuggestionFieldWidget()

Method Details

setupComposition

protected void setupComposition()

initTextField

protected void initTextField()

createSuggestionPopup

protected JmixSuggestionFieldWidget.SuggestionPopup createSuggestionPopup(SuggestionsContainer suggestionsContainer)

disableAutocompletion

protected void disableAutocompletion()

setAsyncSearchDelayMs

protected void setAsyncSearchDelayMs(int asyncSearchDelayMs)

setMinSearchStringLength

protected void setMinSearchStringLength(int minSearchStringLength)

showSuggestions

protected void showSuggestions(elemental.json.JsonArray suggestions,
 boolean userOriginated)

showSuggestions

protected void showSuggestions(boolean userOriginated)

isSelectFirstSuggestionOnShow

public boolean isSelectFirstSuggestionOnShow()

setSelectFirstSuggestionOnShow

public void setSelectFirstSuggestionOnShow(boolean selectFirstSuggestionOnShow)

scheduleQuery

protected void scheduleQuery(String query)

selectSuggestion

protected void selectSuggestion()

selectSuggestion

protected void selectSuggestion(JmixSuggestionFieldWidget.Suggestion newSuggestion)

searchSuggestions

protected void searchSuggestions(String query)

isFocused

public boolean isFocused()

getTabIndex

public int getTabIndex()

Specified by:

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

setTabIndex

public void setTabIndex(int index)

Specified by:

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

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Specified by:

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

isReadonly

public boolean isReadonly()

setReadonly

public void setReadonly(boolean readonly)

cancelSearch

protected void cancelSearch()

resetComponentState

protected void resetComponentState()

setAccessKey

public void setAccessKey(char key)

Specified by:

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

setFocus

public void setFocus(boolean focused)

Specified by:

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

setValue

public void setValue(String newValue)

Specified by:

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

Specified by:

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

setValue

public void setValue(String value,
 boolean fireEvents)

Specified by:

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

getValue

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

handleEnterKeyPressed

protected void handleEnterKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)

handleArrowUpKeyPressed

protected void handleArrowUpKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)

handleArrowDownKeyPressed

protected void handleArrowDownKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)

isActive

protected boolean isActive()

handleOnBlur

protected void handleOnBlur(com.google.gwt.event.dom.client.BlurEvent event)

handleOnFocus

protected void handleOnFocus(com.google.gwt.event.dom.client.FocusEvent event)

handleEscKeyPressed

protected void handleEscKeyPressed(com.google.gwt.event.dom.client.KeyCodeEvent event)

preventEvent

protected void preventEvent(com.google.gwt.event.dom.client.KeyCodeEvent event)

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

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>

addSelectionHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<JmixSuggestionFieldWidget.Suggestion> handler)

Specified by:

addSelectionHandler in interface com.google.gwt.event.logical.shared.HasSelectionHandlers<JmixSuggestionFieldWidget.Suggestion>

setInputPrompt

public void setInputPrompt(String inputPrompt)

setPopupStyleName

public void setPopupStyleName(List<String> styleName)

setPopupWidth

public void setPopupWidth(String popupWidth)

getMarginBorderPaddingWidth

protected static double getMarginBorderPaddingWidth(com.google.gwt.dom.client.Element element)