Package io.jmix.flowui.component.timepicker

Class TypedTimePicker<V extends Comparable>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>
com.vaadin.flow.component.timepicker.TimePicker
io.jmix.flowui.component.timepicker.TypedTimePicker<V>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.timepicker.TimePicker>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.timepicker.TimePicker>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.timepicker.TimePicker>, 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.timepicker.TimePicker,LocalTime>,LocalTime>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,LocalTime>, com.vaadin.flow.component.shared.HasAllowedCharPattern, com.vaadin.flow.component.shared.HasAutoOpen, com.vaadin.flow.component.shared.HasClearButton, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasOverlayClassName, com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.timepicker.TimePickerVariant>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.data.binder.HasValidator<LocalTime>, HasRequired, HasZoneId, SupportsDatatype<V>, SupportsStatusChangeHandler<TypedTimePicker<V>>, SupportsTypedValue<TypedTimePicker<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,V,LocalTime>, SupportsValidation<V>, SupportsValueSource<V>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class TypedTimePicker<V extends Comparable> extends com.vaadin.flow.component.timepicker.TimePicker implements SupportsValueSource<V>, SupportsTypedValue<TypedTimePicker<V>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,V,LocalTime>, SupportsDatatype<V>, SupportsValidation<V>, SupportsStatusChangeHandler<TypedTimePicker<V>>, HasRequired, HasZoneId, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean
See Also:

  • Nested Class Summary

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

    com.vaadin.flow.component.timepicker.TimePicker.InvalidChangeEvent

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

    com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

    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>

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

    SupportsTypedValue.TypedValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.springframework.context.ApplicationContext
    applicationContext
     
    protected DateTimeTransformations
    dateTimeTransformations
     
    protected TimePickerDelegate<V>
    fieldDelegate
     
    protected V
    internalValue
     
    protected boolean
    isVaadinValueChangeEnabled
    Component manually handles Vaadin value change event: when programmatically sets value (see setValueInternal(LocalTime)) and client-side sets value (see onValueChange(ComponentValueChangeEvent)).
    protected Messages
    messages
     
    protected ZoneId
    zoneId
     

    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
    TypedTimePicker()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addTypedValueChangeListener(com.vaadin.flow.component.ComponentEventListener<SupportsTypedValue.TypedValueChangeEvent<TypedTimePicker<V>,V>> listener)
     
    com.vaadin.flow.shared.Registration
    addValidator(Validator<? super V> validator)
     
    com.vaadin.flow.shared.Registration
    addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>> listener)
     
    void
    afterPropertiesSet()
     
    protected void
    attachValueChangeListener()
     
    protected void
    autowireDependencies()
     
    protected V
    convertTimeFromZDT(ZonedDateTime zonedDateTime, Class<?> modelType)
     
    protected ZonedDateTime
    convertTimeToZDT(Object value, ZoneId fromZoneId)
     
    protected V
    convertToModel(LocalTime presentationValue)
     
    protected LocalTime
    convertToPresentation(V modelValue)
     
    protected TimePickerDelegate<V>
    createFieldDelegate()
     
    void
    executeValidators()
     
    protected boolean
    fieldValueEquals(V value, V oldValue)
     
    protected void
    fireAllValueChangeEvents(V value, V oldValue, boolean isFromClient)
     
    protected void
    fireTimePickerValueChangeEvent(V oldValue, boolean isFromClient)
     
    protected void
    fireTypedValueChangeEvent(V value, V oldValue, boolean isFromClient)
     
    Datatype<V>
    getDatatype()
     
    String
    getErrorMessage()
     
    String
    getRequiredMessage()
     
    V
    getTypedValue()
     
    ValueSource<V>
    getValueSource()
     
    ZoneId
    getZoneId()
     
    protected ZoneId
    getZoneIdInternal()
     
    protected void
    initComponent()
     
    boolean
    isInvalid()
     
    protected boolean
    isTimeTypeSupportsTimeZones(Class<?> javaType)
     
    protected void
    onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TypedTimePicker<V>,LocalTime> event)
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setDatatype(Datatype<V> datatype)
     
    void
    setErrorMessage(String errorMessage)
     
    void
    setInvalid(boolean invalid)
    Sets invalid state to the field considering result of field validation.
    void
    setMax(LocalTime max)
     
    void
    setMin(LocalTime min)
     
    void
    setRequired(boolean required)
     
    void
    setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
     
    void
    setRequiredMessage(String requiredMessage)
     
    void
    setStatusChangeHandler(Consumer<SupportsStatusChangeHandler.StatusContext<TypedTimePicker<V>>> handler)
    Sets a callback to be used to handle component status changes, e.g.
    void
    setTypedValue(V value)
     
    void
    setValue(LocalTime value)
     
    protected void
    setValueInternal(LocalTime value)
     
    void
    setValueSource(ValueSource<V> valueSource)
     
    void
    setZoneId(ZoneId zoneId)
     
    protected void
    validate()
     

    Methods inherited from class com.vaadin.flow.component.timepicker.TimePicker

    addInvalidChangeListener, addValidationStatusChangeListener, getDefaultValidator, getLabel, getLocale, getMax, getMin, getPlaceholder, getStep, getSupportedAvailableLocales, isInputValuePresent, isRequired, onAttach, setLabel, setLocale, setPlaceholder, setStep

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

    getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

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

    getEmptyValue, getValue, isEmpty, setModelValue, valueEquals

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

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, 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, focus, getTabIndex, setTabIndex

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

    addFocusListener

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

    getAllowedCharPattern, setAllowedCharPattern

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

    isAutoOpen, setAutoOpen

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

    isClearButtonVisible, setClearButtonVisible

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

    addClientValidatedEventListener

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

    getOverlayClassName, setOverlayClassName

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

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

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

    addThemeVariants, removeThemeVariants

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

    getTooltip, setTooltipText

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

    clear, getEmptyValue, getOptionalValue, getValue, isEmpty

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

    isReadOnly, isRequiredIndicatorVisible, setReadOnly

  • Field Details

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

    • dateTimeTransformations

      protected DateTimeTransformations dateTimeTransformations

    • messages

      protected Messages messages

    • fieldDelegate

      protected TimePickerDelegate<V extends Comparable> fieldDelegate

    • internalValue

      protected V extends Comparable internalValue

    • zoneId

      protected ZoneId zoneId

    • isVaadinValueChangeEnabled

      protected boolean isVaadinValueChangeEnabled
      Component manually handles Vaadin value change event: when programmatically sets value (see setValueInternal(LocalTime)) and client-side sets value (see onValueChange(ComponentValueChangeEvent)). Therefore, any Vaadin value change listener has a wrapper and disabled for handling event.

  • Constructor Details

    • TypedTimePicker

      public TypedTimePicker()

  • Method Details

    • afterPropertiesSet

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

    • 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

    • createFieldDelegate

      protected TimePickerDelegate<V> createFieldDelegate()

    • autowireDependencies

      protected void autowireDependencies()

    • initComponent

      protected void initComponent()

    • getValueSource

      @Nullable public ValueSource<V> getValueSource()
      Specified by:
      getValueSource in interface SupportsValueSource<V extends Comparable>

    • setValueSource

      public void setValueSource(@Nullable ValueSource<V> valueSource)
      Specified by:
      setValueSource in interface SupportsValueSource<V extends Comparable>

    • getDatatype

      @Nullable public Datatype<V> getDatatype()
      Specified by:
      getDatatype in interface SupportsDatatype<V extends Comparable>

    • setDatatype

      public void setDatatype(@Nullable Datatype<V> datatype)
      Specified by:
      setDatatype in interface SupportsDatatype<V extends Comparable>

    • getZoneId

      @Nullable public ZoneId getZoneId()
      Specified by:
      getZoneId in interface HasZoneId

    • setZoneId

      public void setZoneId(@Nullable ZoneId zoneId)
      Specified by:
      setZoneId in interface HasZoneId

    • addValidator

      public com.vaadin.flow.shared.Registration addValidator(Validator<? super V> validator)
      Specified by:
      addValidator in interface SupportsValidation<V extends Comparable>

    • executeValidators

      public void executeValidators() throws ValidationException
      Specified by:
      executeValidators in interface SupportsValidation<V extends Comparable>
      Throws:
      ValidationException

    • 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 extends Comparable>

    • 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 extends Comparable>

    • setStatusChangeHandler

      public void setStatusChangeHandler(@Nullable Consumer<SupportsStatusChangeHandler.StatusContext<TypedTimePicker<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 extends Comparable>
      Parameters:
      handler - a handler to set

    • setRequired

      public void setRequired(boolean required)
      Specified by:
      setRequired in interface HasRequired
      Overrides:
      setRequired in class com.vaadin.flow.component.timepicker.TimePicker

    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,LocalTime>
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,LocalTime>
      Overrides:
      setRequiredIndicatorVisible in class com.vaadin.flow.component.timepicker.TimePicker

    • getRequiredMessage

      @Nullable public String getRequiredMessage()
      Specified by:
      getRequiredMessage in interface HasRequired

    • setRequiredMessage

      public void setRequiredMessage(@Nullable String requiredMessage)
      Specified by:
      setRequiredMessage in interface HasRequired

    • getTypedValue

      @Nullable public V getTypedValue()
      Specified by:
      getTypedValue in interface SupportsTypedValue<TypedTimePicker<V extends Comparable>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,V extends Comparable,LocalTime>

    • setTypedValue

      public void setTypedValue(@Nullable V value)
      Specified by:
      setTypedValue in interface SupportsTypedValue<TypedTimePicker<V extends Comparable>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,V extends Comparable,LocalTime>

    • setValue

      public void setValue(LocalTime value)
      Specified by:
      setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,LocalTime>
      Overrides:
      setValue in class com.vaadin.flow.component.timepicker.TimePicker

    • setValueInternal

      protected void setValueInternal(@Nullable LocalTime value)

    • addTypedValueChangeListener

      public com.vaadin.flow.shared.Registration addTypedValueChangeListener(com.vaadin.flow.component.ComponentEventListener<SupportsTypedValue.TypedValueChangeEvent<TypedTimePicker<V>,V>> listener)
      Specified by:
      addTypedValueChangeListener in interface SupportsTypedValue<TypedTimePicker<V extends Comparable>,com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,V extends Comparable,LocalTime>

    • addValueChangeListener

      public com.vaadin.flow.shared.Registration addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>> listener)
      Specified by:
      addValueChangeListener in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>,LocalTime>
      Overrides:
      addValueChangeListener in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.timepicker.TimePicker,LocalTime>

    • setMin

      public void setMin(LocalTime min)
      Overrides:
      setMin in class com.vaadin.flow.component.timepicker.TimePicker

    • setMax

      public void setMax(LocalTime max)
      Overrides:
      setMax in class com.vaadin.flow.component.timepicker.TimePicker

    • validate

      protected void validate()
      Overrides:
      validate in class com.vaadin.flow.component.timepicker.TimePicker

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

    • fireAllValueChangeEvents

      protected void fireAllValueChangeEvents(@Nullable V value, @Nullable V oldValue, boolean isFromClient)

    • fireTypedValueChangeEvent

      protected void fireTypedValueChangeEvent(@Nullable V value, @Nullable V oldValue, boolean isFromClient)

    • fireTimePickerValueChangeEvent

      protected void fireTimePickerValueChangeEvent(@Nullable V oldValue, boolean isFromClient)

    • attachValueChangeListener

      protected void attachValueChangeListener()

    • onValueChange

      protected void onValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TypedTimePicker<V>,LocalTime> event)

    • convertToModel

      @Nullable protected V convertToModel(@Nullable LocalTime presentationValue)

    • convertToPresentation

      @Nullable protected LocalTime convertToPresentation(@Nullable V modelValue)

    • fieldValueEquals

      protected boolean fieldValueEquals(@Nullable V value, @Nullable V oldValue)

    • convertTimeToZDT

      protected ZonedDateTime convertTimeToZDT(Object value, ZoneId fromZoneId)

    • convertTimeFromZDT

      protected V convertTimeFromZDT(ZonedDateTime zonedDateTime, Class<?> modelType)

    • getZoneIdInternal

      protected ZoneId getZoneIdInternal()

    • isTimeTypeSupportsTimeZones

      protected boolean isTimeTypeSupportsTimeZones(Class<?> javaType)