Package com.vaadin.flow.component.datepicker

Class DatePicker

    • Method Detail

      • setMin

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

      • getMin

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

      • setMax

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

      • getMax

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

      • setLocale

        public void setLocale​(Locale locale)
        Set the Locale for the Date Picker. The displayed date will be matched to the format used in that locale.

        NOTE:Supported formats are MM/DD/YYYY, DD/MM/YYYY and YYYY/MM/DD. Browser compatibility can be different based on the browser and mobile devices, you can check here for more details: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleDateString

        When using custom date formats through setI18n(DatePickerI18n), setting a locale has no effect, and dates will always be parsed and displayed using the custom date format.

        Parameters:
        locale - the locale set to the date picker, cannot be null

      • getLocale

        public Locale getLocale()
        Gets the Locale for this date picker
        Overrides:
        getLocale in class Component
        Returns:
        the locale used for this picker

      • onAttach

        protected void onAttach​(AttachEvent attachEvent)
        Description copied from class: Component
        Called when the component is attached to a UI.

        The default implementation does nothing.

        This method is invoked before the AttachEvent is fired for the component.

        Overrides:
        onAttach in class Component
        Parameters:
        attachEvent - the attach event

      • getI18n

        public DatePicker.DatePickerI18n getI18n()
        Gets the internationalization object previously set for this component.

        Note: updating the object content that is gotten from this method will not update the lang on the component if not set back using setI18n(DatePickerI18n)

        Returns:
        the i18n object. It will be null, If the i18n properties weren't set.

      • setI18n

        public void setI18n​(DatePicker.DatePickerI18n i18n)
        Sets the internationalization properties for this component.
        Parameters:
        i18n - the internationalized properties, not null

      • getErrorMessage

        public String getErrorMessage()
        Gets the current error message from the datepicker.
        Specified by:
        getErrorMessage in interface HasValidation
        Returns:
        the current error message

      • getDefaultValidator

        public Validator<LocalDate> getDefaultValidator()
        Description copied from interface: HasValidator
        Returns a validator that checks the state of the Value. This should be overridden for components with internal value conversion or validation, e.g. when the user is providing a string that has to be parsed into a date. An invalid input from user will be exposed to a Binder and can be seen as a validation failure.
        Specified by:
        getDefaultValidator in interface HasValidator<LocalDate>
        Returns:
        state validator

      • addValidationStatusChangeListener

        public Registration addValidationStatusChangeListener​(ValidationStatusChangeListener<LocalDate> listener)
        Description copied from interface: HasValidator
        Enables the implementing components to notify changes in their validation status to the observers.

        Note: This method can be overridden by the implementing classes e.g. components, to enable the associated Binder.Binding instance subscribing for their validation change events and revalidate itself.

        This method primarily designed for notifying the Binding about the validation status changes of a bound component at the client-side. WebComponents such as <vaadin-date-picker> or any other component that accept a formatted text as input should be able to communicate their invalid status to their server-side instance, and a bound server-side component instance must notify its binding about this validation status change as well. When the binding instance revalidates, a chain of validators and convertors get executed one of which is the default validator provided by HasValidator.getDefaultValidator(). Thus, In order for the binding to be able to show/clear errors for its associated bound field, it is important that implementing components take that validation status into account while implementing any validator and converter including HasValidator.getDefaultValidator(). Here is an example: 

         @Tag("date-picker-demo")
 public class DatePickerDemo implements HasValidator<LocalDate> {

     // Each web component has a way to communicate its validation status
     // to its server-side component instance. The following clientSideValid
     // state is introduced here just for the sake of simplicity of this code
     // snippet:
     boolean clientSideValid = true;

     /**
      * Note how clientSideValid engaged in the definition
      * of this method. It is important to reflect this status either
      * in the returning validation result of this method or any other
      * validation that is associated with this component.
      */
     @Override
     public Validator getDefaultValidator() {
          return (value, valueContext) -> clientSideValid ? ValidationResult.ok()
                 : ValidationResult.error("Invalid date format");
     }

     private final Collection<ValidationStatusChangeListener<LocalDate>>
         validationStatusListeners = new ArrayList<>();

     /**
      * This enables the binding to subscribe for the validation status
      * change events that are fired by this component and revalidate
      * itself respectively.
      */
     @Override
     public Registration addValidationStatusChangeListener(
             ValidationStatusChangeListener<LocalDate> listener) {
         validationStatusListeners.add(listener);
         return () -> validationStatusListeners.remove(listener);
     }

     private void fireValidationStatusChangeEvent(
             boolean newValidationStatus) {
         if (this.clientSideValid != newValidationStatus) {
             this.clientSideValid = newValidationStatus;
             var event = new ValidationStatusChangeEvent<>(this,
                     newValidationStatus);
             validationStatusListeners.forEach(
                     listener -> listener.validationStatusChanged(event));
         }
     }
 }
        Specified by:
        addValidationStatusChangeListener in interface HasValidator<LocalDate>
        Returns:
        Registration of the added listener.
        See Also:
        Binder.BindingBuilderImpl.bind(ValueProvider, Setter)

      • isInvalid

        public boolean isInvalid()
        Gets the validity of the datepicker output.

        return true, if the value is invalid.

        Specified by:
        isInvalid in interface HasValidation
        Returns:
        the validity property from the datepicker

      • getLabel

        public String getLabel()
        Gets the label of the datepicker.
        Specified by:
        getLabel in interface HasLabel
        Returns:
        the label property of the datePicker

      • getPlaceholder

        public String getPlaceholder()
        Gets the placeholder of the datepicker.

        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 placeholder property of the datePicker

      • setInitialPosition

        public void setInitialPosition​(LocalDate initialPosition)
        Date which should be visible when there is no value selected.

        The same date formats as for the value property are supported.

        Parameters:
        initialPosition - the LocalDate value to set

      • getInitialPosition

        public LocalDate getInitialPosition()
        Get the visible date when there is no value selected.

        The same date formats as for the value property are supported.

        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 initialPosition property from the datepicker

      • setRequiredIndicatorVisible

        public void setRequiredIndicatorVisible​(boolean required)
        Description copied from interface: HasValue
        Sets the required indicator visible or not.

        If set visible, it is visually indicated in the user interface.

        The method is intended to be used with Binder which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(false). It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their own setRequired method which should be called in case the client-side validation is required.

        Specified by:
        setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<DatePicker,​LocalDate>,​LocalDate>
        Specified by:
        setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<DatePicker,​LocalDate>,​LocalDate>
        Parameters:
        required - true to make the required indicator visible, false if not

      • isRequired

        public boolean isRequired()
        Determines whether the datepicker 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

      • setWeekNumbersVisible

        public void setWeekNumbersVisible​(boolean weekNumbersVisible)
        Set the week number visible in the DatePicker.

        Set true to display ISO-8601 week numbers in the calendar.

        Notice that displaying week numbers is only supported when i18n.firstDayOfWeek is 1 (Monday).

        Parameters:
        weekNumbersVisible - the boolean value to set

      • isWeekNumbersVisible

        public boolean isWeekNumbersVisible()
        Get the state of showWeekNumbers property of the datepicker

        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 showWeekNumbers property from the datepicker

      • setOpened

        public void setOpened​(boolean opened)
        Sets the opened property of the datepicker to open or close its overlay.
        Overrides:
        setOpened in class GeneratedVaadinDatePicker<DatePicker,​LocalDate>
        Parameters:
        opened - true to open the datepicker overlay, false to close it

      • isOpened

        public boolean isOpened()
        Gets the states of the drop-down for the datepicker
        Returns:
        true if the drop-down is opened, false otherwise

      • getName

        public String getName()
        Gets the name of the DatePicker.
        Returns:
        the name property from the DatePicker

      • setAutoOpen

        public void setAutoOpen​(boolean autoOpen)
        When auto open is enabled, the dropdown will open when the field is clicked.
        Parameters:
        autoOpen - Value for the auto open property,

      • isAutoOpen

        public boolean isAutoOpen()
        When auto open is enabled, the dropdown will open when the field is clicked.
        Returns:
        true if auto open is enabled. false otherwise. Default is true

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

      • addThemeVariants

        public void addThemeVariants​(DatePickerVariant... variants)
        Adds theme variants to the component.
        Parameters:
        variants - theme variants to add

      • removeThemeVariants

        public void removeThemeVariants​(DatePickerVariant... variants)
        Removes theme variants from the component.
        Parameters:
        variants - theme variants to remove

      • isFeatureFlagEnabled

        protected boolean isFeatureFlagEnabled​(Feature feature)
        Returns true if the given feature flag is enabled, false otherwise.

        Exposed with protected visibility to support mocking

        The method requires the VaadinService instance to obtain the available feature flags, otherwise, the feature is considered disabled.

        Parameters:
        feature - the feature flag.
        Returns:
        whether the feature flag is enabled.