Package com.storedobject.vaadin

Class ChoicesField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>

com.vaadin.flow.component.customfield.CustomField<Integer>

com.storedobject.vaadin.CustomField<Integer>

com.storedobject.vaadin.ChoicesField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, Serializable

public class ChoicesField
extends CustomField<Integer>

A field that allows you to select multiple values from a fixed list of Strings. The value is returned as a bit pattern with its positional values set for the selected items. The first item in the list uses the least significant bit.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

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

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

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<?>>

Constructor Summary

Constructors

Constructor	Description
ChoicesField(Iterable<?> choices)	Constructor.
ChoicesField(String choices)	Constructor.
ChoicesField(String[] choices)	Constructor.
ChoicesField(String label, Iterable<?> choices)	Constructor.
ChoicesField(String label, String choices)	Constructor.
ChoicesField(String label, String[] choices)	Constructor.
ChoicesField(String label, Collection<String> choices)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.component.HasComponents	createContainer()	Create the container for the check boxes to be shown.
protected Integer	generateModelValue()
void	setColumns(int columns)	Set number of columns to show the check boxes.
protected void	setPresentationValue(Integer value)
void	setReadOnly(boolean readOnly)
void	setValueMask(int valueMask)	A "mask" allows one to fix certain bits in the value of the field.

Methods inherited from class com.storedobject.vaadin.CustomField

addField, addField, focus

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, onAttach, remove, removeThemeVariants, setLabel, updateValue

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

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, 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.AttachNotifier

addAttachListener

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

addBlurListener

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

addDetachListener

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

addFocusShortcut, blur, getTabIndex, setTabIndex

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

addFocusListener

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

getElement

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

isEnabled, setEnabled

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

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

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

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.shared.HasTooltip

getTooltip, setTooltipText

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

setManualValidation

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setErrorMessage, setInvalid

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

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

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Constructor Details

ChoicesField

public ChoicesField(String choices)

Constructor.

Parameters:

choices - Choices delimited by comma

ChoicesField

public ChoicesField(String label,
 String choices)

Constructor.

Parameters:

label - Label

choices - Choices delimited by comma

ChoicesField

public ChoicesField(String[] choices)

Constructor.

Parameters:

choices - Choices

ChoicesField

public ChoicesField(String label,
 String[] choices)

Constructor.

Parameters:

label - Label

choices - Choices

ChoicesField

public ChoicesField(Iterable<?> choices)

Constructor.

Parameters:

choices - Choices

ChoicesField

public ChoicesField(String label,
 Iterable<?> choices)

Constructor.

Parameters:

label - Label

choices - Choices

ChoicesField

public ChoicesField(String label,
 Collection<String> choices)

Constructor.

Parameters:

label - Label

choices - Choices

Method Details

createContainer

protected com.vaadin.flow.component.HasComponents createContainer()

Create the container for the check boxes to be shown.

Returns:

Default implementation creates an appropriate container based on the number of items.

setColumns

public void setColumns(int columns)

Set number of columns to show the check boxes. Setting a value to zero will show it in a single row.

Parameters:

columns - Number of columns

generateModelValue

protected Integer generateModelValue()

Specified by:

generateModelValue in class com.vaadin.flow.component.customfield.CustomField<Integer>

setPresentationValue

protected void setPresentationValue(Integer value)

Specified by:

setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<Integer>

setValueMask

public void setValueMask(int valueMask)

A "mask" allows one to fix certain bits in the value of the field. For example, if the mask is set to 5 (bit pattern 101), the zeroth and the third bits from the right will be always set to 1.

Parameters:

valueMask - Mask to set.

setReadOnly

public void setReadOnly(boolean readOnly)