io.jmix.ui.widget

Class JmixAbstractSuggestionField<V,I>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<V>

io.jmix.ui.widget.JmixAbstractSuggestionField<V,I>

Type Parameters:

V - type of value

I - type of item

All Implemented Interfaces:

com.vaadin.data.HasValue<V>, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, java.io.Serializable

Direct Known Subclasses:

JmixSuggestionField, JmixTagField

public abstract class JmixAbstractSuggestionField<V,I>
extends com.vaadin.ui.AbstractField<V>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

com.vaadin.data.HasValue.ValueChangeEvent<V>, com.vaadin.data.HasValue.ValueChangeListener<V>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<java.lang.String>	arrowDownActionHandler
protected java.lang.Runnable	cancelSearchHandler
protected java.util.function.Consumer<java.lang.String>	enterActionHandler
protected com.vaadin.event.FieldEvents.FocusAndBlurServerRpcImpl	focusBlurRpc
protected V	internalValue
protected com.vaadin.server.KeyMapper<I>	keyMapper
protected java.util.function.Function<java.lang.Object,java.lang.String>	optionsStyleProvider
protected java.util.function.Consumer<java.lang.String>	searchExecutor
protected JmixSuggestionFieldServerRpc	serverRpc
protected static java.lang.String	SUGGESTION_CAPTION
protected static java.lang.String	SUGGESTION_ID
protected static java.lang.String	SUGGESTION_STYLE_NAME
protected int	suggestionsLimit
protected java.util.function.Function<I,java.lang.String>	textViewConverter

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
JmixAbstractSuggestionField()

Method Summary

Modifier and Type	Method and Description
void	addPopupStyleName(java.lang.String styleName)
protected void	doSetValue(V value)
java.util.function.Consumer<java.lang.String>	getArrowDownActionHandler()
int	getAsyncSearchDelayMs()
java.util.function.Consumer<java.lang.String>	getEnterActionHandler()
java.lang.String	getInputPrompt()
int	getMinSearchStringLength()
java.lang.String	getPopupWidth()
protected JmixSuggestionFieldState	getState()
protected JmixSuggestionFieldState	getState(boolean markAsDirty)
int	getSuggestionsLimit()
V	getValue()
protected boolean	isPredefinedPopupWidth(java.lang.String popupWidth)
boolean	isSelectFirstSuggestionOnShow()
protected abstract void	onSelectSuggestion(java.lang.String suggestionId)
void	removePopupStyleName(java.lang.String styleName)
void	setArrowDownActionHandler(java.util.function.Consumer<java.lang.String> arrowDownActionHandler)
void	setAsyncSearchDelayMs(int asyncSearchDelayMs)
void	setCancelSearchHandler(java.lang.Runnable cancelSearchHandler)
void	setEnterActionHandler(java.util.function.Consumer<java.lang.String> enterActionHandler)
void	setInputPrompt(java.lang.String inputPrompt)
void	setMinSearchStringLength(int minSearchStringLength)
void	setOptionsStyleProvider(java.util.function.Function<java.lang.Object,java.lang.String> optionsStyleProvider)
void	setPopupStyleName(java.lang.String styleName)
void	setPopupWidth(java.lang.String popupWidth)
void	setSearchExecutor(java.util.function.Consumer<java.lang.String> searchExecutor)
void	setSelectFirstSuggestionOnShow(boolean selectFirstSuggestionOnShow)
void	setSuggestionsLimit(int suggestionsLimit)
void	setTextViewConverter(java.util.function.Function<I,java.lang.String> converter)
void	showSuggestions(java.util.List<I> suggestions, boolean userOriginated)

Methods inherited from class com.vaadin.ui.AbstractField

addValueChangeListener, createValueChange, focus, getCustomAttributes, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, readDesign, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue, setValue, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setRequiredError, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getIncorrectConcurrentAccessHandler, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setConnectorResource, setErrorHandler, setIncorrectConcurrentAccessHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getEmptyValue, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Field Detail

SUGGESTION_ID

protected static final java.lang.String SUGGESTION_ID

See Also:

Constant Field Values

SUGGESTION_CAPTION

protected static final java.lang.String SUGGESTION_CAPTION

See Also:

Constant Field Values

SUGGESTION_STYLE_NAME

protected static final java.lang.String SUGGESTION_STYLE_NAME

See Also:

Constant Field Values

textViewConverter

protected java.util.function.Function<I,java.lang.String> textViewConverter

searchExecutor

protected java.util.function.Consumer<java.lang.String> searchExecutor

enterActionHandler

protected java.util.function.Consumer<java.lang.String> enterActionHandler

arrowDownActionHandler

protected java.util.function.Consumer<java.lang.String> arrowDownActionHandler

cancelSearchHandler

protected java.lang.Runnable cancelSearchHandler

keyMapper

protected com.vaadin.server.KeyMapper<I> keyMapper

focusBlurRpc

protected com.vaadin.event.FieldEvents.FocusAndBlurServerRpcImpl focusBlurRpc

serverRpc

protected JmixSuggestionFieldServerRpc serverRpc

suggestionsLimit

protected int suggestionsLimit

optionsStyleProvider

protected java.util.function.Function<java.lang.Object,java.lang.String> optionsStyleProvider

internalValue

protected V internalValue

Constructor Detail

JmixAbstractSuggestionField

public JmixAbstractSuggestionField()

Method Detail

doSetValue

protected void doSetValue(V value)

Specified by:

doSetValue in class com.vaadin.ui.AbstractField<V>

getValue

@Nullable
public V getValue()

setTextViewConverter

public void setTextViewConverter(java.util.function.Function<I,java.lang.String> converter)

getAsyncSearchDelayMs

public int getAsyncSearchDelayMs()

setAsyncSearchDelayMs

public void setAsyncSearchDelayMs(int asyncSearchDelayMs)

getEnterActionHandler

@Nullable
public java.util.function.Consumer<java.lang.String> getEnterActionHandler()

setEnterActionHandler

public void setEnterActionHandler(@Nullable
                                  java.util.function.Consumer<java.lang.String> enterActionHandler)

getArrowDownActionHandler

@Nullable
public java.util.function.Consumer<java.lang.String> getArrowDownActionHandler()

setArrowDownActionHandler

public void setArrowDownActionHandler(@Nullable
                                      java.util.function.Consumer<java.lang.String> arrowDownActionHandler)

getMinSearchStringLength

public int getMinSearchStringLength()

setMinSearchStringLength

public void setMinSearchStringLength(int minSearchStringLength)

setSearchExecutor

public void setSearchExecutor(java.util.function.Consumer<java.lang.String> searchExecutor)

showSuggestions

public void showSuggestions(java.util.List<I> suggestions,
                            boolean userOriginated)

setCancelSearchHandler

public void setCancelSearchHandler(java.lang.Runnable cancelSearchHandler)

getState

protected JmixSuggestionFieldState getState()

Overrides:

getState in class com.vaadin.ui.AbstractField<V>

getState

protected JmixSuggestionFieldState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.ui.AbstractField<V>

setSuggestionsLimit

public void setSuggestionsLimit(int suggestionsLimit)

getSuggestionsLimit

public int getSuggestionsLimit()

getInputPrompt

@Nullable
public java.lang.String getInputPrompt()

setInputPrompt

public void setInputPrompt(@Nullable
                           java.lang.String inputPrompt)

setPopupStyleName

public void setPopupStyleName(@Nullable
                              java.lang.String styleName)

addPopupStyleName

public void addPopupStyleName(java.lang.String styleName)

removePopupStyleName

public void removePopupStyleName(java.lang.String styleName)

setPopupWidth

public void setPopupWidth(@Nullable
                          java.lang.String popupWidth)

isSelectFirstSuggestionOnShow

public boolean isSelectFirstSuggestionOnShow()

setSelectFirstSuggestionOnShow

public void setSelectFirstSuggestionOnShow(boolean selectFirstSuggestionOnShow)

isPredefinedPopupWidth

protected boolean isPredefinedPopupWidth(java.lang.String popupWidth)

getPopupWidth

public java.lang.String getPopupWidth()

setOptionsStyleProvider

public void setOptionsStyleProvider(@Nullable
                                    java.util.function.Function<java.lang.Object,java.lang.String> optionsStyleProvider)

onSelectSuggestion

protected abstract void onSelectSuggestion(java.lang.String suggestionId)