Package io.jmix.flowuidata.dateinterval.component

Class DateRangePicker

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<T>,T>
com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>
io.jmix.flowuidata.dateinterval.component.DateRangePicker
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>>, 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<CustomDateInterval>,CustomDateInterval>,CustomDateInterval>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>,CustomDateInterval>,CustomDateInterval>, 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<CustomDateInterval>,CustomDateInterval>,CustomDateInterval>, SupportsValidation<CustomDateInterval>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class DateRangePicker extends com.vaadin.flow.component.customfield.CustomField<CustomDateInterval> implements SupportsValidation<CustomDateInterval>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
Picker component for selecting an arbitrary date range. Uses CustomDateInterval as a model. LocalDate is used as a presentation value.
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<?>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
    applicationContext
     
    protected Datatype<?>
    datatype
     
    protected DatatypeRegistry
    datatypeRegistry
     
    protected TypedDatePicker<LocalDate>
    endDatePicker
     
    protected Messages
    messages
     
    protected MetaPropertyPath
    metaPropertyPath
     
    protected com.vaadin.flow.component.orderedlayout.HorizontalLayout
    root
     
    protected TypedDatePicker<LocalDate>
    startDatePicker
     
    protected DateTimeTransformations
    transformations
     
    protected UiComponents
    uiComponents
     

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

    PROPERTY_ERROR_MESSAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    DateRangePicker()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addValidator(Validator<? super CustomDateInterval> validator)
    Adds a validator to the list of validators for the component.
    void
    afterPropertiesSet()
     
    protected void
    autowireDependencies()
     
    protected Object
    convertValueToModel(LocalDate value)
     
    protected LocalDate
    convertValueToPresentation(Object value)
     
    void
    executeValidators()
    Executes all registered validators against the current value of the component.
    protected CustomDateInterval
    generateModelValue()
     
    protected void
    initComponent()
     
    protected void
    initDatePicker(TypedDatePicker<LocalDate> datePicker)
     
    protected void
    initDatePickers()
     
    protected void
    initRoot()
     
    protected void
    onStartDateValueChange(SupportsTypedValue.TypedValueChangeEvent<TypedDatePicker<LocalDate>,LocalDate> event)
     
    protected void
    onValidationStatusChange(SupportsStatusChangeHandler.StatusContext<TypedDatePicker<LocalDate>> context)
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setInvalid(boolean invalid)
    Sets invalid state to the field considering result of field validation.
    void
    setMetaPropertyPath(MetaPropertyPath metaPropertyPath)
    Sets the MetaPropertyPath for the date range picker component.
    protected void
    setPresentationValue(CustomDateInterval newPresentationValue)
     
    protected void
    updateInvalidState()
     

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

    add, addThemeVariants, getLabel, 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, 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 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

    isInvalid

    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, setReadOnly, setRequiredIndicatorVisible

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

    getErrorMessage, setErrorMessage

  • Field Details

  • Constructor Details

    • DateRangePicker

      public DateRangePicker()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Throws:
      org.springframework.beans.BeansException

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • autowireDependencies

      protected void autowireDependencies()

    • initComponent

      protected void initComponent()

    • initRoot

      protected void initRoot()

    • initDatePickers

      protected void initDatePickers()

    • onStartDateValueChange

      protected void onStartDateValueChange(SupportsTypedValue.TypedValueChangeEvent<TypedDatePicker<LocalDate>,LocalDate> event)

    • initDatePicker

      protected void initDatePicker(TypedDatePicker<LocalDate> datePicker)

    • generateModelValue

      protected CustomDateInterval generateModelValue()
      Specified by:
      generateModelValue in class com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>

    • setPresentationValue

      protected void setPresentationValue(CustomDateInterval newPresentationValue)
      Specified by:
      setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<CustomDateInterval>

    • addValidator

      public com.vaadin.flow.shared.Registration addValidator(Validator<? super CustomDateInterval> 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<CustomDateInterval>
      Parameters:
      validator - the validator to be added; should not be null
      Returns:
      a Registration object that allows removing the added validator

    • onValidationStatusChange

      protected void onValidationStatusChange(SupportsStatusChangeHandler.StatusContext<TypedDatePicker<LocalDate>> context)

    • updateInvalidState

      protected void updateInvalidState()

    • 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<CustomDateInterval>
      Throws:
      ValidationException - if validation fails for one or more validators

    • 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<CustomDateInterval>
      Parameters:
      invalid - whether field should be invalid

    • setMetaPropertyPath

      public void setMetaPropertyPath(MetaPropertyPath metaPropertyPath)
      Sets the MetaPropertyPath for the date range picker component. Updates the datatype.
      Parameters:
      metaPropertyPath - MetaPropertyPath to set

    • convertValueToModel

      @Nullable protected Object convertValueToModel(@Nullable LocalDate value)

    • convertValueToPresentation

      protected LocalDate convertValueToPresentation(Object value)