io.jmix.ui.widget

Class JmixTagField<V>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<V>

io.jmix.ui.widget.JmixAbstractSuggestionField<java.util.Collection<V>,V>

io.jmix.ui.widget.JmixTagField<V>

All Implemented Interfaces:

com.vaadin.data.HasValue<java.util.Collection<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

public class JmixTagField<V>
extends JmixAbstractSuggestionField<java.util.Collection<V>,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 static java.lang.String	TAG_CAPTION_KEY
protected static java.lang.String	TAG_KEY
protected static java.lang.String	TAG_STYLE_KEY
protected java.util.function.Function<? super V,java.lang.String>	tagCaptionProvider
protected java.util.function.Consumer<V>	tagClickHandler
protected java.util.Comparator<? super V>	tagComparator
protected java.util.function.Function<? super V,java.lang.String>	tagStyleProvider
protected com.vaadin.server.KeyMapper<V>	valueKeyMapper

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

arrowDownActionHandler, cancelSearchHandler, enterActionHandler, focusBlurRpc, internalValue, keyMapper, optionsStyleProvider, searchExecutor, serverRpc, SUGGESTION_CAPTION, SUGGESTION_ID, SUGGESTION_STYLE_NAME, suggestionsLimit, 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
JmixTagField()

Method Summary

Modifier and Type	Method and Description
void	clearText()
protected java.util.List<elemental.json.JsonObject>	convertItemsToJson(java.util.Collection<V> value)
protected void	doSetValue(java.util.Collection<V> value)
protected JmixTagFieldState	getState()
protected JmixTagFieldState	getState(boolean markAsDirty)
java.util.function.Function<? super V,java.lang.String>	getTagCaptionProvider()
java.util.function.Consumer<V>	getTagClickHandler()
java.util.Comparator<? super V>	getTagComparator()
protected elemental.json.JsonObject	getTagJson(V item)
java.util.function.Function<? super V,java.lang.String>	getTagStyleProvider()
boolean	isClearAllVisible()
protected void	onSelectSuggestion(java.lang.String suggestionId)
protected void	onTagClick(java.lang.String tagKey)
protected void	onTagRemove(java.lang.String tagKey)
protected void	refreshTags(java.util.Collection<V> value)
void	setClearAllVisible(boolean visible)
void	setTagCaptionProvider(java.util.function.Function<? super V,java.lang.String> tagCaptionProvider)
void	setTagClickHandler(java.util.function.Consumer<V> tagClickHandler)
void	setTagComparator(java.util.Comparator<? super V> tagComparator)
void	setTagStyleProvider(java.util.function.Function<? super V,java.lang.String> tagStyleProvider)

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

addPopupStyleName, getArrowDownActionHandler, getAsyncSearchDelayMs, getEnterActionHandler, getInputPrompt, getMinSearchStringLength, getPopupWidth, getSuggestionsLimit, getValue, isPredefinedPopupWidth, isSelectFirstSuggestionOnShow, removePopupStyleName, setArrowDownActionHandler, setAsyncSearchDelayMs, setCancelSearchHandler, setEnterActionHandler, setInputPrompt, setMinSearchStringLength, setOptionsStyleProvider, setPopupStyleName, setPopupWidth, setSearchExecutor, setSelectFirstSuggestionOnShow, setSuggestionsLimit, setTextViewConverter, showSuggestions

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

TAG_CAPTION_KEY

protected static final java.lang.String TAG_CAPTION_KEY

See Also:

Constant Field Values

TAG_STYLE_KEY

protected static final java.lang.String TAG_STYLE_KEY

See Also:

Constant Field Values

TAG_KEY

protected static final java.lang.String TAG_KEY

See Also:

Constant Field Values

valueKeyMapper

protected final com.vaadin.server.KeyMapper<V> valueKeyMapper

tagStyleProvider

protected java.util.function.Function<? super V,java.lang.String> tagStyleProvider

tagCaptionProvider

protected java.util.function.Function<? super V,java.lang.String> tagCaptionProvider

tagComparator

protected java.util.Comparator<? super V> tagComparator

tagClickHandler

protected java.util.function.Consumer<V> tagClickHandler

Constructor Detail

JmixTagField

public JmixTagField()

Method Detail

getTagStyleProvider

public java.util.function.Function<? super V,java.lang.String> getTagStyleProvider()

setTagStyleProvider

public void setTagStyleProvider(@Nullable
                                java.util.function.Function<? super V,java.lang.String> tagStyleProvider)

getTagCaptionProvider

@Nullable
public java.util.function.Function<? super V,java.lang.String> getTagCaptionProvider()

setTagCaptionProvider

public void setTagCaptionProvider(@Nullable
                                  java.util.function.Function<? super V,java.lang.String> tagCaptionProvider)

getTagComparator

@Nullable
public java.util.Comparator<? super V> getTagComparator()

setTagComparator

public void setTagComparator(@Nullable
                             java.util.Comparator<? super V> tagComparator)

getTagClickHandler

@Nullable
public java.util.function.Consumer<V> getTagClickHandler()

setTagClickHandler

public void setTagClickHandler(@Nullable
                               java.util.function.Consumer<V> tagClickHandler)

isClearAllVisible

public boolean isClearAllVisible()

setClearAllVisible

public void setClearAllVisible(boolean visible)

clearText

public void clearText()

onSelectSuggestion

protected void onSelectSuggestion(java.lang.String suggestionId)

Specified by:

onSelectSuggestion in class JmixAbstractSuggestionField<java.util.Collection<V>,V>

doSetValue

protected void doSetValue(java.util.Collection<V> value)

Overrides:

doSetValue in class JmixAbstractSuggestionField<java.util.Collection<V>,V>

getState

protected JmixTagFieldState getState()

Overrides:

getState in class JmixAbstractSuggestionField<java.util.Collection<V>,V>

getState

protected JmixTagFieldState getState(boolean markAsDirty)

Overrides:

getState in class JmixAbstractSuggestionField<java.util.Collection<V>,V>

convertItemsToJson

protected java.util.List<elemental.json.JsonObject> convertItemsToJson(@Nullable
                                                                       java.util.Collection<V> value)

getTagJson

protected elemental.json.JsonObject getTagJson(V item)

onTagClick

protected void onTagClick(java.lang.String tagKey)

onTagRemove

protected void onTagRemove(java.lang.String tagKey)

refreshTags

protected void refreshTags(@Nullable
                           java.util.Collection<V> value)