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

Constructor Detail

• GeneratedVaadinDatePicker

  @Deprecated
  public GeneratedVaadinDatePicker​(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 GeneratedVaadinDatePicker 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

  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

• GeneratedVaadinDatePicker

  @Deprecated
  public GeneratedVaadinDatePicker​(T initialValue,
                                   T defaultValue,
                                   boolean acceptNullValues)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Constructs a new GeneratedVaadinDatePicker 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

• GeneratedVaadinDatePicker

  @Deprecated
  public GeneratedVaadinDatePicker​(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 GeneratedVaadinDatePicker 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

• GeneratedVaadinDatePicker

  @Deprecated
  public GeneratedVaadinDatePicker()

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

  Parameters:

  disabled - the boolean 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

• 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

• getInitialPositionString

  @Deprecated
  protected String getInitialPositionString()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  Date which should be visible 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 webcomponent

• setInitialPosition

  @Deprecated
  protected void setInitialPosition​(String initialPosition)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

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

• isOpenedBoolean

  @Deprecated
  @Synchronize(property="opened",
               value="opened-changed")
  protected boolean isOpenedBoolean()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  Set true to open the date selector overlay.

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

  Returns:

  the opened property from the webcomponent

• setOpened

  @Deprecated
  protected void setOpened​(boolean opened)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  Set true to open the date selector overlay.

  Parameters:

  opened - the boolean value to set

• isShowWeekNumbersBoolean

  @Deprecated
  protected boolean isShowWeekNumbersBoolean()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

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

  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 webcomponent

• setShowWeekNumbers

  @Deprecated
  protected void setShowWeekNumbers​(boolean showWeekNumbers)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  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:

  showWeekNumbers - the boolean 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 and default values:

           {
                 // An array with the full names of months starting
                 // with January.
                 monthNames: [
                   'January', 'February', 'March', 'April', 'May',
                   'June', 'July', 'August', 'September',
                   'October', 'November', 'December'
                 ],
  
                 // An array of weekday names starting with Sunday. Used
                 // in screen reader announcements.
                 weekdays: [
                   'Sunday', 'Monday', 'Tuesday', 'Wednesday',
                   'Thursday', 'Friday', 'Saturday'
                 ],
  
                 // An array of short weekday names starting with Sunday.
                 // Displayed in the calendar.
                 weekdaysShort: [
                   'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'
                 ],
  
                 // An integer indicating the first day of the week
                 // (0 = Sunday, 1 = Monday, etc.).
                 firstDayOfWeek: 0,
  
                 // Used in screen reader announcements along with week
                 // numbers, if they are displayed.
                 week: 'Week',
  
                 // Translation of the Calendar icon button title.
                 calendar: 'Calendar',
  
                 // Translation of the Clear icon button title.
                 clear: 'Clear',
  
                 // Translation of the Today shortcut button text.
                 today: 'Today',
  
                 // Translation of the Cancel button text.
                 cancel: 'Cancel',
  
                 // A function to format given Object as date string. Object is in the format { day: ..., month: ..., year: ... }
                 // Note: The argument month is 0-based. This means that January = 0 and December = 11.
                 formatDate: d => {
                   // returns a string representation of the given
                   // object in 'MM/DD/YYYY' -format
                 },
  
                 // A function to parse the given text to an Object in the format { day: ..., month: ..., year: ... }.
                 // Must properly parse (at least) text formatted by formatDate.
                 // Setting the property to null will disable keyboard input feature.
                 // Note: The argument month is 0-based. This means that January = 0 and December = 11.
                 parseDate: text => {
                   // Parses a string in 'MM/DD/YY', 'MM/DD' or 'DD' -format to
                   // an Object in the format { day: ..., month: ..., year: ... }.
                 }
  
                 // A function to format given monthName abd fullYear integer as calendar title string.
                 formatTitle: (monthName, fullYear) => {
                   return monthName + ' ' + fullYear;
                 }
               }<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 and default values:

           {
                 // An array with the full names of months starting
                 // with January.
                 monthNames: [
                   'January', 'February', 'March', 'April', 'May',
                   'June', 'July', 'August', 'September',
                   'October', 'November', 'December'
                 ],
  
                 // An array of weekday names starting with Sunday. Used
                 // in screen reader announcements.
                 weekdays: [
                   'Sunday', 'Monday', 'Tuesday', 'Wednesday',
                   'Thursday', 'Friday', 'Saturday'
                 ],
  
                 // An array of short weekday names starting with Sunday.
                 // Displayed in the calendar.
                 weekdaysShort: [
                   'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'
                 ],
  
                 // An integer indicating the first day of the week
                 // (0 = Sunday, 1 = Monday, etc.).
                 firstDayOfWeek: 0,
  
                 // Used in screen reader announcements along with week
                 // numbers, if they are displayed.
                 week: 'Week',
  
                 // Translation of the Calendar icon button title.
                 calendar: 'Calendar',
  
                 // Translation of the Clear icon button title.
                 clear: 'Clear',
  
                 // Translation of the Today shortcut button text.
                 today: 'Today',
  
                 // Translation of the Cancel button text.
                 cancel: 'Cancel',
  
                 // A function to format given Object as date string. Object is in the format { day: ..., month: ..., year: ... }
                 // Note: The argument month is 0-based. This means that January = 0 and December = 11.
                 formatDate: d => {
                   // returns a string representation of the given
                   // object in 'MM/DD/YYYY' -format
                 },
  
                 // A function to parse the given text to an Object in the format { day: ..., month: ..., year: ... }.
                 // Must properly parse (at least) text formatted by formatDate.
                 // Setting the property to null will disable keyboard input feature.
                 // Note: The argument month is 0-based. This means that January = 0 and December = 11.
                 parseDate: text => {
                   // Parses a string in 'MM/DD/YY', 'MM/DD' or 'DD' -format to
                   // an Object in the format { day: ..., month: ..., year: ... }.
                 }
  
                 // A function to format given monthName and fullYear integer as calendar title string.
                 formatTitle: (monthName, fullYear) => {
                   return monthName + ' ' + fullYear;
                 }
               }
       
   

  Parameters:

  i18n - the JsonObject value to set

• getMinAsStringString

  @Deprecated
  protected String getMinAsStringString()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  The earliest date that can be selected. All earlier dates will be disabled.

  Supported date formats:

  • ISO 8601 "YYYY-MM-DD" (default)
  • 6-digit extended ISO 8601 "+YYYYYY-MM-DD", "-YYYYYY-MM-DD"

    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

• setMinAsString

  @Deprecated
  protected void setMinAsString​(String minAsString)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  The earliest date that can be selected. All earlier dates will be disabled.

  Supported date formats:

  • ISO 8601 "YYYY-MM-DD" (default)
  • 6-digit extended ISO 8601 "+YYYYYY-MM-DD", "-YYYYYY-MM-DD"

  Parameters:

  minAsString - the String value to set

• getMaxAsStringString

  @Deprecated
  protected String getMaxAsStringString()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  The latest date that can be selected. All later dates will be disabled.

  Supported date formats:

  • ISO 8601 "YYYY-MM-DD" (default)
  • 6-digit extended ISO 8601 "+YYYYYY-MM-DD", "-YYYYYY-MM-DD"

    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

• setMaxAsString

  @Deprecated
  protected void setMaxAsString​(String maxAsString)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  The latest date that can be selected. All later dates will be disabled.

  Supported date formats:

  • ISO 8601 "YYYY-MM-DD" (default)
  • 6-digit extended ISO 8601 "+YYYYYY-MM-DD", "-YYYYYY-MM-DD"

  Parameters:

  maxAsString - 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. If this is set, the label will always float.

  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. If this is set, the label will always float.

  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 make this element read-only.

  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 make this element read-only.

  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:

  This property is set to true when the control value invalid.

  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:

  This property is set to true when the control value invalid.

  Parameters:

  invalid - the boolean value to set

• open

  @Deprecated
  protected void open()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  Opens the dropdown.

• close

  @Deprecated
  protected void close()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Description copied from corresponding location in WebComponent:

  Closes the dropdown.

• validate

  @Deprecated
  @NotSupported
  protected void validate​(String value)

  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.

  Parameters:

  value - Value to validate. Optional, defaults to user's input value.

• checkValidity

  @Deprecated
  @NotSupported
  protected void checkValidity​(String value)

  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)

  Override the checkValidity method for custom validations.

  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.

  Parameters:

  value - Value to validate. Optional, defaults to the selected date.

• addChangeListener

  @Deprecated
  protected Registration addChangeListener​(ComponentEventListener<GeneratedVaadinDatePicker.ChangeEvent<R>> listener)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Adds a listener for change events fired by the webcomponent.

  Parameters:

  listener - the listener

  Returns:

  a Registration for removing the event listener

• addInvalidChangeListener

  @Deprecated
  protected Registration addInvalidChangeListener​(ComponentEventListener<DatePicker.InvalidChangeEvent<DatePicker>> listener)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Adds a listener for invalid-changed events fired by the webcomponent.

  Parameters:

  listener - the listener

  Returns:

  a Registration for removing the event listener

• addOpenedChangeListener

  @Deprecated
  protected Registration addOpenedChangeListener​(ComponentEventListener<DatePicker.OpenedChangeEvent<DatePicker>> listener)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Adds a listener for opened-changed events fired by the webcomponent.

  Parameters:

  listener - the listener

  Returns:

  a Registration for removing the event listener

• addToPrefix

  @Deprecated
  protected void addToPrefix​(Component... components)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Adds the given components as children of this component at the slot 'prefix'.

  Parameters:

  components - The components to add.

  See Also:

  MDN page about slots, Spec website about slots

• remove

  @Deprecated
  protected void remove​(Component... components)

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Removes the given child components from this component.

  Parameters:

  components - The components to remove.

  Throws:

  IllegalArgumentException - if any of the components is not a child of this component.

• removeAll

  @Deprecated
  protected void removeAll()

  Deprecated.

  since v23.3, generated classes will be removed in v24.

  Removes all contents from this component, this includes child components, text content as well as child elements that have been added directly to this component using the Element API.