Package io.jmix.ui.widget

Class JmixTagPicker<V>

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.JmixComboBoxPickerField<Collection<V>>

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

All Implemented Interfaces:

com.vaadin.data.HasValue<Collection<V>>, 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, Serializable, Iterable<com.vaadin.ui.Component>

public class JmixTagPicker<V>
extends JmixComboBoxPickerField<Collection<V>>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JmixTagPicker.TagContainerPosition

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.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.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.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 com.vaadin.ui.CssLayout	composition
protected JmixTagPicker.TagContainerPosition	containerPosition
protected JmixTagContainer<V>	tagContainer
static final String	TAGCONTAINER_COMPOSITION_STYLENAME
static final String	TAGPICKER_STYLENAME
static final String	TAGS_BOTTOM_STYLENAME
static final String	TAGS_LEFT_STYLENAME
static final String	TAGS_RIGHT_STYLENAME
static final String	TAGS_TOP_STYLENAME

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

COMBOBOX_FIELD_STYLENAME, COMBOBOX_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	Description
JmixTagPicker()

Method Summary

Modifier and Type	Method	Description
com.vaadin.shared.Registration	addValueChangeListener(com.vaadin.data.HasValue.ValueChangeListener<Collection<V>> listener)
protected void	doSetValue(Collection<V> value)
protected boolean	equalCollections(Collection<V> a, Collection<V> b)
String	getStyleName()
Comparator<? super V>	getTagComparator()
JmixTagPicker.TagContainerPosition	getTagContainerPosition()
protected String	getTagContainerPositionStyle(JmixTagPicker.TagContainerPosition containerPosition)
Function<? super V,String>	getTagStyleProvider()
Collection<V>	getValue()
protected com.vaadin.ui.Component	initContent()
protected void	initField()
protected void	initLayout()
protected boolean	isDifferentValue(Collection<V> newValue)
boolean	isInlineTags()
protected void	onFieldValueChange(com.vaadin.data.HasValue.ValueChangeEvent<?> event)
protected void	onTagLabelRemove(V item)
void	refreshTags()
void	setInlineTags(boolean inline)
void	setReadOnly(boolean readOnly)
void	setStyleName(String style)
void	setTagCaptionProvider(Function<V,String> tagCaptionProvider)
void	setTagClickHandler(Consumer<V> tagClickHandler)
void	setTagComparator(Comparator<? super V> tagComparator)
void	setTagContainerPosition(JmixTagPicker.TagContainerPosition containerPosition)
void	setTagStyleProvider(Function<? super V,String> tagStyleProvider)
protected void	updateTagContainerVisibility()

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

getEmptySelectionCaption, getFieldInternal, getItemCaptionGenerator, getItemIconGenerator, getNewItemHandler, getPageLength, getPlaceholder, getPopupWidth, init, isEmptySelectionAllowed, isTextInputAllowed, setEmptySelectionAllowed, setEmptySelectionCaption, setItemCaptionGenerator, setItemIconGenerator, setItems, setItems, setItems, setItems, setItems, setNewItemHandler, setPageLength, setPlaceholder, setPopupWidth, setStyleGenerator, setTextInputAllowed, updateFieldReadOnlyFocusable

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

addActionHandler, addButton, addFieldListener, attach, focus, getButtons, getEmptyStringRepresentation, getField, getIconGenerator, getStringRepresentation, getTabIndex, getTextFieldValueProvider, isEmpty, isFieldReadOnly, removeActionHandler, removeButton, setFieldReadOnly, setHeight, setIconGenerator, 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, 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, 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.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, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getEmptyValue, getOptionalValue

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.server.Sizeable

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

Field Details

TAGPICKER_STYLENAME

public static final String TAGPICKER_STYLENAME

See Also:

• Constant Field Values

TAGCONTAINER_COMPOSITION_STYLENAME

public static final String TAGCONTAINER_COMPOSITION_STYLENAME

See Also:

• Constant Field Values

TAGS_TOP_STYLENAME

public static final String TAGS_TOP_STYLENAME

See Also:

• Constant Field Values

TAGS_RIGHT_STYLENAME

public static final String TAGS_RIGHT_STYLENAME

See Also:

• Constant Field Values

TAGS_BOTTOM_STYLENAME

public static final String TAGS_BOTTOM_STYLENAME

See Also:

• Constant Field Values

TAGS_LEFT_STYLENAME

public static final String TAGS_LEFT_STYLENAME

See Also:

• Constant Field Values

composition

protected com.vaadin.ui.CssLayout composition

tagContainer

protected JmixTagContainer<V> tagContainer

containerPosition

protected JmixTagPicker.TagContainerPosition containerPosition

Constructor Details

JmixTagPicker

public JmixTagPicker()

Method Details

initLayout

protected void initLayout()

Overrides:

initLayout in class JmixPickerField<Collection<V>>

initField

protected void initField()

Overrides:

initField in class JmixComboBoxPickerField<Collection<V>>

initContent

protected com.vaadin.ui.Component initContent()

Overrides:

initContent in class JmixPickerField<Collection<V>>

onFieldValueChange

protected void onFieldValueChange(com.vaadin.data.HasValue.ValueChangeEvent<?> event)

Overrides:

onFieldValueChange in class JmixPickerField<Collection<V>>

getValue

public Collection<V> getValue()

Specified by:

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

Overrides:

getValue in class JmixComboBoxPickerField<Collection<V>>

doSetValue

protected void doSetValue(Collection<V> value)

Overrides:

doSetValue in class JmixComboBoxPickerField<Collection<V>>

isDifferentValue

protected boolean isDifferentValue(Collection<V> newValue)

Overrides:

isDifferentValue in class JmixPickerField<Collection<V>>

addValueChangeListener

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

Specified by:

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

Overrides:

addValueChangeListener in class JmixComboBoxPickerField<Collection<V>>

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.data.HasValue<V>

Overrides:

setReadOnly in class JmixPickerField<Collection<V>>

setStyleName

public void setStyleName(String style)

Specified by:

setStyleName in interface com.vaadin.ui.Component

Overrides:

setStyleName in class JmixComboBoxPickerField<Collection<V>>

getStyleName

public String getStyleName()

Specified by:

getStyleName in interface com.vaadin.ui.Component

Overrides:

getStyleName in class JmixComboBoxPickerField<Collection<V>>

isInlineTags

public boolean isInlineTags()

setInlineTags

public void setInlineTags(boolean inline)

getTagContainerPosition

public JmixTagPicker.TagContainerPosition getTagContainerPosition()

setTagContainerPosition

public void setTagContainerPosition(JmixTagPicker.TagContainerPosition containerPosition)

refreshTags

public void refreshTags()

setTagCaptionProvider

public void setTagCaptionProvider(Function<V,String> tagCaptionProvider)

setTagClickHandler

public void setTagClickHandler(@Nullable
 Consumer<V> tagClickHandler)

getTagStyleProvider

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

setTagStyleProvider

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

getTagComparator

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

setTagComparator

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

updateTagContainerVisibility

protected void updateTagContainerVisibility()

onTagLabelRemove

protected void onTagLabelRemove(V item)

equalCollections

protected boolean equalCollections(@Nullable
 Collection<V> a,
 @Nullable
 Collection<V> b)

getTagContainerPositionStyle

protected String getTagContainerPositionStyle(JmixTagPicker.TagContainerPosition containerPosition)