io.jmix.ui.component

Interface TagField<V>

Type Parameters:

V - type of value

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<java.util.Collection<V>>, HasContextHelp, HasEnterPressHandler, HasFormatter<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasOptionStyleProvider<V>, HasValidator<java.util.Collection<V>>, HasValue<java.util.Collection<V>>, HasValueSource<java.util.Collection<V>>, Requirable, SuggestionFieldComponent<java.util.Collection<V>,V>, SupportsUserAction<java.util.Collection<V>>, Validatable

All Known Implementing Classes:

TagFieldImpl

@StudioComponent(caption="TagField",
                 category="Components",
                 xmlElement="tagField",
                 canvasBehaviour=INPUT_FIELD,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/tag-field.html")
public interface TagField<V>
extends SuggestionFieldComponent<java.util.Collection<V>,V>, SupportsUserAction<java.util.Collection<V>>

The field that search and shows selected values as separated tags right in the field.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TagField.NewTagProvider<V> Enables to handle a user's entered text and add it to a TagField value.
static class	TagField.TagClickEvent<V> Describes tag click event.

Nested classes/interfaces inherited from interface io.jmix.ui.component.SuggestionFieldComponent

SuggestionFieldComponent.ArrowDownEvent, SuggestionFieldComponent.ParametrizedSearchExecutor<E>, SuggestionFieldComponent.SearchExecutor<E>

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasEnterPressHandler

HasEnterPressHandler.EnterPressEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.SuggestionFieldComponent

POPUP_AUTO_WIDTH, POPUP_PARENT_WIDTH

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addTagClickListener(java.util.function.Consumer<TagField.TagClickEvent<V>> listener) Sets tag click listener.
java.util.function.Function<? super V,java.lang.String>	getTagCaptionProvider()
java.util.Comparator<? super V>	getTagComparator()
java.util.function.Function<? super V,java.lang.String>	getTagStyleProvider()
boolean	isClearAllVisible()
static <T> org.springframework.core.ParameterizedTypeReference<TagField<T>>	of(java.lang.Class<T> valueClass)
void	setClearAllVisible(boolean visible) Display the button that clears all tags from the field.
void	setSearchExecutor(SuggestionFieldComponent.SearchExecutor<V> searchExecutor) Sets SuggestionFieldComponent.SearchExecutor which performs search.
void	setTagCaptionProvider(java.util.function.Function<? super V,java.lang.String> tagCaptionProvider) Sets tag caption provider.
void	setTagComparator(java.util.Comparator<? super V> tagComparator) Sets comparator for sorting tags in the UI.
void	setTagStyleProvider(java.util.function.Function<? super V,java.lang.String> tagStyleProvider) Sets tag style provider.

Methods inherited from interface io.jmix.ui.component.SuggestionFieldComponent

getArrowDownHandler, getAsyncSearchDelayMs, getMinSearchStringLength, getPopupWidth, getSearchExecutor, getSuggestionsLimit, setArrowDownHandler, setAsyncSearchDelayMs, setMinSearchStringLength, setPopupWidth, setSuggestionsLimit, showSuggestions

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.HasInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface io.jmix.ui.component.HasOptionStyleProvider

getOptionStyleProvider, setOptionStyleProvider

Methods inherited from interface io.jmix.ui.component.HasFormatter

getFormatter, setFormatter

Methods inherited from interface io.jmix.ui.component.HasEnterPressHandler

getEnterPressHandler, setEnterPressHandler

Methods inherited from interface io.jmix.ui.component.SupportsUserAction

setValueFromUser

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

of

static <T> org.springframework.core.ParameterizedTypeReference<TagField<T>> of(java.lang.Class<T> valueClass)

setSearchExecutor

void setSearchExecutor(@Nullable
                       SuggestionFieldComponent.SearchExecutor<V> searchExecutor)

Description copied from interface: SuggestionFieldComponent

Sets SuggestionFieldComponent.SearchExecutor which performs search.

Specified by:

setSearchExecutor in interface SuggestionFieldComponent<java.util.Collection<V>,V>

Parameters:

searchExecutor - SearchExecutor instance

isClearAllVisible

boolean isClearAllVisible()

Returns:

{code true} if clear button is visible

setClearAllVisible

@StudioProperty(name="clearAllVisible",
                defaultValue="false")
void setClearAllVisible(boolean visible)

Display the button that clears all tags from the field. The default value is false.

Parameters:

visible - whether to display clear button

getTagStyleProvider

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

Returns:

tag style provider or null if not set

setTagStyleProvider

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

Sets tag style provider. It is used for generating style name for tag.

For instance:

 @Install(to = "tagField", subject = "tagStyleProvider")
 private String tagFieldTagStyleProvider(User user) {
     switch (user.getAccountType()) {
         case PREMIUM:
             return "user-premium";
         case COMMON:
             return "user-common";
         default:
             return null;
     }
 }
 

Parameters:

tagStyleProvider - tag style provider to set

getTagCaptionProvider

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

Returns:

tag caption provider or null if not set

setTagCaptionProvider

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

Sets tag caption provider. It is used for generating tag caption.

For instance:

 @Install(to = "tagField", subject = "tagCaptionProvider")
 private String tagFieldCaptionProvider(User user) {
     return "User: " + user.getUsername();
 }
 

Parameters:

tagCaptionProvider - caption provider to set

getTagComparator

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

Returns:

tag comparator

setTagComparator

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

Sets comparator for sorting tags in the UI.

Parameters:

tagComparator - comparator to set

addTagClickListener

io.jmix.core.common.event.Subscription addTagClickListener(java.util.function.Consumer<TagField.TagClickEvent<V>> listener)

Sets tag click listener. It subscribes to TagField.TagClickEvent that is invoked when user clicks on tag content.

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener