Package com.vaadin.flow.component.timepicker

Class TimePicker

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<TimePicker,LocalTime>
com.vaadin.flow.component.timepicker.TimePicker
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<TimePicker>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<TimePicker>, com.vaadin.flow.component.FocusNotifier<TimePicker>, 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.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<TimePicker,LocalTime>,LocalTime>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>,LocalTime>, HasAllowedCharPattern, HasAutoOpen, HasClearButton, HasClientValidation, HasOverlayClassName, HasPrefix, HasThemeVariant<TimePickerVariant>, HasTooltip, HasValidationProperties, InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>,LocalTime>, com.vaadin.flow.data.binder.HasValidator<LocalTime>, Serializable
@Tag("vaadin-time-picker") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.2.0") @NpmPackage(value="@vaadin/time-picker",version="24.2.0") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/time-picker/src/vaadin-time-picker.js") @JsModule("./vaadin-time-picker/timepickerConnector.js") public class TimePicker extends com.vaadin.flow.component.AbstractSinglePropertyField<TimePicker,LocalTime> implements com.vaadin.flow.component.Focusable<TimePicker>, HasAllowedCharPattern, com.vaadin.flow.component.HasAriaLabel, HasAutoOpen, HasClearButton, HasClientValidation, com.vaadin.flow.component.HasHelper, InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>,LocalTime>, HasPrefix, HasOverlayClassName, HasThemeVariant<TimePickerVariant>, HasValidationProperties, com.vaadin.flow.data.binder.HasValidator<LocalTime>
Time Picker is an input field for entering or selecting a specific time. The time can be entered directly using a keyboard or by choosing a value from a set of predefined options presented in an overlay. The overlay opens when the field is clicked or any input is entered when the field is focused.
Author:
Vaadin Ltd
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    TimePicker.InvalidChangeEvent
    invalid-changed event is sent when the invalid state changes.

    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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    TimePicker()
    Default constructor.
    TimePicker(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>> listener)
    Convenience constructor to create a time picker with a HasValue.ValueChangeListener.
    TimePicker(String label)
    Convenience constructor to create a time picker with a label.
    TimePicker(String label, LocalTime time)
    Convenience constructor to create a time picker with a pre-selected time and a label.
    TimePicker(String label, LocalTime time, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>> listener)
    Convenience constructor to create a time picker with a label, a pre-selected time and a HasValue.ValueChangeListener.
    TimePicker(LocalTime time)
    Convenience constructor to create a time picker with a pre-selected time.
    TimePicker(LocalTime time, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>> listener)
    Convenience constructor to create a time picker with a pre-selected time and HasValue.ValueChangeListener.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.vaadin.flow.shared.Registration
    addInvalidChangeListener(com.vaadin.flow.component.ComponentEventListener<TimePicker.InvalidChangeEvent> listener)
    Adds a listener for invalid-changed events fired by the webcomponent.
    com.vaadin.flow.shared.Registration
    addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<LocalTime> listener)
     
    Optional<String>
    getAriaLabel()
     
    Optional<String>
    getAriaLabelledBy()
     
    com.vaadin.flow.data.binder.Validator<LocalTime>
    getDefaultValidator()
     
    String
    getLabel()
    Gets the label of the time picker.
    Locale
    getLocale()
    Gets the Locale for this time picker.
    LocalTime
    getMax()
    Gets the maximum time in the time picker.
    LocalTime
    getMin()
    Gets the minimum time in the time picker.
    String
    getPlaceholder()
    The placeholder text that should be displayed in the input element, when the user has not entered a value.
    Duration
    getStep()
    Gets the step of the time picker.
    static Stream<Locale>
    getSupportedAvailableLocales()
    Returns a stream of all the available locales that are supported by the time picker component.
    protected boolean
    isInputValuePresent()
    Returns whether the input element has a value or not.
    boolean
    isRequired()
    Determines whether the time picker is marked as input required.
    protected void
    onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
     
    void
    setAriaLabel(String ariaLabel)
     
    void
    setAriaLabelledBy(String labelledBy)
     
    void
    setLabel(String label)
    Sets the label for the time picker.
    void
    setLocale(Locale locale)
    Set the Locale for the Time Picker.
    void
    setManualValidation(boolean enabled)
     
    void
    setMax(LocalTime max)
    Sets the maximum time in the time picker.
    void
    setMin(LocalTime min)
    Sets the minimum time in the time picker.
    void
    setPlaceholder(String placeholder)
    Sets the placeholder text that should be displayed in the input element, when the user has not entered a value.
    void
    setRequired(boolean required)
    Sets whether the time picker is marked as input required.
    void
    setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
     
    void
    setStep(Duration step)
    Sets the step property of the time picker using duration.
    void
    setValue(LocalTime value)
    Sets the selected time value of the component.
    protected void
    validate()
    Performs server-side validation of the current value.

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

    getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

    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, 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 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.shared.HasValidationProperties

    getErrorMessage, isInvalid, setErrorMessage, setInvalid

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

    addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty

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

    isReadOnly, isRequiredIndicatorVisible, setReadOnly

  • Constructor Details

    • TimePicker

      public TimePicker()
      Default constructor.

    • TimePicker

      public TimePicker(LocalTime time)
      Convenience constructor to create a time picker with a pre-selected time.
      Parameters:
      time - the pre-selected time in the picker

    • TimePicker

      public TimePicker(String label)
      Convenience constructor to create a time picker with a label.
      Parameters:
      label - the label describing the time picker
      See Also:

    • TimePicker

      public TimePicker(String label, LocalTime time)
      Convenience constructor to create a time picker with a pre-selected time and a label.
      Parameters:
      label - the label describing the time picker
      time - the pre-selected time in the picker

    • TimePicker

      public TimePicker(com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>> listener)
      Convenience constructor to create a time picker with a HasValue.ValueChangeListener.
      Parameters:
      listener - the listener to receive value change events
      See Also:
      • AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

    • TimePicker

      public TimePicker(LocalTime time, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>> listener)
      Convenience constructor to create a time picker with a pre-selected time and HasValue.ValueChangeListener.
      Parameters:
      time - the pre-selected time in the picker
      listener - the listener to receive value change events
      See Also:
      • AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

    • TimePicker

      public TimePicker(String label, LocalTime time, com.vaadin.flow.component.HasValue.ValueChangeListener<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>> listener)
      Convenience constructor to create a time picker with a label, a pre-selected time and a HasValue.ValueChangeListener.
      Parameters:
      label - the label describing the time picker
      time - the pre-selected time in the picker
      listener - the listener to receive value change events
      See Also:
      • setLabel(String)
      • AbstractField.addValueChangeListener(HasValue.ValueChangeListener)

  • Method Details

    • setLabel

      public void setLabel(String label)
      Sets the label for the time picker.
      Specified by:
      setLabel in interface com.vaadin.flow.component.HasLabel
      Parameters:
      label - value for the label property in the time picker

    • setValue

      public void setValue(LocalTime value)
      Sets the selected time value of the component. The value can be cleared by setting null.

      The value will be truncated to millisecond precision, as that is the maximum that the time picker supports. This means that AbstractField.getValue() might return a different value than what was passed in.

      Specified by:
      setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<TimePicker,LocalTime>,LocalTime>
      Overrides:
      setValue in class com.vaadin.flow.component.AbstractField<TimePicker,LocalTime>
      Parameters:
      value - the LocalTime instance representing the selected time, or null

    • getLabel

      public String getLabel()
      Gets the label of the time picker.
      Specified by:
      getLabel in interface com.vaadin.flow.component.HasLabel
      Returns:
      the label property of the time picker

    • setAriaLabel

      public void setAriaLabel(String ariaLabel)
      Specified by:
      setAriaLabel in interface com.vaadin.flow.component.HasAriaLabel

    • getAriaLabel

      public Optional<String> getAriaLabel()
      Specified by:
      getAriaLabel in interface com.vaadin.flow.component.HasAriaLabel

    • setAriaLabelledBy

      public void setAriaLabelledBy(String labelledBy)
      Specified by:
      setAriaLabelledBy in interface com.vaadin.flow.component.HasAriaLabel

    • getAriaLabelledBy

      public Optional<String> getAriaLabelledBy()
      Specified by:
      getAriaLabelledBy in interface com.vaadin.flow.component.HasAriaLabel

    • getDefaultValidator

      public com.vaadin.flow.data.binder.Validator<LocalTime> getDefaultValidator()
      Specified by:
      getDefaultValidator in interface com.vaadin.flow.data.binder.HasValidator<LocalTime>

    • addValidationStatusChangeListener

      public com.vaadin.flow.shared.Registration addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<LocalTime> listener)
      Specified by:
      addValidationStatusChangeListener in interface com.vaadin.flow.data.binder.HasValidator<LocalTime>

    • isInputValuePresent

      @Synchronize(property="_hasInputValue", value="has-input-value-changed") protected boolean isInputValuePresent()
      Returns whether the input element has a value or not.
      Returns:
      true if the input element's value is populated, false otherwise

    • setPlaceholder

      public void setPlaceholder(String placeholder)
      Sets the placeholder text that should be displayed in the input element, when the user has not entered a value.
      Parameters:
      placeholder - the placeholder text

    • getPlaceholder

      public String getPlaceholder()
      The placeholder text that should be displayed in the input element, when the user has not entered a value.
      Returns:
      the placeholder property of the time picker

    • setRequired

      public void setRequired(boolean required)
      Sets whether the time picker is marked as input required.
      Parameters:
      required - the boolean value to set

    • setRequiredIndicatorVisible

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

    • isRequired

      public boolean isRequired()
      Determines whether the time picker is marked as input required.

      This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

      Returns:
      true if the input is required, false otherwise

    • setStep

      public void setStep(Duration step)
      Sets the step property of the time picker using duration. It specifies the intervals for the displayed items in the time picker dropdown and also the displayed time format.

      The set step needs to evenly divide a day or an hour and has to be larger than 0 milliseconds. By default, the format is hh:mm (same as * Duration.ofHours(1)

      If the step is less than 60 seconds, the format will be changed to hh:mm:ss and it can be in hh:mm:ss.fff format, when the step is less than 1 second.

      NOTE: If the step is less than 900 seconds, the dropdown is hidden.

      NOTE: changing the step to a larger duration can cause a new HasValue.ValueChangeEvent to be fired if some parts (eg. seconds) is discarded from the value.

      Parameters:
      step - the step to set, not null and should divide a day or an hour evenly

    • getStep

      public Duration getStep()
      Gets the step of the time picker.

      This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

      Returns:
      the step property from the picker, unit seconds

    • addInvalidChangeListener

      public com.vaadin.flow.shared.Registration addInvalidChangeListener(com.vaadin.flow.component.ComponentEventListener<TimePicker.InvalidChangeEvent> listener)
      Adds a listener for invalid-changed events fired by the webcomponent.
      Parameters:
      listener - the listener
      Returns:
      a Registration for removing the event listener

    • setManualValidation

      public void setManualValidation(boolean enabled)
      Specified by:
      setManualValidation in interface com.vaadin.flow.component.HasValidation

    • validate

      protected void validate()
      Performs server-side validation of the current value. This is needed because it is possible to circumvent the client-side validation constraints using browser development tools.

    • onAttach

      protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
      Overrides:
      onAttach in class com.vaadin.flow.component.Component

    • setLocale

      public void setLocale(Locale locale)
      Set the Locale for the Time Picker. The displayed time will be formatted by the browser using the given locale.

      By default, the locale is null until the component is attached to an UI, and then locale is set to UI.getLocale(), unless a locale has been explicitly set before that.

      The time formatting is done in the browser using the Date.toLocaleTimeString() function.

      If for some reason the browser doesn't support the given locale, the en-US locale is used.

      NOTE: only the language + country/region codes are used. This means that the script and variant information is not used and supported. NOTE: timezone related data is not supported. NOTE: changing the locale does not cause a new HasValue.ValueChangeEvent to be fired.

      Parameters:
      locale - the locale set to the time picker, cannot be [@code null}

    • getLocale

      public Locale getLocale()
      Gets the Locale for this time picker.

      By default, the locale is null until the component is attached to an UI, and then locale is set to UI.getLocale(), unless setLocale(Locale) has been explicitly called before that.

      Overrides:
      getLocale in class com.vaadin.flow.component.Component
      Returns:
      the locale used for this time picker

    • setMin

      public void setMin(LocalTime min)
      Sets the minimum time in the time picker. Times before that will be disabled in the popup.
      Parameters:
      min - the minimum time that is allowed to be selected, or null to remove any minimum constraints

    • getMin

      public LocalTime getMin()
      Gets the minimum time in the time picker. Time before that will be disabled in the popup.
      Returns:
      the minimum time that is allowed to be selected, or null if there's no minimum

    • setMax

      public void setMax(LocalTime max)
      Sets the maximum time in the time picker. Times after that will be disabled in the popup.
      Parameters:
      max - the maximum time that is allowed to be selected, or null to remove any maximum constraints

    • getMax

      public LocalTime getMax()
      Gets the maximum time in the time picker. Times after that will be disabled in the popup.
      Returns:
      the maximum time that is allowed to be selected, or null if there's no maximum

    • getSupportedAvailableLocales

      public static Stream<Locale> getSupportedAvailableLocales()
      Returns a stream of all the available locales that are supported by the time picker component.

      This is a shorthand for Locale.getAvailableLocales() where all locales without the Locale.getLanguage() have been filtered out, as the browser cannot localize the time for those.

      Returns:
      a stream of the available locales that are supported by the time picker component
      See Also: