com.flowingcode.vaadin.addons.chipfield

Class ChipField<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<ChipField<T>,List<T>>

com.flowingcode.vaadin.addons.chipfield.ChipField<T>

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ChipField<T>,List<T>>,List<T>>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ChipField<T>,List<T>>,List<T>>, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.data.binder.HasItems<T>, com.vaadin.flow.data.binder.HasItemsAndComponents<T>, Serializable

@Tag(value="paper-chip-input-autocomplete")
 @NpmPackage(value="@polymer/iron-a11y-keys",version="3.0.1") @NpmPackage(value="@polymer/iron-a11y-keys-behavior",version="3.0.1") @NpmPackage(value="@polymer/iron-icons",version="3.0.1") @NpmPackage(value="@polymer/paper-icon-button",version="3.0.2") @NpmPackage(value="@polymer/paper-input",version="3.0.1") @NpmPackage(value="@polymer/paper-item",version="3.0.1") @NpmPackage(value="@polymer/paper-listbox",version="3.0.1") @NpmPackage(value="@polymer/paper-material",version="3.0.1") @NpmPackage(value="@polymer/paper-ripple",version="3.0.1") @NpmPackage(value="@polymer/paper-styles",version="3.0.1")
 @JsModule(value="./paper-chip-input-autocomplete.js")
public class ChipField<T>
extends com.vaadin.flow.component.AbstractField<ChipField<T>,List<T>>
implements com.vaadin.flow.component.HasStyle, com.vaadin.flow.data.binder.HasItemsAndComponents<T>, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasTheme

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChipField.ChipClickedEvent<T>
static class	ChipField.ChipCreatedEvent<T>
static class	ChipField.ChipEvent<T>
static class	ChipField.ChipRemovedEvent<T>

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.data.binder.HasItemsAndComponents

com.vaadin.flow.data.binder.HasItemsAndComponents.ItemComponent<T>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHIP_LABEL

Constructor Summary

Constructors

Constructor and Description
ChipField(String label, com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator, T... availableItems)
ChipField(String label, T... availableItems)

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addChipClickedListener(com.vaadin.flow.component.ComponentEventListener<ChipField.ChipClickedEvent<T>> listener)
com.vaadin.flow.shared.Registration	addChipCreatedListener(com.vaadin.flow.component.ComponentEventListener<ChipField.ChipCreatedEvent<T>> listener)
com.vaadin.flow.shared.Registration	addChipRemovedListener(com.vaadin.flow.component.ComponentEventListener<ChipField.ChipRemovedEvent<T>> listener)
void	addSelectedItem(T newItem)
String	getAllowedPattern()
String[]	getChipsAsStrings()
String	getLabel()
String	getValidationErrorMessage()
String	getValidationPattern()
List<T>	getValue()
boolean	isAllowAdditionalItems()
boolean	isClosable()
boolean	isDisabled() Deprecated. use HasEnabled.isEnabled()
boolean	isReadonly() Deprecated. use HasValueAndElement.isReadOnly()
boolean	isRequired() Deprecated. use HasValueAndElement.isRequiredIndicatorVisible()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	removeSelectedItem(T itemToRemove)
void	setAllowAdditionalItems(boolean allowAdditionalItems)
void	setAllowedPattern(String pattern)
void	setAvailableItems(List<T> items)
void	setChipLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)
void	setClosable(boolean closable)
void	setDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)
void	setDisabled(boolean disabled) Deprecated. use HasEnabled.setEnabled(boolean)
void	setLabel(String label)
void	setNewItemHandler(com.vaadin.flow.function.SerializableFunction<String,T> handler)
protected void	setPresentationValue(List<T> newPresentationValue)
void	setReadonly(boolean readonly) Deprecated. use #setReadOnly()
void	setReadOnly(boolean readOnly)
void	setRequired(boolean required) Deprecated. use HasValueAndElement.setRequiredIndicatorVisible(boolean)
void	setValidationErrorMessage(String errorMessage)
void	setValidationPattern(String pattern)
void	validate()

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, isEmpty, setModelValue, setValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.data.binder.HasItemsAndComponents

addComponents, getItemPosition, prependComponents

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.data.binder.HasDataProvider

setItems

Methods inherited from interface com.vaadin.flow.data.binder.HasItems

setItems, setItems

Methods inherited from interface com.vaadin.flow.component.HasSize

getCssSize, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Methods inherited from interface com.vaadin.flow.component.HasValue

clear, getOptionalValue

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Field Detail

CHIP_LABEL

public static final String CHIP_LABEL

See Also:

Constant Field Values

Constructor Detail

ChipField

@SafeVarargs
public ChipField(String label,
                              com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator,
                              T... availableItems)

ChipField

@SafeVarargs
public ChipField(String label,
                              T... availableItems)

Method Detail

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

getValue

public List<T> getValue()

Specified by:

getValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ChipField<T>,List<T>>,List<T>>

Overrides:

getValue in class com.vaadin.flow.component.AbstractField<ChipField<T>,List<T>>

setPresentationValue

protected void setPresentationValue(List<T> newPresentationValue)

Specified by:

setPresentationValue in class com.vaadin.flow.component.AbstractField<ChipField<T>,List<T>>

setAvailableItems

public void setAvailableItems(List<T> items)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getChipsAsStrings

public String[] getChipsAsStrings()

setClosable

public void setClosable(boolean closable)

isClosable

public boolean isClosable()

setDisabled

@Deprecated
public void setDisabled(boolean disabled)

Deprecated. use HasEnabled.setEnabled(boolean)

isDisabled

@Deprecated
public boolean isDisabled()

Deprecated. use HasEnabled.isEnabled()

setReadonly

@Deprecated
public void setReadonly(boolean readonly)

Deprecated. use #setReadOnly()

isReadonly

@Deprecated
public boolean isReadonly()

Deprecated. use HasValueAndElement.isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ChipField<T>,List<T>>,List<T>>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ChipField<T>,List<T>>,List<T>>

setRequired

@Deprecated
public void setRequired(boolean required)

Deprecated. use HasValueAndElement.setRequiredIndicatorVisible(boolean)

isRequired

@Deprecated
public boolean isRequired()

Deprecated. use HasValueAndElement.isRequiredIndicatorVisible()

setValidationPattern

public void setValidationPattern(String pattern)

getValidationPattern

public String getValidationPattern()

setValidationErrorMessage

public void setValidationErrorMessage(String errorMessage)

getValidationErrorMessage

public String getValidationErrorMessage()

setAllowedPattern

public void setAllowedPattern(String pattern)

getAllowedPattern

public String getAllowedPattern()

setAllowAdditionalItems

public void setAllowAdditionalItems(boolean allowAdditionalItems)

isAllowAdditionalItems

public boolean isAllowAdditionalItems()

validate

public void validate()

addChipRemovedListener

public com.vaadin.flow.shared.Registration addChipRemovedListener(com.vaadin.flow.component.ComponentEventListener<ChipField.ChipRemovedEvent<T>> listener)

addChipCreatedListener

public com.vaadin.flow.shared.Registration addChipCreatedListener(com.vaadin.flow.component.ComponentEventListener<ChipField.ChipCreatedEvent<T>> listener)

setChipLabelGenerator

public void setChipLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)

setNewItemHandler

public void setNewItemHandler(com.vaadin.flow.function.SerializableFunction<String,T> handler)

setDataProvider

public void setDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)

Specified by:

setDataProvider in interface com.vaadin.flow.data.binder.HasDataProvider<T>

addSelectedItem

public void addSelectedItem(T newItem)

removeSelectedItem

public void removeSelectedItem(T itemToRemove)

addChipClickedListener

public com.vaadin.flow.shared.Registration addChipClickedListener(com.vaadin.flow.component.ComponentEventListener<ChipField.ChipClickedEvent<T>> listener)