Package io.jmix.flowui.component.valuepicker

Class JmixValuePicker<V>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,V>

io.jmix.flowui.kit.component.valuepicker.ValuePickerBase<ValuePicker<V>,V>

io.jmix.flowui.kit.component.valuepicker.ValuePicker<V>

io.jmix.flowui.component.valuepicker.JmixValuePicker<V>

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<ValuePicker<V>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<ValuePicker<V>>, com.vaadin.flow.component.FocusNotifier<ValuePicker<V>>, 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<ValuePicker<V>,V>,V>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ValuePicker<V>,V>,V>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.textfield.HasPrefixAndSuffix, HasRequired, PickerComponent<V>, SupportsStatusChangeHandler<JmixValuePicker<V>>, SupportsValidation<V>, SupportsValueSource<V>, HasActions, HasAutofocus, HasPlaceholder, HasTitle, SupportsFormatter<V>, SupportsUserAction<V>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class JmixValuePicker<V>
extends ValuePicker<V>
implements PickerComponent<V>, SupportsValidation<V>, HasRequired, com.vaadin.flow.component.textfield.HasPrefixAndSuffix, SupportsStatusChangeHandler<JmixValuePicker<V>>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

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 extends Object>

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 extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsStatusChangeHandler

SupportsStatusChangeHandler.StatusContext<C extends com.vaadin.flow.component.Component>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected FieldDelegate<JmixValuePicker<V>,V,V>	fieldDelegate

Fields inherited from class io.jmix.flowui.kit.component.valuepicker.ValuePickerBase

actionsSupport, formatter, PROPERTY_ALLOW_CUSTOM_VALUE, PROPERTY_VALUE

Fields inherited from interface io.jmix.flowui.kit.component.HasAutofocus

AUTOFOCUS_PROPERTY_NAME

Fields inherited from interface io.jmix.flowui.kit.component.HasPlaceholder

PLACEHOLDER_PROPERTY_NAME

Fields inherited from interface io.jmix.flowui.component.HasRequired

PROPERTY_REQUIRED

Fields inherited from interface io.jmix.flowui.component.SupportsValidation

PROPERTY_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor	Description
JmixValuePicker()

Method Summary

Modifier and Type	Method	Description
void	addAction(Action action, int index)
com.vaadin.flow.shared.Registration	addValidator(Validator<? super V> validator)
void	afterPropertiesSet()
protected String	applyDefaultValueFormat(V value)
protected ValuePickerActionSupport	createActionsSupport()
protected FieldDelegate<JmixValuePicker<V>,V,V>	createFieldDelegate()
void	executeValidators()
String	getErrorMessage()
String	getRequiredMessage()
ValueSource<V>	getValueSource()
boolean	isInvalid()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setErrorMessage(String errorMessage)
void	setInvalid(boolean invalid)	Sets invalid state to the field considering result of field validation.
void	setRequiredMessage(String requiredMessage)
void	setStatusChangeHandler(Consumer<SupportsStatusChangeHandler.StatusContext<JmixValuePicker<V>>> handler)	Sets a callback to be used to handle component status changes, e.g.
void	setValueSource(ValueSource<V> valueSource)

Methods inherited from class io.jmix.flowui.kit.component.valuepicker.ValuePicker

addCustomValueSetListener, isAllowCustomValue, setAllowCustomValue

Methods inherited from class io.jmix.flowui.kit.component.valuepicker.ValuePickerBase

formatValue, getAction, getActions, getActionsSupport, getFormatter, handlePropertyChange, initComponent, initFieldValuePropertyChangeListener, isAllowCustomValueBoolean, removeAction, setFormatter, setPresentationValue, setValue, setValueFromClient

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

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, 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, onAttach, onDetach, onEnabledStateChanged, 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, focus, getTabIndex, setTabIndex

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

addFocusListener

Methods inherited from interface io.jmix.flowui.kit.component.HasActions

addAction, getAction, getActions, removeAction, removeAction, removeAllActions

Methods inherited from interface io.jmix.flowui.kit.component.HasAutofocus

isAutofocus, setAutofocus

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

getLabel, setLabel

Methods inherited from interface io.jmix.flowui.kit.component.HasPlaceholder

getPlaceholder, setPlaceholder

Methods inherited from interface com.vaadin.flow.component.textfield.HasPrefixAndSuffix

getPrefixComponent, getSuffixComponent, setPrefixComponent, setSuffixComponent

Methods inherited from interface io.jmix.flowui.component.HasRequired

isRequired, setRequired

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 io.jmix.flowui.kit.component.HasTitle

getTitle, setTitle

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

getTooltip, setTooltipText

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

clear, getOptionalValue

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

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Methods inherited from interface io.jmix.flowui.kit.component.SupportsUserAction

setValueFromClient

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

fieldDelegate

protected FieldDelegate<JmixValuePicker<V>,V,V> fieldDelegate

Constructor Details

JmixValuePicker

public JmixValuePicker()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

applyDefaultValueFormat

protected String applyDefaultValueFormat(@Nullable
 V value)

Overrides:

applyDefaultValueFormat in class ValuePickerBase<ValuePicker<V>,V>

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

setInvalid

public void setInvalid(boolean invalid)

Description copied from interface: SupportsValidation

Sets invalid state to the field considering result of field validation.

• Invalid - false and validation passed - false = field is invalid
• Invalid - false and validation passed - true = field is valid
• Invalid - true and validation passed - false = field is invalid
• Invalid - true and validation passed - true = field is invalid

Specified by:

setInvalid in interface com.vaadin.flow.component.HasValidation

Specified by:

setInvalid in interface SupportsValidation<V>

Parameters:

invalid - whether field should be invalid

getRequiredMessage

@Nullable
public String getRequiredMessage()

Specified by:

getRequiredMessage in interface HasRequired

setRequiredMessage

public void setRequiredMessage(@Nullable
 String requiredMessage)

Specified by:

setRequiredMessage in interface HasRequired

addValidator

public com.vaadin.flow.shared.Registration addValidator(Validator<? super V> validator)

Specified by:

addValidator in interface SupportsValidation<V>

executeValidators

public void executeValidators()
                       throws ValidationException

Specified by:

executeValidators in interface SupportsValidation<V>

Throws:

ValidationException

getErrorMessage

@Nullable
public String getErrorMessage()

Specified by:

getErrorMessage in interface com.vaadin.flow.component.HasValidation

Specified by:

getErrorMessage in interface SupportsValidation<V>

setErrorMessage

public void setErrorMessage(@Nullable
 String errorMessage)

Specified by:

setErrorMessage in interface com.vaadin.flow.component.HasValidation

Specified by:

setErrorMessage in interface SupportsValidation<V>

setStatusChangeHandler

public void setStatusChangeHandler(@Nullable
 Consumer<SupportsStatusChangeHandler.StatusContext<JmixValuePicker<V>>> handler)

Description copied from interface: SupportsStatusChangeHandler

Sets a callback to be used to handle component status changes, e.g. validation messages set by HasValidation.setErrorMessage(String).

Specified by:

setStatusChangeHandler in interface SupportsStatusChangeHandler<V>

Parameters:

handler - a handler to set

getValueSource

@Nullable
public ValueSource<V> getValueSource()

Specified by:

getValueSource in interface SupportsValueSource<V>

setValueSource

public void setValueSource(@Nullable
 ValueSource<V> valueSource)

Specified by:

setValueSource in interface SupportsValueSource<V>

addAction

public void addAction(Action action,
 int index)

Specified by:

addAction in interface HasActions

Overrides:

addAction in class ValuePickerBase<ValuePicker<V>,V>

createFieldDelegate

protected FieldDelegate<JmixValuePicker<V>,V,V> createFieldDelegate()

createActionsSupport

protected ValuePickerActionSupport createActionsSupport()

Overrides:

createActionsSupport in class ValuePickerBase<ValuePicker<V>,V>