Package com.vaadin.flow.component.timepicker

Class GeneratedVaadinTimePicker<R extends GeneratedVaadinTimePicker<R,​T>,​T>

    • Constructor Detail

      • GeneratedVaadinTimePicker

        @Deprecated
public GeneratedVaadinTimePicker​(T initialValue,
                                 T defaultValue,
                                 Class<P> elementPropertyType,
                                 SerializableFunction<P,​T> presentationToModel,
                                 SerializableFunction<T,​P> modelToPresentation,
                                 boolean isInitialValueOptional)
        Deprecated.
        since v23.3, generated classes will be removed in v24.
        Constructs a new GeneratedVaadinTimePicker component with the given arguments.

        If isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set.

        Type Parameters:
        P - the property type
        Parameters:
        initialValue - the initial value to set to the value
        defaultValue - the default value to use if the value isn't defined
        elementPropertyType - the type of the element property
        presentationToModel - a function that converts a string value to a model value
        modelToPresentation - a function that converts a model value to a string value
        isInitialValueOptional - if isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set

      • GeneratedVaadinTimePicker

        @Deprecated
public GeneratedVaadinTimePicker​(T initialValue,
                                 T defaultValue,
                                 Class<P> elementPropertyType,
                                 SerializableFunction<P,​T> presentationToModel,
                                 SerializableFunction<T,​P> modelToPresentation)
        Deprecated.
        since v23.3, generated classes will be removed in v24.
        Constructs a new GeneratedVaadinTimePicker component with the given arguments.
        Type Parameters:
        P - the property type
        Parameters:
        initialValue - the initial value to set to the value
        defaultValue - the default value to use if the value isn't defined
        elementPropertyType - the type of the element property
        presentationToModel - a function that converts a string value to a model value
        modelToPresentation - a function that converts a model value to a string value

      • GeneratedVaadinTimePicker

        @Deprecated
public GeneratedVaadinTimePicker​(T initialValue,
                                 T defaultValue,
                                 boolean acceptNullValues)
        Deprecated.
        since v23.3, generated classes will be removed in v24.
        Constructs a new GeneratedVaadinTimePicker component with the given arguments.
        Parameters:
        initialValue - the initial value to set to the value
        defaultValue - the default value to use if the value isn't defined
        acceptNullValues - whether null is accepted as a model value

      • GeneratedVaadinTimePicker

        @Deprecated
public GeneratedVaadinTimePicker​(T initialValue,
                                 T defaultValue,
                                 Class<P> elementPropertyType,
                                 SerializableBiFunction<R,​P,​T> presentationToModel,
                                 SerializableBiFunction<R,​T,​P> modelToPresentation)
        Deprecated.
        since v23.3, generated classes will be removed in v24.
        Constructs a new GeneratedVaadinTimePicker component with the given arguments.
        Type Parameters:
        P - the property type
        Parameters:
        initialValue - the initial value to set to the value
        defaultValue - the default value to use if the value isn't defined
        elementPropertyType - the type of the element property
        presentationToModel - a function that accepts this component and a property value and returns a model value
        modelToPresentation - a function that accepts this component and a model value and returns a property value

      • GeneratedVaadinTimePicker

        @Deprecated
public GeneratedVaadinTimePicker()
        Deprecated.
        since v23.3, generated classes will be removed in v24.
        Default constructor.

    • Method Detail

      • isAutofocusBoolean

        @Deprecated
protected boolean isAutofocusBoolean()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Specify that this control should have input focus when the page loads.

        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 autofocus property from the webcomponent

      • setAutofocus

        @Deprecated
protected void setAutofocus​(boolean autofocus)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Specify that this control should have input focus when the page loads.

        Parameters:
        autofocus - the boolean value to set

      • isDisabledBoolean

        @Deprecated
protected boolean isDisabledBoolean()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to disable this input.

        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 disabled property from the webcomponent

      • setDisabled

        @Deprecated
protected void setDisabled​(boolean disabled)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to disable this input.

        Parameters:
        disabled - the boolean value to set

      • getNameString

        @Deprecated
protected String getNameString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The name of this element.

        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 name property from the webcomponent

      • setName

        @Deprecated
protected void setName​(String name)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The name of this element.

        Parameters:
        name - the String value to set

      • getLabelString

        @Deprecated
protected String getLabelString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The label for this element.

        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 label property from the webcomponent

      • setLabel

        @Deprecated
protected void setLabel​(String label)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The label for this element.

        Parameters:
        label - the String value to set

      • isRequiredBoolean

        @Deprecated
protected boolean isRequiredBoolean()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to mark the input as 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:
        the required property from the webcomponent

      • setRequired

        @Deprecated
protected void setRequired​(boolean required)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to mark the input as required.

        Parameters:
        required - the boolean value to set

      • isPreventInvalidInputBoolean

        @Deprecated
protected boolean isPreventInvalidInputBoolean()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to prevent the user from entering invalid input.

        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 preventInvalidInput property from the webcomponent

      • setPreventInvalidInput

        @Deprecated
protected void setPreventInvalidInput​(boolean preventInvalidInput)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to prevent the user from entering invalid input.

        Parameters:
        preventInvalidInput - the boolean value to set

      • getPatternString

        @Deprecated
protected String getPatternString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        A pattern to validate the input with.

        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 pattern property from the webcomponent

      • setPattern

        @Deprecated
protected void setPattern​(String pattern)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        A pattern to validate the input with.

        Parameters:
        pattern - the String value to set

      • getErrorMessageString

        @Deprecated
protected String getErrorMessageString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The error message to display when the input is invalid.

        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 errorMessage property from the webcomponent

      • setErrorMessage

        @Deprecated
protected void setErrorMessage​(String errorMessage)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The error message to display when the input is invalid.

        Parameters:
        errorMessage - the String value to set

      • getPlaceholderString

        @Deprecated
protected String getPlaceholderString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        A placeholder string in addition to the label.

        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 from the webcomponent

      • setPlaceholder

        @Deprecated
protected void setPlaceholder​(String placeholder)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        A placeholder string in addition to the label.

        Parameters:
        placeholder - the String value to set

      • isReadonlyBoolean

        @Deprecated
protected boolean isReadonlyBoolean()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to prevent user picking a date or typing in the input.

        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 readonly property from the webcomponent

      • setReadonly

        @Deprecated
protected void setReadonly​(boolean readonly)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true to prevent user picking a date or typing in the input.

        Parameters:
        readonly - the boolean value to set

      • isInvalidBoolean

        @Deprecated
protected boolean isInvalidBoolean()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true if the value is invalid.

        This property is synchronized automatically from client side when a 'invalid-changed' event happens.

        Returns:
        the invalid property from the webcomponent

      • setInvalid

        @Deprecated
protected void setInvalid​(boolean invalid)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Set to true if the value is invalid.

        Parameters:
        invalid - the boolean value to set

      • getMinString

        @Deprecated
protected String getMinString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Minimum time allowed.

        Supported time formats are in ISO 8601:

        • hh:mm
        • hh:mm:ss
        • hh:mm:ss.fff

          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 min property from the webcomponent

      • setMin

        @Deprecated
protected void setMin​(String min)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Minimum time allowed.

        Supported time formats are in ISO 8601:

        • hh:mm
        • hh:mm:ss
        • hh:mm:ss.fff
        Parameters:
        min - the String value to set

      • getMaxString

        @Deprecated
protected String getMaxString()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Maximum time allowed.

        Supported time formats are in ISO 8601:

        • hh:mm
        • hh:mm:ss
        • hh:mm:ss.fff

          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 max property from the webcomponent

      • setMax

        @Deprecated
protected void setMax​(String max)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Maximum time allowed.

        Supported time formats are in ISO 8601:

        • hh:mm
        • hh:mm:ss
        • hh:mm:ss.fff
        Parameters:
        max - the String value to set

      • getStepDouble

        @Deprecated
protected double getStepDouble()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Specifies the number of valid intervals in a day used for configuring the items displayed in the selection box.

        It also configures the precision of the value string. By default the component formats values as hh:mm but setting a step value lower than one minute or one second, format resolution changes to hh:mm:ss and hh:mm:ss.fff respectively.

        Unit must be set in seconds, and for correctly configuring intervals in the dropdown, it need to evenly divide a day.

        Note: it is possible to define step that is dividing an hour in inexact fragments (i.e. 5760 seconds which equals 1 hour 36 minutes), but it is not recommended to use it for better UX experience.

        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 webcomponent

      • setStep

        @Deprecated
protected void setStep​(double step)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Specifies the number of valid intervals in a day used for configuring the items displayed in the selection box.

        It also configures the precision of the value string. By default the component formats values as hh:mm but setting a step value lower than one minute or one second, format resolution changes to hh:mm:ss and hh:mm:ss.fff respectively.

        Unit must be set in seconds, and for correctly configuring intervals in the dropdown, it need to evenly divide a day.

        Note: it is possible to define step that is dividing an hour in inexact fragments (i.e. 5760 seconds which equals 1 hour 36 minutes), but it is not recommended to use it for better UX experience.

        Parameters:
        step - the double value to set

      • getI18nJsonObject

        @Deprecated
protected elemental.json.JsonObject getI18nJsonObject()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The object used to localize this component. To change the default localization, replace the entire i18n object or just the property you want to modify.

        The object has the following JSON structure: 

                     {
                      // A function to format given Object  as
                      // time string. Object is in the format { hours: ..., minutes: ..., seconds: ..., milliseconds: ... }
                      formatTime: (time) => {
                        // returns a string representation of the given
                        // object in 'hh' / 'hh:mm' / 'hh:mm:ss' / 'hh:mm:ss.fff' - formats
                      },

                      // A function to parse the given text to an Object in the format
                      // { hours: ..., minutes: ..., seconds: ..., milliseconds: ... }.
                      // Must properly parse (at least) text
                      // formatted by formatTime.
                      parseTime: text => {
                        // Parses a string in object/string that can be formatted by formatTime.
                      }

                      // Translation of the time selector icon button title.
                      selector: 'Time selector',

                      // Translation of the time selector clear button title.
                      clear: 'Clear'
                    }
                  <p>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 i18n property from the webcomponent

      • setI18n

        @Deprecated
protected void setI18n​(elemental.json.JsonObject i18n)
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        The object used to localize this component. To change the default localization, replace the entire i18n object or just the property you want to modify.

        The object has the following JSON structure: 

                     {
                      // A function to format given Object as
                      // time string. Object is in the format { hours: ..., minutes: ..., seconds: ..., milliseconds: ... }
                      formatTime: (time) => {
                        // returns a string representation of the given
                        // object in 'hh' / 'hh:mm' / 'hh:mm:ss' / 'hh:mm:ss.fff' - formats
                      },

                      // A function to parse the given text to an Object in the format
                      // { hours: ..., minutes: ..., seconds: ..., milliseconds: ... }.
                      // Must properly parse (at least) text
                      // formatted by formatTime.
                      parseTime: text => {
                        // Parses a string in object/string that can be formatted by formatTime.
                      }

                      // Translation of the time selector icon button title.
                      selector: 'Time selector',

                      // Translation of the time selector clear button title.
                      clear: 'Clear'
                    }
        Parameters:
        i18n - the JsonObject value to set

      • validate

        @NotSupported
@Deprecated
protected void validate()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Returns true if value is valid, and sets the invalid flag appropriately.

        This function is not supported by Flow because it returns a boolean. Functions with return types different than void are not supported at this moment.

      • checkValidity

        @Deprecated
protected void checkValidity()
        Deprecated.
        since v23.3, generated classes will be removed in v24.

        Description copied from corresponding location in WebComponent:

        Returns true if the current input value satisfies all constraints (if any)

        You can override the checkValidity method for custom validations.