Module javafx.base
Package javafx.util.converter

Class DateTimeStringConverter

java.lang.Object
javafx.util.StringConverter<Date>
javafx.util.converter.DateTimeStringConverter
Direct Known Subclasses:
DateStringConverter, TimeStringConverter
public class DateTimeStringConverter extends StringConverter<Date>

StringConverter implementation for Date values that represent a date and time.

Since:
JavaFX 2.1
See Also:

  • Field Details

    • locale

      @Deprecated(forRemoval=true, since="17") protected final Locale locale
      Deprecated, for removal: This API element is subject to removal in a future version.
      This field was exposed erroneously and will be removed in a future version.

    • pattern

      @Deprecated(forRemoval=true, since="17") protected final String pattern
      Deprecated, for removal: This API element is subject to removal in a future version.
      This field was exposed erroneously and will be removed in a future version.

    • dateFormat

      @Deprecated(forRemoval=true, since="17") protected final DateFormat dateFormat
      Deprecated, for removal: This API element is subject to removal in a future version.
      This field was exposed erroneously and will be removed in a future version.

    • dateStyle

      @Deprecated(forRemoval=true, since="17") protected final int dateStyle
      Deprecated, for removal: This API element is subject to removal in a future version.
      This field was exposed erroneously and will be removed in a future version.
      Since:
      JavaFX 8u40

    • timeStyle

      @Deprecated(forRemoval=true, since="17") protected final int timeStyle
      Deprecated, for removal: This API element is subject to removal in a future version.
      This field was exposed erroneously and will be removed in a future version.
      Since:
      JavaFX 8u40

  • Constructor Details

    • DateTimeStringConverter

      public DateTimeStringConverter()
      Create a StringConverter for Date values, using DateFormat.DEFAULT styles for date and time.

    • DateTimeStringConverter

      public DateTimeStringConverter(int dateStyle, int timeStyle)
      Create a StringConverter for Date values, using specified DateFormat styles for date and time.
      Parameters:
      dateStyle - the given formatting style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.
      timeStyle - the given formatting style. For example, DateFormat.SHORT for "h:mm a" in the US locale.
      Since:
      JavaFX 8u40

    • DateTimeStringConverter

      public DateTimeStringConverter(Locale locale)
      Create a StringConverter for Date values, using the specified locale and DateFormat.DEFAULT styles for date and time.
      Parameters:
      locale - the given locale.

    • DateTimeStringConverter

      public DateTimeStringConverter(Locale locale, int dateStyle, int timeStyle)
      Create a StringConverter for Date values, using specified locale and DateFormat styles for date and time.
      Parameters:
      locale - the given locale.
      dateStyle - the given formatting style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.
      timeStyle - the given formatting style. For example, DateFormat.SHORT for "h:mm a" in the US locale.
      Since:
      JavaFX 8u40

    • DateTimeStringConverter

      public DateTimeStringConverter(String pattern)
      Create a StringConverter for Date values, using the specified pattern.
      Parameters:
      pattern - the pattern describing the date and time format.

    • DateTimeStringConverter

      public DateTimeStringConverter(Locale locale, String pattern)
      Create a StringConverter for Date values, using the specified locale and pattern.
      Parameters:
      locale - the given locale.
      pattern - the pattern describing the date and time format.

    • DateTimeStringConverter

      public DateTimeStringConverter(DateFormat dateFormat)
      Create a StringConverter for Date values, using the specified DateFormat formatter.
      Parameters:
      dateFormat - the DateFormat to be used for formatting and parsing.

  • Method Details

    • fromString

      public Date fromString(String value)
      Converts the string provided into an object defined by the specific converter. Format of the string and type of the resulting object is defined by the specific converter.
      Specified by:
      fromString in class StringConverter<Date>
      Parameters:
      value - the String to convert
      Returns:
      an object representation of the string passed in.

    • toString

      public String toString(Date value)
      Converts the object provided into its string form. Format of the returned string is defined by the specific converter.
      Specified by:
      toString in class StringConverter<Date>
      Parameters:
      value - the object of type T to convert
      Returns:
      a string representation of the object passed in

    • getDateFormat

      @Deprecated(forRemoval=true, since="17") protected DateFormat getDateFormat()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method exposes internal implementation details and will be removed in a future version.

      Return a DateFormat instance to use for formatting and parsing in this StringConverter.

      Returns:
      a DateFormat instance for formatting and parsing in this StringConverter