Package io.jmix.ui.component.impl

Class TagPickerImpl<V>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixPickerField<V>,V,V>

io.jmix.ui.component.impl.ValuePickerImpl<Collection<V>>

io.jmix.ui.component.impl.ValuesPickerImpl<V>

io.jmix.ui.component.impl.TagPickerImpl<V>

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<Collection<V>>, Field<Collection<V>>, HasContextHelp, HasDebugId, HasFilterMode, HasFormatter<Collection<V>>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasOptionCaptionProvider<V>, HasSubParts, HasValidator<Collection<V>>, HasValue<Collection<V>>, OptionsField<Collection<V>,V>, Requirable, SecuredActionsHolder, SupportsUserAction<Collection<V>>, TagPicker<V>, Validatable, ValuePicker<Collection<V>>, ValuesPicker<V>, org.springframework.beans.factory.InitializingBean

public class TagPickerImpl<V>
extends ValuesPickerImpl<V>
implements TagPicker<V>, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.impl.ValuePickerImpl

ValuePickerImpl.WebValuePickerActionHandler

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.HasFilterMode

HasFilterMode.FilterMode

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

HasValue.ValueChangeEvent<V>

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

TagPicker.TagClickEvent<V>, TagPicker.TagPickerAction, TagPicker.TagPosition

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

ValuePicker.FieldValueChangeEvent<V>, ValuePicker.ValuePickerAction

Field Summary

Fields

Modifier and Type	Field	Description
protected HasFilterMode.FilterMode	filterMode
protected boolean	hideSelectedOptions
protected MetaClass	metaClass
static final String	NOACTION_STYLENAME
protected Function<? super V,String>	optionCaptionProvider
protected OptionsBinding<V>	optionsBinding
protected Function<? super V,String>	tagCaptionProvider

Fields inherited from class io.jmix.ui.component.impl.ValuePickerImpl

actionButtons, actionHandler, actionPropertyChangeListener, actions, actionsPermissions, fieldIconProvider, fieldListenerRegistration, formatter, metadataTools

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

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

NAME, TYPE_STRING

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

NAME, TYPE_STRING

Constructor Summary

Constructors

Constructor	Description
TagPickerImpl()

Method Summary

Modifier and Type	Method	Description
void	addAction(Action action, int index)	Add an action to the component with index.
Subscription	addFieldValueChangeListener(Consumer<ValuePicker.FieldValueChangeEvent<Collection<V>>> listener)	Adds a listener that will be fired in case field is editable.
Subscription	addTagClickListener(Consumer<TagPicker.TagClickEvent<V>> listener)	Sets tag click listener.
protected void	componentValueChanged(Collection<V> prevComponentValue, Collection<V> newComponentValue, boolean isUserOriginated)
protected JmixTagPicker<V>	createComponent()
protected boolean	filterItem(String itemCaption, String filterText)
protected String	generateDefaultItemCaption(V item)
protected String	generateOptionCaption(V item)
protected String	generateTagCaption(V item)
protected JmixComboBox<V>	getFieldInternal()
HasFilterMode.FilterMode	getFilterMode()
Formatter<Collection<V>>	getFormatter()
String	getInputPrompt()
protected JmixTagPicker<V>	getJmixTagPicker()
MetaClass	getMetaClass()
Function<? super V,String>	getOptionCaptionProvider()
Options<V>	getOptions()
Function<? super V,String>	getTagCaptionProvider()
Comparator<? super V>	getTagComparator()
TagPicker.TagPosition	getTagPosition()
Function<? super V,String>	getTagStyleProvider()
protected void	hideSelectedOptionsInPresentation(Collection<V> compValue)
protected void	initComponent(JmixPickerField<Collection<V>> component)
boolean	isHideSelectedOptions()
boolean	isInlineTags()
protected void	onNewItemEntered(String itemCaption)
protected void	onTagClick(V item)
void	removeAction(Action action)	Remove the action from the component
protected Subscription	removeTagLabelClickListener(Consumer<TagPicker.TagClickEvent<V>> listener)
void	setFilterMode(HasFilterMode.FilterMode filterMode)	Sets filter mode for the dropdown list in the field.
void	setFormatter(Formatter<? super Collection<V>> formatter)
void	setHideSelectedOptions(boolean hide)	Sets whether the field should hide options from the dropdown list if they have already selected.
void	setInlineTags(boolean inline)	Defines how tags should be oriented in the field: inline = true - tags will be shown one after another in one line if it will be enough available space.
void	setInputPrompt(String inputPrompt)	Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
protected void	setItemsToPresentation(Stream<V> options)
void	setMetaClass(MetaClass metaClass)	Sets entity meta class to the field.
void	setOptionCaptionProvider(Function<? super V,String> optionCaptionProvider)	Sets function that provides caption for option items.
void	setOptions(Options<V> options)	Sets options for UI component.
void	setTagCaptionProvider(Function<? super V,String> tagCaptionProvider)	Sets caption provider.
void	setTagComparator(Comparator<? super V> tagComparator)	Sets comparator for sorting tags in the UI.
void	setTagPosition(TagPicker.TagPosition position)	Sets position where tags should be placed relative to the field.
void	setTagStyleProvider(Function<? super V,String> tagStyleProvider)	Sets tag style provider.
protected void	setValueInternal(Collection<V> value, boolean userOriginated)
protected void	updateNoActionStyle()

Methods inherited from class io.jmix.ui.component.impl.ValuesPickerImpl

convertToModel, convertToPresentation, equalCollections, fieldValueEquals, fireValueChange, getOldValue, isEmpty, setValue, setValueFromUser

Methods inherited from class io.jmix.ui.component.impl.ValuePickerImpl

actionPropertyChanged, addAction, afterPropertiesSet, applyDefaultValueFormat, commit, discard, focus, formatValue, generateOptionIcon, getAction, getActions, getActionsPermissions, getFieldIconProvider, getTabIndex, isBuffered, isFieldEditable, isModified, onFieldValueChange, refreshActionsState, removeAction, removeAllActions, setBuffered, setButtonIcon, setDebugId, setEditableToComponent, setFieldEditable, setFieldIconProvider, setFrame, setMetadataTools, setTabIndex, setUiComponentProperties, setupButtonAction

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getDefaultRequiredMessage, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAllActions

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

commit, discard, isBuffered, isModified, setBuffered

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.Component.BelongToFrame

getFrame, setFrame

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

isEditable, isEditableWithParent, setEditable

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

getValueSource, setValueSource

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

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

setOptionsEnum, setOptionsList, setOptionsMap

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

getRequiredMessage, isRequired, setRequired, setRequiredMessage

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

setValueFromUser

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

isValid, isValidateOnCommit, validate

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

getFieldIconProvider, isFieldEditable, setFieldEditable, setFieldIconProvider

Field Details

NOACTION_STYLENAME

public static final String NOACTION_STYLENAME

See Also:

• Constant Field Values

optionsBinding

protected OptionsBinding<V> optionsBinding

optionCaptionProvider

protected Function<? super V,String> optionCaptionProvider

tagCaptionProvider

protected Function<? super V,String> tagCaptionProvider

filterMode

protected HasFilterMode.FilterMode filterMode

hideSelectedOptions

protected boolean hideSelectedOptions

metaClass

protected MetaClass metaClass

Constructor Details

TagPickerImpl

public TagPickerImpl()

Method Details

createComponent

protected JmixTagPicker<V> createComponent()

Overrides:

createComponent in class ValuesPickerImpl<V>

initComponent

protected void initComponent(JmixPickerField<Collection<V>> component)

Overrides:

initComponent in class ValuePickerImpl<Collection<V>>

setValueInternal

protected void setValueInternal(@Nullable
 Collection<V> value,
 boolean userOriginated)

Overrides:

setValueInternal in class ValuesPickerImpl<V>

getOptions

@Nullable
public Options<V> getOptions()

Specified by:

getOptions in interface OptionsField<Collection<V>,V>

Returns:

options object

setOptions

public void setOptions(@Nullable
 Options<V> options)

Description copied from interface: OptionsField

Sets options for UI component.

Specified by:

setOptions in interface OptionsField<Collection<V>,V>

Parameters:

options - options

See Also:

• ListOptions

setItemsToPresentation

protected void setItemsToPresentation(Stream<V> options)

filterItem

protected boolean filterItem(String itemCaption,
 String filterText)

setOptionCaptionProvider

public void setOptionCaptionProvider(@Nullable
 Function<? super V,String> optionCaptionProvider)

Description copied from interface: HasOptionCaptionProvider

Sets function that provides caption for option items.

Specified by:

setOptionCaptionProvider in interface HasOptionCaptionProvider<V>

Parameters:

optionCaptionProvider - caption provider for options

getOptionCaptionProvider

@Nullable
public Function<? super V,String> getOptionCaptionProvider()

Specified by:

getOptionCaptionProvider in interface HasOptionCaptionProvider<V>

Returns:

caption provider for options

getTagCaptionProvider

@Nullable
public Function<? super V,String> getTagCaptionProvider()

Specified by:

getTagCaptionProvider in interface TagPicker<V>

Returns:

tag caption provider or null if not set

setTagCaptionProvider

public void setTagCaptionProvider(@Nullable
 Function<? super V,String> tagCaptionProvider)

Description copied from interface: TagPicker

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

For instance:

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

Specified by:

setTagCaptionProvider in interface TagPicker<V>

Parameters:

tagCaptionProvider - caption provider to set

getMetaClass

@Nullable
public MetaClass getMetaClass()

Specified by:

getMetaClass in interface TagPicker<V>

Returns:

entity meta class or null

setMetaClass

public void setMetaClass(MetaClass metaClass)

Description copied from interface: TagPicker

Sets entity meta class to the field. It enables to use field with entity type without data container and use TagLookupAction.

Specified by:

setMetaClass in interface TagPicker<V>

Parameters:

metaClass - entity meta class

isHideSelectedOptions

public boolean isHideSelectedOptions()

Specified by:

isHideSelectedOptions in interface TagPicker<V>

Returns:

is selected options is hidden from the dropdown list

setHideSelectedOptions

public void setHideSelectedOptions(boolean hide)

Description copied from interface: TagPicker

Sets whether the field should hide options from the dropdown list if they have already selected. The default value is true.

Specified by:

setHideSelectedOptions in interface TagPicker<V>

Parameters:

hide - true if selected options should be hidden, false otherwise

addTagClickListener

public Subscription addTagClickListener(Consumer<TagPicker.TagClickEvent<V>> listener)

Description copied from interface: TagPicker

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

Specified by:

addTagClickListener in interface TagPicker<V>

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

removeTagLabelClickListener

protected Subscription removeTagLabelClickListener(Consumer<TagPicker.TagClickEvent<V>> listener)

getTagStyleProvider

@Nullable
public Function<? super V,String> getTagStyleProvider()

Specified by:

getTagStyleProvider in interface TagPicker<V>

Returns:

tag style provider or null if not set

setTagStyleProvider

public void setTagStyleProvider(@Nullable
 Function<? super V,String> tagStyleProvider)

Description copied from interface: TagPicker

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

For instance:

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

Specified by:

setTagStyleProvider in interface TagPicker<V>

Parameters:

tagStyleProvider - tag style provider to set

getFilterMode

public HasFilterMode.FilterMode getFilterMode()

Specified by:

getFilterMode in interface HasFilterMode

Returns:

filter mode for the dropdown list in the field

setFilterMode

public void setFilterMode(HasFilterMode.FilterMode filterMode)

Description copied from interface: HasFilterMode

Sets filter mode for the dropdown list in the field.

Specified by:

setFilterMode in interface HasFilterMode

Parameters:

filterMode - filter mode to set

getInputPrompt

public String getInputPrompt()

Specified by:

getInputPrompt in interface HasInputPrompt

Overrides:

getInputPrompt in class ValuePickerImpl<Collection<V>>

Returns:

current input prompt.

setInputPrompt

public void setInputPrompt(String inputPrompt)

Description copied from interface: HasInputPrompt

Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

Specified by:

setInputPrompt in interface HasInputPrompt

Overrides:

setInputPrompt in class ValuePickerImpl<Collection<V>>

Parameters:

inputPrompt - input prompt

isInlineTags

public boolean isInlineTags()

Specified by:

isInlineTags in interface TagPicker<V>

Returns:

true if tags should be placed inline

setInlineTags

public void setInlineTags(boolean inline)

Description copied from interface: TagPicker

Defines how tags should be oriented in the field:

• inline = true - tags will be shown one after another in one line if it will be enough available space. Otherwise, the next tags will be moved to another line. The width of the tag is AUTO.
• inline = false - tags will be shown under each other. Tag occupies all available space on the line.

The default value is false.

Specified by:

setInlineTags in interface TagPicker<V>

Parameters:

inline - whether tags should be placed inline

getTagPosition

public TagPicker.TagPosition getTagPosition()

Specified by:

getTagPosition in interface TagPicker<V>

Returns:

position of tags relative to the field

setTagPosition

public void setTagPosition(TagPicker.TagPosition position)

Description copied from interface: TagPicker

Sets position where tags should be placed relative to the field.

• TagPicker.TagPosition.TOP - tags are placed above the field.
• TagPicker.TagPosition.RIGHT - tags are placed to the right of the field.
• TagPicker.TagPosition.BOTTOM - tags are placed under the field.
• TagPicker.TagPosition.LEFT - tags are placed to the left of the field.

The default value is TagPicker.TagPosition.BOTTOM.

Specified by:

setTagPosition in interface TagPicker<V>

Parameters:

position - position to set

getTagComparator

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

Specified by:

getTagComparator in interface TagPicker<V>

Returns:

tag comparator

setTagComparator

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

Description copied from interface: TagPicker

Sets comparator for sorting tags in the UI.

Specified by:

setTagComparator in interface TagPicker<V>

Parameters:

tagComparator - comparator to set

setFormatter

public void setFormatter(@Nullable
 Formatter<? super Collection<V>> formatter)

Specified by:

setFormatter in interface HasFormatter<V>

Overrides:

setFormatter in class ValuePickerImpl<Collection<V>>

getFormatter

@Nullable
public Formatter<Collection<V>> getFormatter()

Specified by:

getFormatter in interface HasFormatter<V>

Overrides:

getFormatter in class ValuePickerImpl<Collection<V>>

addFieldValueChangeListener

public Subscription addFieldValueChangeListener(Consumer<ValuePicker.FieldValueChangeEvent<Collection<V>>> listener)

Description copied from interface: ValuePicker

Adds a listener that will be fired in case field is editable.

Specified by:

addFieldValueChangeListener in interface ValuePicker<V>

Overrides:

addFieldValueChangeListener in class ValuePickerImpl<Collection<V>>

Parameters:

listener - a listener to add

Returns:

a Subscription object

See Also:

• ValuePicker.setFieldEditable(boolean)

addAction

public void addAction(Action action,
 int index)

Description copied from interface: ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface ActionsHolder

Overrides:

addAction in class ValuePickerImpl<Collection<V>>

removeAction

public void removeAction(Action action)

Description copied from interface: ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface ActionsHolder

Overrides:

removeAction in class ValuePickerImpl<Collection<V>>

updateNoActionStyle

protected void updateNoActionStyle()

componentValueChanged

protected void componentValueChanged(Collection<V> prevComponentValue,
 Collection<V> newComponentValue,
 boolean isUserOriginated)

Overrides:

componentValueChanged in class AbstractValueComponent<JmixPickerField<Collection<V>>,Collection<V>,Collection<V>>

hideSelectedOptionsInPresentation

protected void hideSelectedOptionsInPresentation(@Nullable
 Collection<V> compValue)

generateOptionCaption

@Nullable
protected String generateOptionCaption(@Nullable
 V item)

generateTagCaption

@Nullable
protected String generateTagCaption(@Nullable
 V item)

generateDefaultItemCaption

protected String generateDefaultItemCaption(V item)

getJmixTagPicker

protected JmixTagPicker<V> getJmixTagPicker()

getFieldInternal

protected JmixComboBox<V> getFieldInternal()

onTagClick

protected void onTagClick(V item)

onNewItemEntered

protected void onNewItemEntered(String itemCaption)