Package 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, Serializable
Direct Known Subclasses:
JmixSuggestionField, JmixTagField
public abstract class JmixAbstractSuggestionField<V,I> extends com.vaadin.ui.AbstractField<V>
See Also:

  • 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.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.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.ui.Component.HasContextHelp

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

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

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

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

    com.vaadin.server.Sizeable.Unit

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Consumer<String>
    arrowDownActionHandler
     
    protected Runnable
    cancelSearchHandler
     
    protected Consumer<String>
    enterActionHandler
     
    protected com.vaadin.event.FieldEvents.FocusAndBlurServerRpcImpl
    focusBlurRpc
     
    protected V
    internalValue
     
    protected com.vaadin.server.KeyMapper<I>
    keyMapper
     
    protected Function<Object,String>
    optionsStyleProvider
     
    protected Consumer<String>
    searchExecutor
     
    protected JmixSuggestionFieldServerRpc
    serverRpc
     
    protected static final String
    SUGGESTION_CAPTION
     
    protected static final String
    SUGGESTION_ID
     
    protected static final String
    SUGGESTION_STYLE_NAME
     
    protected int
    suggestionsLimit
     
    protected Function<I,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
    Description
    JmixAbstractSuggestionField()
     

  • Method Summary

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

    getConnectorId

    Methods inherited from interface com.vaadin.data.HasValue

    clear, getDefaultValidator, getEmptyValue, getOptionalValue, isEmpty

    Methods inherited from interface com.vaadin.server.Sizeable

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

  • Field Details

    • SUGGESTION_ID

      protected static final String SUGGESTION_ID
      See Also:

    • SUGGESTION_CAPTION

      protected static final String SUGGESTION_CAPTION
      See Also:

    • SUGGESTION_STYLE_NAME

      protected static final String SUGGESTION_STYLE_NAME
      See Also:

    • textViewConverter

      protected Function<I,String> textViewConverter

    • searchExecutor

      protected Consumer<String> searchExecutor

    • enterActionHandler

      protected Consumer<String> enterActionHandler

    • arrowDownActionHandler

      protected Consumer<String> arrowDownActionHandler

    • cancelSearchHandler

      protected 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 Function<Object,String> optionsStyleProvider

    • internalValue

      protected V internalValue

  • Constructor Details

    • JmixAbstractSuggestionField

      public JmixAbstractSuggestionField()

  • Method Details

    • 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(Function<I,String> converter)

    • getAsyncSearchDelayMs

      public int getAsyncSearchDelayMs()

    • setAsyncSearchDelayMs

      public void setAsyncSearchDelayMs(int asyncSearchDelayMs)

    • getEnterActionHandler

      @Nullable public Consumer<String> getEnterActionHandler()

    • setEnterActionHandler

      public void setEnterActionHandler(@Nullable Consumer<String> enterActionHandler)

    • getArrowDownActionHandler

      @Nullable public Consumer<String> getArrowDownActionHandler()

    • setArrowDownActionHandler

      public void setArrowDownActionHandler(@Nullable Consumer<String> arrowDownActionHandler)

    • getMinSearchStringLength

      public int getMinSearchStringLength()

    • setMinSearchStringLength

      public void setMinSearchStringLength(int minSearchStringLength)

    • setSearchExecutor

      public void setSearchExecutor(Consumer<String> searchExecutor)

    • showSuggestions

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

    • setCancelSearchHandler

      public void setCancelSearchHandler(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 String getInputPrompt()

    • setInputPrompt

      public void setInputPrompt(@Nullable String inputPrompt)

    • setPopupStyleName

      public void setPopupStyleName(@Nullable String styleName)

    • addPopupStyleName

      public void addPopupStyleName(String styleName)

    • removePopupStyleName

      public void removePopupStyleName(String styleName)

    • setPopupWidth

      public void setPopupWidth(@Nullable String popupWidth)

    • isSelectFirstSuggestionOnShow

      public boolean isSelectFirstSuggestionOnShow()

    • setSelectFirstSuggestionOnShow

      public void setSelectFirstSuggestionOnShow(boolean selectFirstSuggestionOnShow)

    • isPredefinedPopupWidth

      protected boolean isPredefinedPopupWidth(String popupWidth)

    • getPopupWidth

      public String getPopupWidth()

    • setOptionsStyleProvider

      public void setOptionsStyleProvider(@Nullable Function<Object,String> optionsStyleProvider)

    • onSelectSuggestion

      protected abstract void onSelectSuggestion(String suggestionId)