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.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, 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.HasPrefix, com.vaadin.flow.component.shared.HasSuffix, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, 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, SupportsStatusChangeHandler<JmixValuePicker<V>>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
See Also:

  • 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)
    Add an action to the component at the specified index.
    com.vaadin.flow.shared.Registration
    addValidator(Validator<? super V> validator)
    Adds a validator to the list of validators for the component.
    void
    afterPropertiesSet()
     
    protected String
    applyDefaultValueFormat(V value)
     
    protected ValuePickerActionSupport
    createActionsSupport()
     
    protected FieldDelegate<JmixValuePicker<V>,V,V>
    createFieldDelegate()
     
    void
    executeValidators()
    Executes all registered validators against the current value of the component.
    String
    getErrorMessage()
     
    String
    getRequiredMessage()
    Returns the custom validation message to be displayed if the component is marked as required and the validation fails due to a missing value.
    ValueSource<V>
    getValueSource()
    Returns the current ValueSource associated with this component.
    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
    setRequired(boolean required)
    Sets the required property for the component.
    void
    setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
     
    void
    setRequiredMessage(String requiredMessage)
    Sets a message that will be displayed or logged when a required field or input is not provided.
    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)
    Sets a ValueSource for this component, allowing it to bind its value to a specified data source.
    protected void
    validate()
     

    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, getAriaLabel, getAriaLabelledBy, getFormatter, handlePropertyChange, initComponent, initFieldValuePropertyChangeListener, isAllowCustomValueBoolean, removeAction, setAriaLabel, setAriaLabelledBy, 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, 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, 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.shared.HasPrefix

    getPrefixComponent, setPrefixComponent

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

    isRequired

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

    getSuffixComponent, setSuffixComponent

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

    setManualValidation

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

    clear, getOptionalValue

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

    isReadOnly, isRequiredIndicatorVisible, setReadOnly

    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
      Specified by:
      isInvalid in interface com.vaadin.flow.component.shared.HasValidationProperties

    • 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 com.vaadin.flow.component.shared.HasValidationProperties
      Specified by:
      setInvalid in interface SupportsValidation<V>
      Parameters:
      invalid - whether field should be invalid

    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ValuePicker<V>,V>,V>
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ValuePicker<V>,V>,V>

    • setRequired

      public void setRequired(boolean required)
      Description copied from interface: HasRequired
      Sets the required property for the component. When a component is marked as required, it indicates that a value must be provided for the component in order to pass validation.
      Specified by:
      setRequired in interface HasRequired
      Parameters:
      required - a boolean value indicating whether the component is marked as required. true to mark the component as required, false otherwise.

    • getRequiredMessage

      @Nullable public String getRequiredMessage()
      Description copied from interface: HasRequired
      Returns the custom validation message to be displayed if the component is marked as required and the validation fails due to a missing value.
      Specified by:
      getRequiredMessage in interface HasRequired
      Returns:
      the required message set for the component, or null if no message is defined

    • setRequiredMessage

      public void setRequiredMessage(@Nullable String requiredMessage)
      Description copied from interface: HasRequired
      Sets a message that will be displayed or logged when a required field or input is not provided.
      Specified by:
      setRequiredMessage in interface HasRequired
      Parameters:
      requiredMessage - the message to be set for required fields. If null, the default message or no message will be used.

    • addValidator

      public com.vaadin.flow.shared.Registration addValidator(Validator<? super V> validator)
      Description copied from interface: SupportsValidation
      Adds a validator to the list of validators for the component. The provided validator will be used to validate the value of the component during validation execution.
      Specified by:
      addValidator in interface SupportsValidation<V>
      Parameters:
      validator - the validator to be added; should not be null
      Returns:
      a Registration object that allows removing the added validator

    • executeValidators

      public void executeValidators() throws ValidationException
      Description copied from interface: SupportsValidation
      Executes all registered validators against the current value of the component. If any of the validators fail, a ValidationException is thrown to indicate the failure. The exact behavior and order of validation depend on the validators added.
      Specified by:
      executeValidators in interface SupportsValidation<V>
      Throws:
      ValidationException - if validation fails for one or more validators

    • validate

      protected void validate()
      Overrides:
      validate in class ValuePickerBase<ValuePicker<V>,V>

    • getErrorMessage

      @Nullable public String getErrorMessage()
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.HasValidation
      Specified by:
      getErrorMessage in interface com.vaadin.flow.component.shared.HasValidationProperties
      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 com.vaadin.flow.component.shared.HasValidationProperties
      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()
      Description copied from interface: SupportsValueSource
      Returns the current ValueSource associated with this component.
      Specified by:
      getValueSource in interface SupportsValueSource<V>
      Returns:
      the associated ValueSource, or null if no value source is set

    • setValueSource

      public void setValueSource(@Nullable ValueSource<V> valueSource)
      Description copied from interface: SupportsValueSource
      Sets a ValueSource for this component, allowing it to bind its value to a specified data source.
      Specified by:
      setValueSource in interface SupportsValueSource<V>
      Parameters:
      valueSource - the ValueSource to be associated with this component, or null to remove the current association

    • addAction

      public void addAction(Action action, int index)
      Description copied from interface: HasActions
      Add an action to the component at the specified index.
      Specified by:
      addAction in interface HasActions
      Overrides:
      addAction in class ValuePickerBase<ValuePicker<V>,V>
      Parameters:
      action - action to add
      index - index at which the specified action is to be added

    • createFieldDelegate

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

    • createActionsSupport

      protected ValuePickerActionSupport createActionsSupport()
      Overrides:
      createActionsSupport in class ValuePickerBase<ValuePicker<V>,V>