io.jmix.ui.widget

Class JmixSuggestionPickerField<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<T>

com.vaadin.ui.CustomField<T>

io.jmix.ui.widget.JmixPickerField<T>

io.jmix.ui.widget.JmixSuggestionPickerField<T>

All Implemented Interfaces:

com.vaadin.data.HasValue<T>, com.vaadin.event.Action.Container, 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, com.vaadin.ui.HasComponents, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>

public class JmixSuggestionPickerField<T>
extends JmixPickerField<T>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.widget.JmixPickerField

JmixPickerField.FieldValueChangeEvent<V>, JmixPickerField.FieldValueChangeListener<V>

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

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

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.data.HasValue

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

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 static java.lang.String	SUGGESTION_FIELD_STYLENAME
protected static java.lang.String	SUGGESTION_PICKERFIELD_STYLENAME

Fields inherited from class io.jmix.ui.widget.JmixPickerField

BUTTON_STYLENAME, buttons, container, field, fieldReadOnly, fieldValueChangeListener, iconGenerator, inputWrapper, internalValue, LAYOUT_STYLENAME, PRIMARY_STYLENAME, suppressTextChangeListener, TEXT_FIELD_STYLENAME, textFieldValueProvider

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
JmixSuggestionPickerField()

Method Summary

Modifier and Type	Method and Description
void	addPopupStyleName(java.lang.String styleName)
com.vaadin.shared.Registration	addValueChangeListener(com.vaadin.data.HasValue.ValueChangeListener<T> listener)
protected void	doSetValue(T value)
java.util.function.Consumer<java.lang.String>	getArrowDownActionHandler()
int	getAsyncSearchDelayMs()
java.util.function.Consumer<java.lang.String>	getEnterActionHandler()
protected JmixSuggestionField<T>	getFieldInternal()
java.lang.String	getInputPrompt()
int	getMinSearchStringLength()
java.lang.String	getPopupWidth()
int	getSuggestionsLimit()
T	getValue()
protected void	init()
protected void	initField()
boolean	isSelectFirstSuggestionOnShow()
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<T,java.lang.String> converter)
void	showSuggestions(java.util.List<T> suggestions, boolean userOriginated)
protected void	updateFieldReadOnlyFocusable()

Methods inherited from class io.jmix.ui.widget.JmixPickerField

addActionHandler, addButton, addFieldListener, attach, focus, getButtons, getEmptyStringRepresentation, getField, getIconGenerator, getStringRepresentation, getTabIndex, getTextFieldValueProvider, initContent, initLayout, isDifferentValue, isEmpty, isFieldReadOnly, onFieldValueChange, removeActionHandler, removeButton, setFieldReadOnly, setHeight, setIconGenerator, setReadOnly, setTabIndex, setTextFieldValueProvider, setWidth, updateFieldReadOnly, updateIcon, updateTextRepresentation

Methods inherited from class com.vaadin.ui.CustomField

getContent, getState, getState, iterator, setFocusDelegate

Methods inherited from class com.vaadin.ui.AbstractField

createValueChange, getCustomAttributes, isReadOnly, isRequiredIndicatorVisible, readDesign, setRequiredIndicatorVisible, setValue, setValue, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, 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, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setRequiredError, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, 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.ui.Component

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

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, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getEmptyValue, getOptionalValue

Field Detail

SUGGESTION_PICKERFIELD_STYLENAME

protected static final java.lang.String SUGGESTION_PICKERFIELD_STYLENAME

See Also:

Constant Field Values

SUGGESTION_FIELD_STYLENAME

protected static final java.lang.String SUGGESTION_FIELD_STYLENAME

See Also:

Constant Field Values

Constructor Detail

JmixSuggestionPickerField

public JmixSuggestionPickerField()

Method Detail

init

protected void init()

Overrides:

init in class JmixPickerField<T>

initField

protected void initField()

Overrides:

initField in class JmixPickerField<T>

getFieldInternal

protected JmixSuggestionField<T> getFieldInternal()

doSetValue

protected void doSetValue(T value)

Overrides:

doSetValue in class JmixPickerField<T>

getValue

public T getValue()

Specified by:

getValue in interface com.vaadin.data.HasValue<T>

Overrides:

getValue in class JmixPickerField<T>

updateFieldReadOnlyFocusable

protected void updateFieldReadOnlyFocusable()

Overrides:

updateFieldReadOnlyFocusable in class JmixPickerField<T>

addValueChangeListener

public com.vaadin.shared.Registration addValueChangeListener(com.vaadin.data.HasValue.ValueChangeListener<T> listener)

Specified by:

addValueChangeListener in interface com.vaadin.data.HasValue<T>

Overrides:

addValueChangeListener in class com.vaadin.ui.AbstractField<T>

setTextViewConverter

public void setTextViewConverter(java.util.function.Function<T,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<T> suggestions,
                            boolean userOriginated)

setCancelSearchHandler

public void setCancelSearchHandler(java.lang.Runnable cancelSearchHandler)

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(java.lang.String popupWidth)

getPopupWidth

public java.lang.String getPopupWidth()

setOptionsStyleProvider

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

isSelectFirstSuggestionOnShow

public boolean isSelectFirstSuggestionOnShow()

setSelectFirstSuggestionOnShow

public void setSelectFirstSuggestionOnShow(boolean selectFirstSuggestionOnShow)