DateTimeFormElementConfiguration (Bootstrap UI Module 3.1.0.RELEASE API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<String,Object>
  - - com.foreach.across.modules.bootstrapui.elements.DateTimeFormElementConfiguration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>
```
public class DateTimeFormElementConfiguration
extends HashMap<String,Object>
```
Configuration class for a DateTimeFormElement based on Tempus Dominus datepicker.

Author:

Arne Vandamme

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DateTimeFormElementConfiguration.Format
Format will automatically set the patterns to be used.
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`DateTimeFormElementConfiguration.Format` Format will automatically set the patterns to be used.

Field Summary

Fields
Modifier and Type	Field and Description
`static Locale`	`DEFAULT_LOCALE`
`static ZoneId`	`DEFAULT_ZONE_ID`
`static String`	`FMT_EXPORT_JAVA`
`static String`	`FMT_EXPORT_MOMENT_DATE`
`static String`	`FMT_EXPORT_MOMENT_DATETIME`
`static String`	`FMT_EXPORT_MOMENT_TIME`
`static String`	`FMT_EXTRA_PATTERN_DATE`
`static String`	`FMT_PATTERN_DATE`
`static String`	`FMT_PATTERN_DATE_FULL`
`static String`	`FMT_PATTERN_DATETIME`
`static String`	`FMT_PATTERN_DATETIME_FULL`
`static String`	`FMT_PATTERN_TIME`
`static DateTimeFormatter`	`JAVA_DATE_TIME_FORMATTER`
`static org.apache.commons.lang3.time.FastDateFormat`	`JAVA_FORMATTER`

Constructor Summary

Constructors
Constructor and Description
`DateTimeFormElementConfiguration()`
`DateTimeFormElementConfiguration(DateTimeFormElementConfiguration.Format format)`
`DateTimeFormElementConfiguration(DateTimeFormElementConfiguration.Format format, ZoneId zoneId)`
`DateTimeFormElementConfiguration(DateTimeFormElementConfiguration existing)` Create a copy of an existing configuration.
`DateTimeFormElementConfiguration(ZoneId zoneId)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DateFormat`	`createDateFormat()`
`DateTimeFormatter`	`createDateTimeFormatter()`
`LocalDateTime`	`dateToLocalDateTime(Date date)` Converts a `Date` to a `LocalDateTime` using the configured `ZoneId`
`DateTimeFormElementConfiguration.Format`	`getFormat()` Get the format that this configuration is primarily meant for.
`ZoneId`	`getZoneId()` Get the id of the zone this configuration primarily uses to convert between date types.
`boolean`	`isLocalizePatterns()`
`Date`	`localDateTimeToDate(LocalDateTime date)` Converts a `LocalDateTime` to a `Date` using the configured `ZoneId`
`static LocalDateTime`	`localDateToLocalDateTime(LocalDate date)` Converts a `LocalDate` to a `LocalDateTime` with time equal to the start of the day.
`DateTimeFormElementConfiguration`	`localize(Locale locale)` Create a localized copy of the current configuration.
`static LocalDateTime`	`localTimeToLocalDateTime(LocalTime time)` Converts a `LocalTime` to a `LocalDateTime` with the day equal to today.
`void`	`setDateAttribute(String attributeName, Date... dates)` Set any date attribute on the configuration.
`void`	`setDateAttribute(String attributeName, LocalDate... dates)` Set any date attribute on the configuration.
`void`	`setDateAttribute(String attributeName, LocalDateTime... dates)` Set any date attribute on the configuration.
`void`	`setDateAttribute(String attributeName, LocalTime... dates)` Set any date attribute on the configuration.
`void`	`setDaysOfWeekDisabled(int... daysOfWeek)` Disables the section of days of the week, e.g.
`void`	`setDefaultDate(Date date)` Sets the picker default date/time.
`void`	`setDefaultDate(LocalDate date)` Sets the picker default date/time.
`void`	`setDefaultDate(LocalDateTime date)` Sets the picker default date/time.
`void`	`setDefaultDate(LocalTime date)` Sets the picker default date/time.
`void`	`setDisabledDates(Date... dates)` Disables selection of dates in the array, e.g.
`void`	`setDisabledDates(LocalDate... dates)` Disables selection of dates in the array, e.g.
`void`	`setDisabledDates(LocalDateTime... dates)` Disables selection of dates in the array, e.g.
`void`	`setEnabledDates(Date... dates)` Disables selection of dates NOT in the array, e.g.
`void`	`setEnabledDates(LocalDate... dates)` Disables selection of dates NOT in the array, e.g.
`void`	`setEnabledDates(LocalDateTime... dates)` Disables selection of dates NOT in the array, e.g.
`void`	`setExportPattern(String pattern)` Set the serialization format that should be used.
`void`	`setExtraPatterns(String... patterns)` Set extra input patterns that should be supported (in moment js format).
`void`	`setFormat(@NonNull DateTimeFormElementConfiguration.Format format)` This will automatically set the different attributes and patterns to be used.
`void`	`setKeepInvalid(boolean keepInvalid)` Will cause the date picker to not revert or overwrite invalid dates.
`void`	`setKeepOpen(boolean keepOpen)` Will cause the date picker to stay open after selecting a date if no time components are being used.
`void`	`setLocale(Locale locale)`
`void`	`setLocalizePatterns(boolean localizePatterns)` Set to `true` if calls to `localize(Locale)` will create a version of the current configuration adapted to the locale specified.
`void`	`setMaxDate(Date date)` Prevents date/time selections after this date
`void`	`setMaxDate(LocalDate date)` Prevents date/time selections after this date
`void`	`setMaxDate(LocalDateTime date)` Prevents date/time selections after this date
`void`	`setMaxDate(LocalTime date)` Prevents date/time selections after this date
`void`	`setMinDate(Date date)` Prevents date/time selections before this date
`void`	`setMinDate(LocalDate date)` Prevents date/time selections before this date
`void`	`setMinDate(LocalDateTime date)` Prevents date/time selections before this date
`void`	`setMinDate(LocalTime date)` Prevents date/time selections before this date
`void`	`setPattern(String pattern)` Set the primary input/output pattern in moment js format.
`void`	`setShowCalendarWeeks(boolean showCalendarWeeks)` Shows the week of the year to the left of first day of the week.
`void`	`setShowClearButton(boolean showClearButton)` Show the "Clear" button in the icon toolbar.
`void`	`setShowCloseButton(boolean showCloseButton)` Show the "Close" button in the icon toolbar.
`void`	`setShowInline(boolean showInline)` Will display the picker inline without the need of a input field.
`void`	`setShowTodayButton(boolean showTodayButton)` Show the "Today" button in the icon toolbar.
`void`	`setSideBySide(boolean sideBySide)` Shows the picker side by side when using the time and date together.
`void`	`setStepping(int minutes)` Number of minutes the up/down arrow's will move the minutes value in the time picker
`void`	`setUseCurrentDate(boolean useCurrent)` On show, will set the picker to the current date/time
`void`	`setViewDate(Date date)` This will change the viewDate without changing or setting the selected date.
`void`	`setViewDate(LocalDate date)` This will change the viewDate without changing or setting the selected date.
`void`	`setViewDate(LocalDateTime date)` This will change the viewDate without changing or setting the selected date.
`void`	`setViewDate(LocalTime date)` This will change the viewDate without changing or setting the selected date.
`void`	`setZoneId(ZoneId zoneId)` This will ensure that conversion between `Date` and `LocalDateTime`, `LocalDate`, `LocalTime` use the same time zone.

Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Field Detail
  - FMT_EXPORT_JAVA
```
public static final String FMT_EXPORT_JAVA
```
    See Also:
    
    Constant Field Values
  - FMT_EXPORT_MOMENT_DATE
```
public static final String FMT_EXPORT_MOMENT_DATE
```
    See Also:
    
    Constant Field Values
  - FMT_EXPORT_MOMENT_TIME
```
public static final String FMT_EXPORT_MOMENT_TIME
```
    See Also:
    
    Constant Field Values
  - FMT_EXPORT_MOMENT_DATETIME
```
public static final String FMT_EXPORT_MOMENT_DATETIME
```
    See Also:
    
    Constant Field Values
  - FMT_PATTERN_DATE
```
public static final String FMT_PATTERN_DATE
```
    See Also:
    
    Constant Field Values
  - FMT_PATTERN_DATE_FULL
```
public static final String FMT_PATTERN_DATE_FULL
```
    See Also:
    
    Constant Field Values
  - FMT_PATTERN_TIME
```
public static final String FMT_PATTERN_TIME
```
    See Also:
    
    Constant Field Values
  - FMT_PATTERN_DATETIME
```
public static final String FMT_PATTERN_DATETIME
```
    See Also:
    
    Constant Field Values
  - FMT_PATTERN_DATETIME_FULL
```
public static final String FMT_PATTERN_DATETIME_FULL
```
    See Also:
    
    Constant Field Values
  - FMT_EXTRA_PATTERN_DATE
```
public static final String FMT_EXTRA_PATTERN_DATE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCALE
```
public static final Locale DEFAULT_LOCALE
```
  - DEFAULT_ZONE_ID
```
public static final ZoneId DEFAULT_ZONE_ID
```
  - JAVA_FORMATTER
```
public static final org.apache.commons.lang3.time.FastDateFormat JAVA_FORMATTER
```
  - JAVA_DATE_TIME_FORMATTER
```
public static final DateTimeFormatter JAVA_DATE_TIME_FORMATTER
```
- Constructor Detail
  - DateTimeFormElementConfiguration
```
public DateTimeFormElementConfiguration()
```
  - DateTimeFormElementConfiguration
```
public DateTimeFormElementConfiguration(DateTimeFormElementConfiguration.Format format)
```
  - DateTimeFormElementConfiguration
```
public DateTimeFormElementConfiguration(ZoneId zoneId)
```
  - DateTimeFormElementConfiguration
```
public DateTimeFormElementConfiguration(DateTimeFormElementConfiguration.Format format,
                                        ZoneId zoneId)
```
  - DateTimeFormElementConfiguration
```
public DateTimeFormElementConfiguration(DateTimeFormElementConfiguration existing)
```
    Create a copy of an existing configuration.
    
    Parameters:
    
    existing - configuration to copy
- Method Detail
  - getFormat
```
public DateTimeFormElementConfiguration.Format getFormat()
```
    Get the format that this configuration is primarily meant for. This can be used for hints on icons to show etc.
    
    Returns:
    
    format instance
  - setFormat
```
public void setFormat(@NonNull
                      @NonNull DateTimeFormElementConfiguration.Format format)
```
    This will automatically set the different attributes and patterns to be used. If you want to use custom patterns, you should manually set the attributes *after* a call to format.
    
    Parameters:
    
    format - to use
  - getZoneId
```
public ZoneId getZoneId()
```
    Get the id of the zone this configuration primarily uses to convert between date types.
    
    Returns:
    
    ZoneId instance
  - setZoneId
```
public void setZoneId(ZoneId zoneId)
```
    This will ensure that conversion between Date and LocalDateTime, LocalDate, LocalTime use the same time zone.
    
    Parameters:
    
    zoneId - to use.
  - setPattern
```
public void setPattern(String pattern)
```
    Set the primary input/output pattern in moment js format. Only use this method if you manually want to change the patterns, usually setFormat(Format) would suffice.
    
    Parameters:
    
    pattern - in moment js format
  - setExtraPatterns
```
public void setExtraPatterns(String... patterns)
```
    Set extra input patterns that should be supported (in moment js format). Only use this method if you manually want to change the patterns, usually setFormat(Format) would suffice. Note that you should always add the setExportPattern(String) to the list of extra patterns as well.
    
    Parameters:
    
    patterns - in moment js format
  - setExportPattern
```
public void setExportPattern(String pattern)
```
    Set the serialization format that should be used. The value posted back will be in this format. Only use this method if you manually want to change the patterns, usually setFormat(Format) would suffice.
    
    Parameters:
    
    pattern - in moment js format
  - setLocale
```
public void setLocale(Locale locale)
```
  - setStepping
```
public void setStepping(int minutes)
```
    Number of minutes the up/down arrow's will move the minutes value in the time picker
    
    Parameters:
    
    minutes - per step
  - setMinDate
```
public void setMinDate(Date date)
```
    Prevents date/time selections before this date
  - setMinDate
```
public void setMinDate(LocalDate date)
```
    Prevents date/time selections before this date
  - setMinDate
```
public void setMinDate(LocalTime date)
```
    Prevents date/time selections before this date
  - setMinDate
```
public void setMinDate(LocalDateTime date)
```
    Prevents date/time selections before this date
  - setMaxDate
```
public void setMaxDate(Date date)
```
    Prevents date/time selections after this date
  - setMaxDate
```
public void setMaxDate(LocalDate date)
```
    Prevents date/time selections after this date
  - setMaxDate
```
public void setMaxDate(LocalTime date)
```
    Prevents date/time selections after this date
  - setMaxDate
```
public void setMaxDate(LocalDateTime date)
```
    Prevents date/time selections after this date
  - setUseCurrentDate
```
public void setUseCurrentDate(boolean useCurrent)
```
    On show, will set the picker to the current date/time
  - setDefaultDate
```
public void setDefaultDate(Date date)
```
    Sets the picker default date/time. Overrides useCurrent
  - setDefaultDate
```
public void setDefaultDate(LocalDate date)
```
    Sets the picker default date/time. Overrides useCurrent
  - setDefaultDate
```
public void setDefaultDate(LocalTime date)
```
    Sets the picker default date/time. Overrides useCurrent
  - setDefaultDate
```
public void setDefaultDate(LocalDateTime date)
```
    Sets the picker default date/time. Overrides useCurrent
  - setViewDate
```
public void setViewDate(Date date)
```
    This will change the viewDate without changing or setting the selected date.
  - setViewDate
```
public void setViewDate(LocalDate date)
```
    This will change the viewDate without changing or setting the selected date.
  - setViewDate
```
public void setViewDate(LocalTime date)
```
    This will change the viewDate without changing or setting the selected date.
  - setViewDate
```
public void setViewDate(LocalDateTime date)
```
    This will change the viewDate without changing or setting the selected date.
  - setDisabledDates
```
public void setDisabledDates(Date... dates)
```
    Disables selection of dates in the array, e.g. holidays. Matched with day granularity.
  - setDisabledDates
```
public void setDisabledDates(LocalDate... dates)
```
    Disables selection of dates in the array, e.g. holidays Matched with day granularity.
  - setDisabledDates
```
public void setDisabledDates(LocalDateTime... dates)
```
    Disables selection of dates in the array, e.g. holidays Matched with day granularity.
  - setEnabledDates
```
public void setEnabledDates(Date... dates)
```
    Disables selection of dates NOT in the array, e.g. holidays Matched with day granularity.
  - setEnabledDates
```
public void setEnabledDates(LocalDate... dates)
```
    Disables selection of dates NOT in the array, e.g. holidays Matched with day granularity.
  - setEnabledDates
```
public void setEnabledDates(LocalDateTime... dates)
```
    Disables selection of dates NOT in the array, e.g. holidays Matched with day granularity.
  - setSideBySide
```
public void setSideBySide(boolean sideBySide)
```
    Shows the picker side by side when using the time and date together.
  - setDaysOfWeekDisabled
```
public void setDaysOfWeekDisabled(int... daysOfWeek)
```
    Disables the section of days of the week, e.g. weekends.
  - setShowCalendarWeeks
```
public void setShowCalendarWeeks(boolean showCalendarWeeks)
```
    Shows the week of the year to the left of first day of the week.
  - setShowTodayButton
```
public void setShowTodayButton(boolean showTodayButton)
```
    Show the "Today" button in the icon toolbar. Clicking the "Today" button will set the calendar view and set the date to now.
  - setShowClearButton
```
public void setShowClearButton(boolean showClearButton)
```
    Show the "Clear" button in the icon toolbar. Clicking the "Clear" button will set the calendar to null.
  - setShowCloseButton
```
public void setShowCloseButton(boolean showCloseButton)
```
    Show the "Close" button in the icon toolbar.
  - setKeepOpen
```
public void setKeepOpen(boolean keepOpen)
```
    Will cause the date picker to stay open after selecting a date if no time components are being used.
  - setShowInline
```
public void setShowInline(boolean showInline)
```
    Will display the picker inline without the need of a input field.
  - setKeepInvalid
```
public void setKeepInvalid(boolean keepInvalid)
```
    Will cause the date picker to not revert or overwrite invalid dates.
  - setDateAttribute
```
public void setDateAttribute(String attributeName,
                             Date... dates)
```
    Set any date attribute on the configuration. Dates will be converted to the generic export format.
  - dateToLocalDateTime
```
public LocalDateTime dateToLocalDateTime(Date date)
```
    Converts a Date to a LocalDateTime using the configured ZoneId
  - localDateTimeToDate
```
public Date localDateTimeToDate(LocalDateTime date)
```
    Converts a LocalDateTime to a Date using the configured ZoneId
  - setDateAttribute
```
public void setDateAttribute(String attributeName,
                             LocalDate... dates)
```
    Set any date attribute on the configuration. Dates will be converted to the generic export format.
  - localDateToLocalDateTime
```
public static LocalDateTime localDateToLocalDateTime(LocalDate date)
```
    Converts a LocalDate to a LocalDateTime with time equal to the start of the day.
  - setDateAttribute
```
public void setDateAttribute(String attributeName,
                             LocalTime... dates)
```
    Set any date attribute on the configuration. Dates will be converted to the generic export format.
  - localTimeToLocalDateTime
```
public static LocalDateTime localTimeToLocalDateTime(LocalTime time)
```
    Converts a LocalTime to a LocalDateTime with the day equal to today.
  - setDateAttribute
```
public void setDateAttribute(String attributeName,
                             LocalDateTime... dates)
```
    Set any date attribute on the configuration. Dates will be converted to the generic export format.
  - isLocalizePatterns
```
public boolean isLocalizePatterns()
```
  - setLocalizePatterns
```
public void setLocalizePatterns(boolean localizePatterns)
```
    Set to true if calls to localize(Locale) will create a version of the current configuration adapted to the locale specified. If false localize calls will create an exact duplicate of the configuration, no matter the output locale. Default value is true.
    
    Parameters:
    
    localizePatterns - true if output locale should be taken into account
  - localize
```
public DateTimeFormElementConfiguration localize(Locale locale)
```
    Create a localized copy of the current configuration.
    
    Parameters:
    
    locale - for which to create a localized instance
    
    Returns:
    
    clone
  - createDateFormat
```
public DateFormat createDateFormat()
```
    Returns:
    
    A DateFormat representing the current configuration.
  - createDateTimeFormatter
```
public DateTimeFormatter createDateTimeFormatter()
```
    Returns:
    
    A DateTimeFormatter representing the current configuration.

Class DateTimeFormElementConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

FMT_EXPORT_JAVA

FMT_EXPORT_MOMENT_DATE

FMT_EXPORT_MOMENT_TIME

FMT_EXPORT_MOMENT_DATETIME

FMT_PATTERN_DATE

FMT_PATTERN_DATE_FULL

FMT_PATTERN_TIME

FMT_PATTERN_DATETIME

FMT_PATTERN_DATETIME_FULL

FMT_EXTRA_PATTERN_DATE

DEFAULT_LOCALE

DEFAULT_ZONE_ID

JAVA_FORMATTER

JAVA_DATE_TIME_FORMATTER

Constructor Detail

DateTimeFormElementConfiguration

DateTimeFormElementConfiguration

DateTimeFormElementConfiguration

DateTimeFormElementConfiguration

DateTimeFormElementConfiguration

Method Detail

getFormat

setFormat

getZoneId

setZoneId

setPattern

setExtraPatterns

setExportPattern

setLocale

setStepping

setMinDate

setMinDate

setMinDate

setMinDate

setMaxDate

setMaxDate

setMaxDate

setMaxDate

setUseCurrentDate

setDefaultDate

setDefaultDate

setDefaultDate

setDefaultDate

setViewDate

setViewDate

setViewDate

setViewDate

setDisabledDates

setDisabledDates

setDisabledDates

setEnabledDates

setEnabledDates

setEnabledDates

setSideBySide

setDaysOfWeekDisabled

setShowCalendarWeeks

setShowTodayButton

setShowClearButton

setShowCloseButton

setKeepOpen

setShowInline

setKeepInvalid

setDateAttribute

dateToLocalDateTime

localDateTimeToDate

setDateAttribute

localDateToLocalDateTime

setDateAttribute