com.github.lgooddatepicker.components.DatePickerSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of LGoodDatePicker Show documentation
Show all versions of LGoodDatePicker Show documentation
Java 8 Swing Date Picker. Easy to use, good looking, nice features, and
localized. Uses the JSR-310 standard.
The newest version!
package com.github.lgooddatepicker.components;
import com.github.lgooddatepicker.optionalusertools.CalendarBorderProperties;
import com.privatejgoodies.forms.layout.ColumnSpec;
import com.privatejgoodies.forms.layout.ConstantSize;
import com.privatejgoodies.forms.layout.FormLayout;
import java.awt.Color;
import java.awt.Font;
import java.awt.font.TextAttribute;
import java.util.ArrayList;
import java.util.Locale;
import java.util.Map;
import javax.swing.JTextField;
import com.github.lgooddatepicker.zinternaltools.InternalUtilities;
import com.github.lgooddatepicker.zinternaltools.ExtraDateStrings;
import com.github.lgooddatepicker.zinternaltools.TranslationSource;
import javax.swing.border.Border;
import com.github.lgooddatepicker.optionalusertools.DateVetoPolicy;
import com.github.lgooddatepicker.optionalusertools.DateHighlightPolicy;
import com.github.lgooddatepicker.optionalusertools.DateInterval;
import com.github.lgooddatepicker.optionalusertools.PickerUtilities;
import com.github.lgooddatepicker.zinternaltools.DateVetoPolicyMinimumMaximumDate;
import com.github.lgooddatepicker.zinternaltools.InternalConstants;
import java.awt.Point;
import javax.swing.border.CompoundBorder;
import javax.swing.border.EmptyBorder;
import javax.swing.border.MatteBorder;
import java.time.Clock;
import java.time.DayOfWeek;
import java.time.LocalDate;
import java.time.YearMonth;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import java.time.format.FormatStyle;
import java.time.temporal.WeekFields;
import java.util.EnumMap;
import java.util.HashMap;
import javax.swing.JButton;
import javax.swing.JLabel;
/**
* DatePickerSettings, This holds all the settings that can be customized for a DatePicker (or an
* independent CalendarPanel).
*
* A DatePickerSettings instance may be (optionally) created, customized, and passed to the date
* picker constructor. If no settings instance is supplied when a date picker is constructed, then a
* settings instance with default settings is automatically generated and used by the date picker
* class.
*
* Each and all of the setting fields are set to a default value when a DatePickerSettings object is
* constructed. This means that the programmer does not need to overwrite all (or any) of the
* available settings to use this class. They only need to change any particular settings that they
* wish to customize.
*/
public class DatePickerSettings {
/**
* DateArea, These enumerations represent areas of the components whose color can be changed.
* These values are used with the setColor() function, to set the color of various areas of the
* DatePicker or the CalendarPanel. The default color for each area is also defined here.
*
* Note: The text color of disabled (vetoed) dates in the calendar will always be grey (cannot
* be modified). This seems to be enforced by the swing setEnabled() function.
*/
public enum DateArea {
BackgroundClearLabel(new Color(240, 240, 240)),
BackgroundMonthAndYearMenuLabels(new Color(240, 240, 240)),
BackgroundMonthAndYearNavigationButtons(new JButton().getBackground()),
BackgroundCalendarPanelLabelsOnHover(new Color(184, 207, 229)),
BackgroundOverallCalendarPanel(new Color(240, 240, 240)),
BackgroundTodayLabel(new Color(240, 240, 240)),
BackgroundTopLeftLabelAboveWeekNumbers(new Color(184, 207, 229)),
CalendarBackgroundNormalDates(Color.white),
CalendarBackgroundSelectedDate(new Color(163, 184, 204)),
CalendarBackgroundVetoedDates(Color.lightGray),
CalendarBorderSelectedDate(new Color(99, 130, 191)),
CalendarDefaultBackgroundHighlightedDates(Color.green),
CalendarDefaultTextHighlightedDates(Color.black),
CalendarTextNormalDates(Color.black),
CalendarTextWeekdays(Color.black),
CalendarTextWeekNumbers(Color.black),
TextClearLabel(new JLabel().getForeground()),
TextMonthAndYearMenuLabels(new JLabel().getForeground()),
TextMonthAndYearNavigationButtons(new JButton().getForeground()),
TextTodayLabel(new JLabel().getForeground()),
TextCalendarPanelLabelsOnHover(new JLabel().getForeground()),
TextFieldBackgroundDisallowedEmptyDate(Color.pink),
TextFieldBackgroundInvalidDate(Color.white),
TextFieldBackgroundValidDate(Color.white),
TextFieldBackgroundVetoedDate(Color.white),
TextFieldBackgroundDisabled(new Color(240, 240, 240)),
DatePickerTextInvalidDate(Color.red),
DatePickerTextValidDate(Color.black),
DatePickerTextVetoedDate(Color.black),
DatePickerTextDisabled(new Color(109, 109, 109));
DateArea(Color defaultColor) {
this.defaultColor = defaultColor;
}
public Color defaultColor;
}
/**
* allowEmptyDates, This indicates whether or not empty dates are allowed in the date picker.
* Empty dates are also called "null dates". The default value is true, which allows empty
* dates. If empty dates are not allowed, but DatePickerSettings.initialDate is left set to
* null, then the initial date will be set to today's date.
*/
private boolean allowEmptyDates = true;
/**
* allowKeyboardEditing, This indicates whether or not keyboard editing is allowed for this date
* picker. If this is true, then dates can be entered into the date picker either by using the
* keyboard or the mouse. If this is false, then dates can only be selected by using the mouse.
* The default value is true. It is generally recommended to leave this setting as "true".
*
* Accessibility Impact: Disallowing the use of the keyboard, and requiring the use of the
* mouse, could impact the accessibility of your program for disabled persons.
*
* Note: This setting does not impact the automatic enforcement of valid or vetoed dates. To
* learn about the automatic date validation and enforcement for keyboard entered text, see the
* javadocs for the DatePicker class.
*/
private boolean allowKeyboardEditing = true;
/**
* borderCalendarPopup, This is the (outside) border for the calendar popup window. If this is
* null, a default border will be provided by the CustomPopup class. The default value is null.
*/
private Border borderCalendarPopup = null;
/**
* borderPropertiesList, This contains the list of border properties objects that specifies the
* colors and thicknesses of the borders in the CalendarPanel. By default, a default set of
* border properties is stored in the borderPropertiesList.
*
* Passing in "null" when setting this property will restore the default border properties. If
* you don't want the default border properties but wish to truly "clear" the border properties
* list, you could pass in an empty ArrayList.
*
* To modify the calendar borders (including individual border colors, thickness, or
* visibility), you can supply your own ArrayList of border properties. Border properties
* objects are applied in the order that they appear in the ArrayList. To learn how to set the
* CalendarBorderProperties objects, see the CalendarBorderProperties class javadocs.
*
* The default border properties have a one pixel blue border around the date labels, and two
* vertical light blue borders near the weekday labels (which match the color of the weekday
* labels). The outer top horizontal border and the outer left vertical border are invisible by
* default.
*
* The default border properties also include borders above and below the "week numbers" column
* which match the color of the week numbers labels. (However, these borders are only displayed
* when the week numbers are displayed.)
*
* Whenever the border properties list is applied, the borders are first "cleared" by setting
* all borders to the following settings: Invisible, and black color. This is true of both the
* default border properties and any programmer supplied border properties.
*
* Note: If weekNumbersDisplayed is set to false, then the borders located in the week number
* columns (Columns 1 and 2) will always be hidden.
*
* This variable will never be null.
*/
private ArrayList borderPropertiesList;
/**
* clock, A clock used to determine current date and time
* The default is to use the System Clock
*/
private Clock clock = Clock.systemDefaultZone();
/**
* colorBackgroundWeekdayLabels, This is the calendar background color for the weekday labels.
* The default color is a medium sky blue.
*/
private Color colorBackgroundWeekdayLabels = new Color(184, 207, 229);
/**
* colorBackgroundWeekNumberLabels, This is the calendar background color for the week number
* labels. The default color is a medium sky blue.
*/
private Color colorBackgroundWeekNumberLabels = new Color(184, 207, 229);
/**
* colors, This hash map holds the current color settings for different areas of the DatePicker
* or CalendarPanel. These colors can be set with the setColor() function, or retrieved with the
* getColor() function. By default, this map is populated with a set of default colors. The
* default colors for each area are defined the "Area" enums.
*/
private EnumMap colors;
/**
* defaultYearMonth, This indicates which YearMonth should be displayed by default, when no date
* is currently selected. This is used only when a when a calendar panel (or calendar popup) is
* displayed or showing. If this is set to null, then the defaultYearMonth will be
* YearMonth.now().
*/
private YearMonth defaultYearMonth = null;
/**
* enableMonthMenu, This determines whether the month popup menu is enabled or disabled. (Note:
* The month label is located in the header area of the calendar panel.) If this is true, then
* the month label will give a visual indication of any "mouse over" events, and the month menu
* will open when the month label is clicked. If this is false, then the month label will not
* indicate mouse over events, and the month menu can not be opened. The default value for this
* setting is true.
*
* Note: It is generally recommended to leave the month menu enabled. Disabling this menu can
* negatively impact calendar usability. When the month menu is disabled, the user may have to
* press the month navigation button many times to reach a desired month.
*/
private boolean enableMonthMenu = true;
/**
* enableYearMenu, This determines whether the year popup menu is enabled or disabled. (Note:
* The year label is located in the header area of the calendar panel.) If this is true, then
* the year label will give a visual indication of any "mouse over" events, and the year menu
* will open when the year label is clicked. If this is false, then the year label will not
* indicate mouse over events, and the year menu can not be opened. The default value for this
* setting is true.
*
* Note: It is generally recommended to leave the year menu enabled. Disabling this menu can
* negatively impact calendar usability. When the year menu is disabled, it may become difficult
* or effectively impossible for the user to navigate to years that are far into the past or the
* future.
*/
private boolean enableYearMenu = true;
/**
* firstDayOfWeek, This holds the day of the week that will be displayed in the far left column
* of the CalendarPanel, as the "first day of the week". The default value is generated using
* the locale of the settings instance.
*
* By default, If weekNumbersDisplayed is set to true, then the first day of the week will not
* match the setting. (weekNumbersDisplayed is false by default.) For additional details, see
* the javadocs for the following settings: "weekNumbersDisplayed", and
* "weekNumbersForceFirstDayOfWeekToMatch".
*/
private DayOfWeek firstDayOfWeek;
/**
* fontCalendarDateLabels, This is the text font for the dates in the calendar panel. The
* default font is the normal undecorated font, as provided by the JLabel component.
*/
private Font fontCalendarDateLabels;
/**
* fontCalendarWeekdayLabels, This is the text font for the weekdays in the calendar panel. The
* default font is the normal undecorated font, as provided by the JLabel component.
*/
private Font fontCalendarWeekdayLabels;
/**
* fontCalendarWeekNumberLabels, This is the text font for the week numbers (if they are
* displayed) in the calendar panel. The default font is the normal undecorated font, as
* provided by the JLabel component.
*/
private Font fontCalendarWeekNumberLabels;
/**
* fontClearButton, This is the text font for the clear button. The default font is the normal
* undecorated font, as provided by the JLabel component.
*/
private Font fontClearLabel;
/**
* fontInvalidDate, This is the text field text font for invalid dates. The default font is a
* normal undecorated font. (Note: The color for invalid dates defaults to Color.red. See also:
* setColor() and "DateArea.DatePickerTextInvalidDate".)
*/
private Font fontInvalidDate;
/**
* fontMonthAndYearMenuButtons, This is the text font for the month and year menu buttons. The
* default font is the normal undecorated font, as provided by the JLabel component.
*/
private Font fontMonthAndYearMenuLabels;
/**
* fontMonthAndYearNavigationButtons, This is the text font for the month and year navigation
* buttons. The default font is the normal undecorated font, as provided by the JLabel
* component.
*/
private Font fontMonthAndYearNavigationButtons;
/**
* fontTodayButton, This is the text font for the today button. The default font is the normal
* undecorated font, as provided by the JLabel component.
*/
private Font fontTodayLabel;
/**
* fontValidDate, This is the text field text font for valid dates. The default font is a normal
* undecorated font.
*/
private Font fontValidDate;
/**
* fontVetoedDate, This is the text field text font for vetoed dates. The default font crosses
* out the vetoed date. (Has a strikethrough font attribute.)
*/
private Font fontVetoedDate;
/**
* formatForDatesCommonEra, This holds the default format that is used to display or parse CE
* dates in the date picker. The default value is generated using the locale of the settings
* instance.
*/
private DateTimeFormatter formatForDatesCommonEra;
/**
* formatForDatesBeforeCommonEra, This holds the default format that is used to display or
* parse BCE dates in the date picker. The default value is generated using the locale of the
* settings instance. A DateTimeFormatter can be created from a pattern string with the
* convenience function DateUtilities.createFormatterFromPatternString();
*
* Note: It is important to use the letter "u" (astronomical year) instead of "y" (year of era)
* when creating pattern strings for BCE dates. This is because the DatePicker uses ISO 8601,
* which specifies "Astronomical year numbering". (Additional details: The astronomical year
* "-1" and "1 BC" are not the same thing. Astronomical years are zero-based, and BC dates are
* one-based. Astronomical year "0", is the same year as "1 BC", and astronomical year "-1" is
* the same year as "2 BC", and so forth.)
*/
private DateTimeFormatter formatForDatesBeforeCommonEra;
/**
* formatTodayButton, This format is used to format today's date into a date string, which is
* displayed on the today button. The default value is generated using the locale of the
* settings instance.
*/
private DateTimeFormatter formatForTodayButton;
/**
* formatsForParsing, This holds a list of formats that are used to attempt to parse dates
* that are typed by the user. When parsing a date, these formats are tried in the order that
* they appear in this list. Note that the formatForDatesCommonEra and
* formatForDatesBeforeCommonEra are always tried (in that order) before any other parsing
* formats. The default values for the formatsForParsing are generated using the pickerLocale,
* using the enum constants in java.time.format.FormatStyle.
*/
private ArrayList formatsForParsing;
/**
* gapBeforeButtonPixels, This specifies the desired width for the gap between the date picker
* and the toggle calendar button (in pixels). The default value is null. If this is left at
* null, then the default value is three pixels.
*/
private Integer gapBeforeButtonPixels = null;
/**
* highlightPolicy, If a highlight policy is supplied, it will be used to determine which dates
* should be highlighted in the calendar panel. The highlight policy can also supply tooltip
* text for any highlighted dates. See the demo class for an example of constructing a highlight
* policy. By default, there is no highlight policy. (The default value is null.)
*/
private DateHighlightPolicy highlightPolicy = null;
/**
* isVisibleClearButton, This specifies if the named component should be displayed. Note that
* this setting will have no effect if empty dates are not allowed. If empty dates are not
* allowed, then the clear button will always be hidden.
*/
private boolean isVisibleClearButton = true;
/**
* isVisibleDateTextField, This specifies if the named component should be displayed.
*/
private boolean isVisibleDateTextField = true;
/**
* isVisibleMonthMenuButton, This specifies if the named component should be displayed.
*/
private boolean isVisibleMonthMenuButton = true;
/**
* isVisibleNextMonthButton, This specifies if the named component should be displayed.
*/
private boolean isVisibleNextMonthButton = true;
/**
* isVisibleNextYearButton, This specifies if the named component should be displayed.
*/
private boolean isVisibleNextYearButton = true;
/**
* isVisiblePreviousMonthButton, This specifies if the named component should be displayed.
*/
private boolean isVisiblePreviousMonthButton = true;
/**
* isVisiblePreviousYearButton, This specifies if the named component should be displayed.
*/
private boolean isVisiblePreviousYearButton = true;
/**
* isVisibleTodayButton, This specifies if the named component should be displayed.
*/
private boolean isVisibleTodayButton = true;
/**
* isVisibleYearMenuButton, This specifies if the named component should be displayed.
*/
private boolean isVisibleYearMenuButton = true;
/**
* locale, This holds the picker locale instance that indicates the user's language and culture.
* The locale is used in translating text and determining default behaviors, for the date picker
* and the calendar panel. The default values for many of the other settings depend on the
* locale. The locale can only be set in the settings constructor. The default value for the
* locale is supplied from Locale.getDefault(), from Java and from the operating system.
*/
private Locale locale;
/**
* parentCalendarPanel, This holds a reference to any parent -independent- calendar panel that
* is associated with these settings. This variable is only intended to be set from the calendar
* panel constructor.
*
* Note that for any single DatePickerSettings instance, only one of the parentDatePicker and
* parentCalendarPanel variables will ever contain a parent instance. The other variable will
* always be null. (A date picker settings instance can be used as the settings for a DatePicker
* or for an independent CalendarPanel, but not for both at the same time.)
*
* This will be null until the CalendarPanel is constructed (using this settings instance).
*/
private CalendarPanel parentCalendarPanel;
/**
* parentDatePicker, This holds a reference to any parent date picker that is associated with
* these settings. This variable is only intended to be set from the date picker constructor.
*
* Note that for any single DatePickerSettings instance, only one of the parentDatePicker and
* parentCalendarPanel variables will ever contain a parent instance. The other variable will
* always be null. (A date picker settings instance can be used as the settings for a DatePicker
* or for an independent CalendarPanel, but not for both at the same time.)
*
* This will be null until the DatePicker is constructed (using this settings instance).
*/
private DatePicker parentDatePicker;
/**
* sizeDatePanelMinimumHeight, This specifies the minimum height, in pixels, of the date label
* area. The date label area is the part of the calendar panel that holds (only) the date
* labels. The remainder of the calendar panel is automatically resized to encompass the date
* label area. The default value for this variable is (6 * 18). If the default value is
* modified, the programmer may also wish to adjust sizeDatePanelPixelsExtraHeight.
*/
private int sizeDatePanelMinimumHeight;
/**
* sizeDatePanelMinimumWidth, This specifies the minimum width, in pixels, of the date label
* area. The date label area is the part of the calendar panel that holds (only) the date
* labels. The remainder of the calendar panel is automatically resized to encompass the date
* label area. The default value for this variable is (7 * 30). If the default value is
* modified, the programmer may also wish to adjust sizeDatePanelPixelsExtraWidth.
*/
private int sizeDatePanelMinimumWidth;
/**
* sizeTextFieldMinimumWidth, This specifies the minimum width, in pixels, of the DatePicker
* text field. (The text field is located to the left of the date picker "popup calendar"
* button, and displays the currently selected date.)
*
* The default value for this setting is null. When this is set to null, a default width for the
* date picker text field will be automatically calculated and applied to fit "the largest
* possible date" (with a four digit year) that can be displayed with the current date picker
* settings. The settings that are used to calculate the default text field width include the
* locale (the language), the fontValidDate, and the formatForDatesCommonEra.
*
* See also: "sizeTextFieldMinimumWidthDefaultOverride".
*/
private Integer sizeTextFieldMinimumWidth = null;
/**
* sizeTextFieldMinimumWidthDefaultOverride, This specifies how the date picker should choose
* the appropriate minimum width for the date picker text field. (As described below.)
*
* If this is true, then the applied minimum width will be the largest of either the default, or
* any programmer supplied, minimum widths.
*
* If this is false, then any programmer supplied minimum width will always override the default
* minimum width. (Even if the programmer supplied width is too small to fit the dates that can
* be displayed in the DatePicker).
*
* The default value for this setting is true. This setting only has an effect if
* (sizeTextFieldMinimumWidth != null).
*
* See also: "sizeTextFieldMinimumWidth".
*/
private boolean sizeTextFieldMinimumWidthDefaultOverride = true;
/**
* translationArrayLongMonthNames, This holds an array of month names to use for the calendar
* panel header, as translated to the current language. It is not expected that this variable
* will need to be changed by the programmer. The default values are generated using the locale
* of the settings instance, by retrieving the translated text for the current language from the
* class called java.text.DateFormatSymbols. This array is indexed with January = 0. The
* Calendar class month name constants can also be used for indexing. (Calendar.JANUARY, etc).
*
* Expected array contents: This array will never contain null, and the array should always have
* a length of 12. Each element should always contain a string that is not null and not empty.
*/
private String[] translationArrayStandaloneLongMonthNames;
/**
* translationArrayShortMonthNames, This holds an array of short month names to use for the
* calendar panel header, as translated to the current language. It is not expected that this
* variable will need to be changed by the programmer. The default values are generated using
* the locale of the settings instance, by retrieving the translated text for the current
* language from the class called java.text.DateFormatSymbols. This array is indexed with
* January = 0. The Calendar class month name constants can also be used for indexing.
* (Calendar.JANUARY, etc).
*
* Expected array contents: This array will never contain null, and the array should always have
* a length of 12. Each element should always contain a string that is not null and not empty.
*/
private String[] translationArrayStandaloneShortMonthNames;
/**
* translationClear, This holds the text of the calendars "Clear" button, as translated to the
* current language. It is not expected that this variable will need to be changed by the
* programmer. If you wish to supply a new translation for the date picker, it would generally
* be better to add (or edit) your translation in the "TranslationResources.properties" file.
* The default value is generated using the locale of the settings instance, by retrieving the
* translated text for the current language from the properties file.
*/
private String translationClear;
/**
* translationToday, This holds the text of the calendars "Today" button, as translated to the
* current language. It is not expected that this variable will need to be changed by the
* programmer. If you wish to supply a new translation for the date picker, it would generally
* be better to add (or edit) your translation in the "TranslationResources.properties" file.
* The default value is generated from the locale of the settings instance, by retrieving the
* translated text for the current language from the properties file.
*/
private String translationToday;
/**
* vetoPolicy, If a veto policy is supplied, it will be used to determine which dates can and
* cannot be selected in the calendar panel. (Vetoed dates are also not accepted into the date
* picker text field). By default, there is no veto policy. (The default value is null.) See the
* DateVetoPolicy Javadocs for details regarding when a veto policy is enforced. See the demo
* class for an example of constructing a veto policy.
*/
private DateVetoPolicy vetoPolicy = null;
/**
* weekNumbersRules, This contains the week number rules that will be used to show the week
* numbers (the weeks of the year), whenever the week numbers are displayed on this calendar.
*
* The definitions for the first day of the week, and for the minimum number of days that
* constitutes the first week of the year, varies between locales. The Java time WeekFields
* class specifies those rules.
*
* If you set this setting to null, then the weekNumberRules will be set to match the
* DatePickerSettings locale. By default, the week number rules will match the
* DatePickerSettings locale.
*
* If you would like the week number rules to be the same for all calendars regardless of the
* locale, then you should consider setting the weekNumberRules to be one of these two commonly
* used rule sets: WeekFields.ISO or WeekFields.SUNDAY_START.
*/
private WeekFields weekNumberRules;
/**
* weekNumbersDisplayed, This specifies whether or not numbers for the "week of the year" should
* be displayed on the calendar panel. The week numbers will be shown if this is true, or they
* will not be shown if this is false. This is false by default.
*
* The week numbers are locale sensitive, because the definition of the first day of the week,
* and the definition for the minimum number of days in the first week of the year, varies
* between locales.
*
* By default, when "weekNumbersDisplayed" is true, the first day of the week used by the
* calendar will always match the weekNumberRules definition for first day of the week. This
* behavior can be changed by modifying the setting "weekNumbersForceFirstDayOfWeekToMatch".
*
* Note: When weekNumbersDisplayed is set to false, then the borders located in the week number
* columns (Columns 1 and 2) will always be set to be hidden.
*/
private boolean weekNumbersDisplayed = false;
/**
* weekNumbersWillOverrideFirstDayOfWeek, This setting determines how to resolve any conflict
* between the "weekNumberRules" setting and the "firstDayOfWeek" setting. Note: This setting
* only has an effect when "weekNumbersDisplayed" is true.
*
* 1) If this setting is true (Default): Whenever the week numbers are displayed, then the first
* day of the week that is displayed on the calendar will always match the currently set
* "weekNumberRules". This enforces a strict and consistent definition for the week numbers.
* Specifically, this guarantees that all seven dates in each calendar row will belong to a
* single week number. Note: The WeekNumberRules are an instance of the java.time.temporal
* "WeekFields" class. For more information about how week numbers are defined, see the
* WeekFields javadocs.
*
* 2) If this setting is false: The first day of the week that is displayed on the calendar will
* always match the "firstDayOfWeek" setting, and a more "flexible" definition of week numbers
* will be applied. Using a firstDayOfWeek that does not match the week number rules will cause
* each calendar row to contain dates that fall inside two different week numbers. (As defined
* by the weekNumberRules.) In this circumstance, the displayed week numbers will be determined
* by a "majority rules" system, which is defined below.
*
* The "majority rules" system: Under the majority rule system, the calendar will count the
* number of days in each row that belong to each week number. In a single row, four (or more)
* days will match one week number, and three (or less) days will match a different week number.
* The most commonly occurring week number will be displayed next to each row.
*
* To summarize: If your program needs to implement a strict week number definition, then it is
* recommended to leave this setting at its default value (of true). If it is more important to
* have a flexible first day of the week, then you could set this value to false. When this
* setting is false, the displayed week numbers will follow a "majority rules" system, and will
* not exactly match the week number rules.
*/
private boolean weekNumbersWillOverrideFirstDayOfWeek = true;
/**
* zSkipDrawIndependentCalendarPanelIfNeeded, This is used to temporarily skip the named
* function, until the setLocale() function is complete.
*/
private boolean zSkipDrawIndependentCalendarPanelIfNeeded = false;
/**
* Constructor with Default Locale, This constructs a date picker settings instance using the
* system default locale and language. The constructor populates all the settings with default
* values.
*/
public DatePickerSettings() {
this(Locale.getDefault());
}
/**
* Constructor with Custom Locale, This constructs a date picker settings instance using the
* supplied locale and language. The constructor populates all the settings with default values.
*/
public DatePickerSettings(Locale pickerLocale) {
// Add all the default colors to the colors map.
colors = new EnumMap<>(DateArea.class);
for (DateArea area : DateArea.values()) {
colors.put(area, area.defaultColor);
}
// Set the minimum height, minimum width, for the date panel.
sizeDatePanelMinimumWidth = (7 * 31);
sizeDatePanelMinimumHeight = (7 * 19);
// Generate the default fonts and text colors.
// The font object is immutable, so it's okay to sign the same font to multiple settings.
Font defaultLabelFont = new JLabel().getFont();
fontClearLabel = defaultLabelFont;
fontCalendarDateLabels = defaultLabelFont;
fontCalendarWeekdayLabels = defaultLabelFont;
fontCalendarWeekNumberLabels = defaultLabelFont;
fontMonthAndYearMenuLabels = defaultLabelFont;
fontTodayLabel = defaultLabelFont;
Font defaultButtonFont = new JButton().getFont();
fontMonthAndYearNavigationButtons = defaultButtonFont;
Font defaultTextFieldFont = new JTextField().getFont();
fontValidDate = defaultTextFieldFont;
fontInvalidDate = defaultTextFieldFont;
fontVetoedDate = defaultTextFieldFont;
Map additionalAttributes = new HashMap<>();
additionalAttributes.put(TextAttribute.STRIKETHROUGH, TextAttribute.STRIKETHROUGH_ON);
fontVetoedDate = fontVetoedDate.deriveFont(additionalAttributes);
// Set the default border properties.
// (Setting this to null will create and save, (and apply when needed) a default set of
// border properties. I don't think there would be any parent to apply them to when called
// from the DatePickerSettings constructor though.)
setBorderPropertiesList(null);
// Save the date picker locale.
// This will also change all settings that most directly depend on the locale.
setLocale(pickerLocale);
}
/**
* copySettings, This function creates and returns a deep copy of this DatePickerSettings
* instance. The new settings instance can be used with new DatePicker or CalendarPanel
* instances. Certain fields are not copied, which are listed below.
*
* These fields are not copied: parentDatePicker, parentCalendarPanel, borderCalendarPopup,
* vetoPolicy, and highlightPolicy. These fields are always set to their default value in the
* returned settings instance. (The default value for all of these fields is null.)
*
* If you would like to set any of the fields that are not copied, then you should set the
* desired fields after calling copySettings().
*/
public DatePickerSettings copySettings() {
DatePickerSettings result = new DatePickerSettings();
result.allowEmptyDates = this.allowEmptyDates;
result.allowKeyboardEditing = this.allowKeyboardEditing;
// "result.borderCalendarPopup" is left at its default value.
if (this.borderPropertiesList == null) {
result.borderPropertiesList = null;
} else {
result.borderPropertiesList
= new ArrayList<>(this.borderPropertiesList.size());
for (CalendarBorderProperties borderProperty : this.borderPropertiesList) {
result.borderPropertiesList.add(borderProperty.clone());
}
}
result.colorBackgroundWeekNumberLabels = this.colorBackgroundWeekNumberLabels;
result.colorBackgroundWeekdayLabels = this.colorBackgroundWeekdayLabels;
if (this.colors == null) {
result.colors = null;
} else {
// A shallow copy is okay here, because the map key and value are immutable types.
result.colors = new EnumMap(this.colors);
}
result.firstDayOfWeek = this.firstDayOfWeek;
// The Font class is immutable.
result.fontClearLabel = this.fontClearLabel;
result.fontCalendarDateLabels = this.fontCalendarDateLabels;
result.fontCalendarWeekdayLabels = this.fontCalendarWeekdayLabels;
result.fontCalendarWeekNumberLabels = this.fontCalendarWeekNumberLabels;
result.fontInvalidDate = this.fontInvalidDate;
result.fontMonthAndYearMenuLabels = this.fontMonthAndYearMenuLabels;
result.fontMonthAndYearNavigationButtons = this.fontMonthAndYearNavigationButtons;
result.fontTodayLabel = this.fontTodayLabel;
result.fontValidDate = this.fontValidDate;
result.fontVetoedDate = this.fontVetoedDate;
// The DateTimeFormatter class is immutable.
result.formatForDatesBeforeCommonEra = this.formatForDatesBeforeCommonEra;
result.formatForDatesCommonEra = this.formatForDatesCommonEra;
result.formatForTodayButton = this.formatForTodayButton;
result.formatsForParsing = (this.formatsForParsing == null)
? null : new ArrayList<>(this.formatsForParsing);
result.gapBeforeButtonPixels = this.gapBeforeButtonPixels;
// "result.highlightPolicy" is left at its default value.
result.isVisibleClearButton = this.isVisibleClearButton;
result.isVisibleDateTextField = this.isVisibleDateTextField;
result.isVisibleMonthMenuButton = this.isVisibleMonthMenuButton;
result.isVisibleNextMonthButton = this.isVisibleNextMonthButton;
result.isVisibleNextYearButton = this.isVisibleNextYearButton;
result.isVisiblePreviousMonthButton = this.isVisiblePreviousMonthButton;
result.isVisiblePreviousYearButton = this.isVisiblePreviousYearButton;
result.isVisibleTodayButton = this.isVisibleTodayButton;
result.isVisibleYearMenuButton = this.isVisibleYearMenuButton;
result.locale = (Locale) this.locale.clone();
// "result.parentCalendarPanel" is left at its default value.
// "result.parentDatePicker" is left at its default value.
result.sizeDatePanelMinimumHeight = this.sizeDatePanelMinimumHeight;
result.sizeDatePanelMinimumWidth = this.sizeDatePanelMinimumWidth;
result.sizeTextFieldMinimumWidth = this.sizeTextFieldMinimumWidth;
result.sizeTextFieldMinimumWidthDefaultOverride = this.sizeTextFieldMinimumWidthDefaultOverride;
// The translation arrays will never be null, and the String class is an immutable type.
result.translationArrayStandaloneLongMonthNames
= this.translationArrayStandaloneLongMonthNames.clone();
result.translationArrayStandaloneShortMonthNames
= this.translationArrayStandaloneShortMonthNames.clone();
result.translationClear = this.translationClear;
result.translationToday = this.translationToday;
// "result.vetoPolicy" is left at its default value.
// The WeekFields class is immutable.
result.weekNumberRules = this.weekNumberRules;
result.weekNumbersDisplayed = this.weekNumbersDisplayed;
result.weekNumbersWillOverrideFirstDayOfWeek = this.weekNumbersWillOverrideFirstDayOfWeek;
result.zSkipDrawIndependentCalendarPanelIfNeeded = false;
return result;
}
/**
* getAllowEmptyDates, Returns the value of this setting. See the "set" function for setting
* information.
*/
public boolean getAllowEmptyDates() {
return allowEmptyDates;
}
/**
* getAllowKeyboardEditing, Returns the value of this setting. See the "set" function for
* setting information.
*/
public boolean getAllowKeyboardEditing() {
return allowKeyboardEditing;
}
/**
* getBorderCalendarPopup, Returns the value of this setting. See the "set" function for setting
* information.
*/
public Border getBorderCalendarPopup() {
return borderCalendarPopup;
}
/**
* getBorderPropertiesList, Returns the value of this setting. See the "set" function for
* setting information.
*/
public ArrayList getBorderPropertiesList() {
return borderPropertiesList;
}
/**
* getClock, Returns the currently set clock
*/
public Clock getClock() {
return clock;
}
/**
* getColor, This returns the currently set color for the specified area.
*/
public Color getColor(DateArea area) {
return colors.get(area);
}
/**
* getColorBackgroundWeekNumberLabels, Returns the value of this setting. See the "set" function
* for setting information.
*/
public Color getColorBackgroundWeekNumberLabels() {
return colorBackgroundWeekNumberLabels;
}
/**
* getColorBackgroundWeekdayLabels, Returns the value of this setting. See the "set" function
* for setting information.
*/
public Color getColorBackgroundWeekdayLabels() {
return colorBackgroundWeekdayLabels;
}
/**
* getDateRangeLimits, This will return a DateInterval containing any current date range limits.
* If no date range limits have been set, then this will return an empty DateInterval. (Both
* dates in the DateInterval will be null). If only one side of the date range limits was set,
* then the other date in the DateInterval will be null.
*
* Technical Notes: This will return any date range limits that were specifically created by
* calling "setDateRangeLimits()". Date range limits are internally implemented using a
* DateVetoPolicy. (Specifically using the class "DateVetoPolicyMinimumMaximumDate".) If
* setDateRangeLimits was never called, or if (for any reason) the current veto policy is not an
* instance of "DateVetoPolicyMinimumMaximumDate", then this will return an empty DateInterval.
* For additional details, see setDateRangeLimits().
*/
public DateInterval getDateRangeLimits() {
DateVetoPolicy policy = getVetoPolicy();
if (policy instanceof DateVetoPolicyMinimumMaximumDate) {
return ((DateVetoPolicyMinimumMaximumDate) policy).getDateRangeLimits();
}
return new DateInterval();
}
/**
* getDefaultYearMonth, This returns the defaultYearMonth or null.
*/
public YearMonth getDefaultYearMonth() {
return defaultYearMonth;
}
/**
* getEnableMonthMenu, Returns the value of this setting. See the "set" function for setting
* information.
*/
public boolean getEnableMonthMenu() {
return enableMonthMenu;
}
/**
* getEnableYearMenu, Returns the value of this setting. See the "set" function for setting
* information.
*/
public boolean getEnableYearMenu() {
return enableYearMenu;
}
/**
* getFirstDayOfWeekDisplayedOnCalendar, Returns the first day of the week as it will be
* displayed on the calendar. Note that this setting may or may not match the first day of the
* week setting. See also: "weekNumbersDisplayed", and "weekNumbersForceFirstDayOfWeekToMatch".
*/
public DayOfWeek getFirstDayOfWeekDisplayedOnCalendar() {
if (weekNumbersDisplayed && weekNumbersWillOverrideFirstDayOfWeek
&& (weekNumberRules != null)) {
return weekNumberRules.getFirstDayOfWeek();
}
return firstDayOfWeek;
}
/**
* getFirstDayOfWeekSetting, Returns the value of of the setting for the first day of the week.
* Note that this setting may or may not match the first day of the week that is displayed on
* the calendar. See also: "weekNumbersDisplayed", and "weekNumbersForceFirstDayOfWeekToMatch".
*/
public DayOfWeek getFirstDayOfWeekSetting() {
return firstDayOfWeek;
}
/**
* getFontCalendarDateLabels, Returns the value of this setting. See the "set" function for
* setting information.
*/
public Font getFontCalendarDateLabels() {
return fontCalendarDateLabels;
}
/**
* getFontCalendarWeekNumberLabels, Returns the value of this setting. See the "set" function
* for setting information.
*/
public Font getFontCalendarWeekNumberLabels() {
return fontCalendarWeekNumberLabels;
}
/**
* getFontCalendarWeekdayLabels, Returns the value of this setting. See the "set" function for
* setting information.
*/
public Font getFontCalendarWeekdayLabels() {
return fontCalendarWeekdayLabels;
}
/**
* getFontClearLabel, Returns the value of this setting. See the "set" function for setting
* information.
*/
public Font getFontClearLabel() {
return fontClearLabel;
}
/**
* getFontInvalidDate, Returns the value of this setting. See the "set" function for setting
* information.
*/
public Font getFontInvalidDate() {
return fontInvalidDate;
}
/**
* getFontMonthAndYearMenuLabels, Returns the value of this setting. See the "set" function for
* setting information.
*/
public Font getFontMonthAndYearMenuLabels() {
return fontMonthAndYearMenuLabels;
}
/**
* getFontMonthAndYearNavigationButtons, Returns the value of this setting. See the "set"
* function for setting information.
*/
public Font getFontMonthAndYearNavigationButtons() {
return fontMonthAndYearNavigationButtons;
}
/**
* getFontTodayLabel, Returns the value of this setting. See the "set" function for setting
* information.
*/
public Font getFontTodayLabel() {
return fontTodayLabel;
}
/**
* getFontValidDate, Returns the value of this setting. See the "set" function for setting
* information.
*/
public Font getFontValidDate() {
return fontValidDate;
}
/**
* getFontVetoedDate, Returns the value of this setting. See the "set" function for setting
* information.
*/
public Font getFontVetoedDate() {
return fontVetoedDate;
}
/**
* getFormatForDatesBeforeCommonEra, Returns the value of this setting. See the "set" function
* for setting information.
*/
public DateTimeFormatter getFormatForDatesBeforeCommonEra() {
return formatForDatesBeforeCommonEra;
}
/**
* getFormatForDatesCommonEra, Returns the value of this setting. See the "set" function for
* setting information.
*/
public DateTimeFormatter getFormatForDatesCommonEra() {
return formatForDatesCommonEra;
}
/**
* getFormatForTodayButton, Returns the value of this setting. See the "set" function for
* setting information.
*/
public DateTimeFormatter getFormatForTodayButton() {
return formatForTodayButton;
}
/**
* getFormatsForParsing, Returns the value of this setting. See the "set" function for setting
* information.
*/
public ArrayList getFormatsForParsing() {
return formatsForParsing;
}
/**
* getGapBeforeButtonPixels, Returns the value of this setting. See the "set" function for
* setting information.
*/
public Integer getGapBeforeButtonPixels() {
return gapBeforeButtonPixels;
}
/**
* getHighlightPolicy, This returns the highlight policy or null.
*/
public DateHighlightPolicy getHighlightPolicy() {
return highlightPolicy;
}
/**
* getLocale, This returns locale setting of the date picker. The locale can only be set in the
* DatePickerSettings constructor.
*/
public Locale getLocale() {
return locale;
}
/**
* getParentCalendarPanel, Returns the calendar panel that is the parent of the settings, or
* null if no parent calendar panel has been set.
*/
public CalendarPanel getParentCalendarPanel() {
return parentCalendarPanel;
}
/**
* getParentDatePicker, Returns the date picker that is the parent of the settings, or null if
* no parent date picker has been set.
*/
public DatePicker getParentDatePicker() {
return parentDatePicker;
}
/**
* getSizeDatePanelMinimumHeight, Returns the value of this setting. See the "set" function for
* setting information.
*/
public int getSizeDatePanelMinimumHeight() {
return sizeDatePanelMinimumHeight;
}
/**
* getSizeDatePanelMinimumWidth, Returns the value of this setting. See the "set" function for
* setting information.
*/
public int getSizeDatePanelMinimumWidth() {
return sizeDatePanelMinimumWidth;
}
/**
* getSizeTextFieldMinimumWidth, Returns the value of this setting. See the "set" function for
* setting information.
*/
public Integer getSizeTextFieldMinimumWidth() {
return sizeTextFieldMinimumWidth;
}
/**
* getSizeTextFieldMinimumWidthDefaultOverride, Returns the value of this setting. See the "set"
* function for setting information.
*/
public boolean getSizeTextFieldMinimumWidthDefaultOverride() {
return sizeTextFieldMinimumWidthDefaultOverride;
}
/**
* getTranslationArrayStandaloneLongMonthNames, Returns the value of this setting. See the "set"
* function for setting information.
*/
public String[] getTranslationArrayStandaloneLongMonthNames() {
return translationArrayStandaloneLongMonthNames;
}
/**
* getTranslationArrayStandaloneShortMonthNames, Returns the value of this setting. See the
* "set" function for setting information.
*/
public String[] getTranslationArrayStandaloneShortMonthNames() {
return translationArrayStandaloneShortMonthNames;
}
/**
* getTranslationClear, Returns the value of this setting. See the "set" function for setting
* information.
*/
public String getTranslationClear() {
return translationClear;
}
/**
* getTranslationToday, Returns the value of this setting. See the "set" function for setting
* information.
*/
public String getTranslationToday() {
return translationToday;
}
/**
* getVetoPolicy, This returns the veto policy or null.
*/
public DateVetoPolicy getVetoPolicy() {
return vetoPolicy;
}
/**
* getVisibleClearButton, This returns the visibility state of the named component.
*/
public boolean getVisibleClearButton() {
return isVisibleClearButton;
}
/**
* getVisibleDateTextField, This returns the visibility state of the named component.
*/
public boolean getVisibleDateTextField() {
return isVisibleDateTextField;
}
/**
* getVisibleMonthMenuButton, This returns the visibility state of the named component.
*/
public boolean getVisibleMonthMenuButton() {
return isVisibleMonthMenuButton;
}
/**
* getVisibleNextMonthButton, This returns the visibility state of the named component.
*/
public boolean getVisibleNextMonthButton() {
return isVisibleNextMonthButton;
}
/**
* getVisibleNextYearButton, This returns the visibility state of the named component.
*/
public boolean getVisibleNextYearButton() {
return isVisibleNextYearButton;
}
/**
* getVisiblePreviousMonthButton, This returns the visibility state of the named component.
*/
public boolean getVisiblePreviousMonthButton() {
return isVisiblePreviousMonthButton;
}
/**
* getVisiblePreviousYearButton, This returns the visibility state of the named component.
*/
public boolean getVisiblePreviousYearButton() {
return isVisiblePreviousYearButton;
}
/**
* getVisibleTodayButton, This returns the visibility state of the named component.
*/
public boolean getVisibleTodayButton() {
return isVisibleTodayButton;
}
/**
* getVisibleYearMenuButton, This returns the visibility state of the named component.
*/
public boolean getVisibleYearMenuButton() {
return isVisibleYearMenuButton;
}
/**
* getWeekNumberRules, Returns the value of this setting. See the "set" function for setting
* information.
*/
public WeekFields getWeekNumberRules() {
return weekNumberRules;
}
/**
* getWeekNumbersDisplayed, Returns the value of this setting. See the "set" function for
* setting information.
*/
public boolean getWeekNumbersDisplayed() {
return weekNumbersDisplayed;
}
/**
* getWeekNumbersWillOverrideFirstDayOfWeek, Returns the value of this setting. See the "set"
* function for setting information.
*/
public boolean getWeekNumbersWillOverrideFirstDayOfWeek() {
return weekNumbersWillOverrideFirstDayOfWeek;
}
/**
* hasParent, This returns true if this settings instance has a parent, otherwise returns false.
* A settings instance will have a parent if the settings instance has already been used to
* construct a DatePicker, or to construct an independent CalendarPanel. Note that settings
* instances cannot be reused. They are only expected to ever have one parent.
*/
public boolean hasParent() {
boolean hasParentDatePicker = (parentDatePicker != null);
boolean hasParentCalendarPanel = (parentCalendarPanel != null);
return (hasParentDatePicker || hasParentCalendarPanel);
}
/**
* isDateAllowed, This checks to see if the specified date is allowed by any currently set veto
* policy, and allowed by the current setting of allowEmptyDates.
*
* If allowEmptyDates is false, and the specified date is null, then this returns false.
*
* If a veto policy exists, and the specified date is vetoed, then this returns false.
*
* If the date is not vetoed, or if empty dates are allowed and the date is null, then this
* returns true.
*/
public boolean isDateAllowed(LocalDate date) {
if (date == null) {
return allowEmptyDates;
}
return (!(InternalUtilities.isDateVetoed(vetoPolicy, date)));
}
/**
* setAllowEmptyDates, This sets whether or not empty dates (null dates) are allowed in the
* DatePicker or independent CalendarPanel. If this is true, then empty dates will be allowed.
* If this is false, then empty dates will not be allowed.
*
* If setting this function to false, it is recommended to call this function -before- setting a
* veto policy. This sequence will guarantee that the DatePicker.getDate() (or
* CalendarPanel.getSelectedDate()) functions will never return a null value, and will guarantee
* that the setAllowEmptyDates() function will not throw an exception.
*
* If the current date is null and you set allowEmptyDates to false, then this function will
* attempt to initialize the current date to today's date. This function will throw an exception
* if it fails to initialize a null date. An exception is only possible if a veto policy is set
* before calling this function, and the veto policy vetoes today's date.
*/
public void setAllowEmptyDates(boolean allowEmptyDates) {
this.allowEmptyDates = allowEmptyDates;
if (hasParent()) {
zApplyAllowEmptyDates();
}
}
/**
* setAllowKeyboardEditing, This sets whether or not keyboard editing is allowed for this date
* picker. If this is true, then dates can be entered into the date picker either by using the
* keyboard or the mouse. If this is false, then dates can only be selected by using the mouse.
* The default value is true. It is generally recommended to leave this setting as "true".
*
* Accessibility Impact: Disallowing the use of the keyboard, and requiring the use of the
* mouse, could impact the accessibility of your program for disabled persons.
*
* Note: This setting does not impact the automatic enforcement of valid or vetoed dates. To
* learn about the automatic date validation and enforcement for keyboard entered text, see the
* javadocs for the DatePicker class.
*/
public void setAllowKeyboardEditing(boolean allowKeyboardEditing) {
this.allowKeyboardEditing = allowKeyboardEditing;
zApplyAllowKeyboardEditing();
}
/**
* setBorderCalendarPopup, This sets the border for the calendar popup window. If this is null,
* a default border will be provided by the CustomPopup class. The default value is null. This
* function only applies if the parent of the settings is a DatePicker. (Not if the parent is an
* independent CalendarPanel.)
*/
public void setBorderCalendarPopup(Border borderCalendarPopup) {
this.borderCalendarPopup = borderCalendarPopup;
}
/**
* setBorderPropertiesList, This sets the list of border properties objects that specifies the
* colors and thicknesses of the borders in the CalendarPanel. By default, a default set of
* border properties is stored in the borderPropertiesList.
*
* Passing in "null" when setting this property will restore the default border properties. If
* you don't want the default border properties but wish to truly "clear" the border properties
* list, you could pass in an empty ArrayList.
*
* To modify the calendar borders (including individual border colors, thickness, or
* visibility), you can supply your own ArrayList of border properties. Border properties
* objects are applied in the order that they appear in the ArrayList. To learn how to set the
* CalendarBorderProperties objects, see the CalendarBorderProperties class javadocs.
*
* The default border properties have a one pixel blue border around the date labels, and two
* vertical light blue borders near the weekday labels (which match the color of the weekday
* labels). The outer top horizontal border and the outer left vertical border are invisible by
* default.
*
* The default border properties also include borders above and below the "week numbers" column
* which match the color of the week numbers labels. (However, these borders are only displayed
* when the week numbers are displayed.)
*
* Whenever the border properties list is applied, the borders are first "cleared" by setting
* all borders to the following settings: Invisible, and black color. This is true of both the
* default border properties and any programmer supplied border properties.
*
* Note: If weekNumbersDisplayed is set to false, then the borders located in the week number
* columns (Columns 1 and 2) will always be hidden.
*/
public void setBorderPropertiesList(ArrayList borderPropertiesList) {
if (borderPropertiesList == null) {
borderPropertiesList = zGetDefaultBorderPropertiesList();
}
this.borderPropertiesList = borderPropertiesList;
// This only needs to be applied to independent calendar panels.
// For the date picker, the setting is automatically applied from the calendar panel
// constructor each time the calendar panel is opened.
if (parentCalendarPanel != null) {
parentCalendarPanel.zApplyBorderPropertiesList();
}
}
/**
* setClock, This sets the clock to use for determining the current
* date. By default the system clock is used.
* @param clock A clock to use
*/
public void setClock(Clock clock) {
this.clock = clock;
}
/**
* setColor, This sets a color for the specified area. Setting an area to null will restore the
* default color for that area.
*/
public void setColor(DateArea area, Color color) {
// If null was supplied, then use the default color.
if (color == null) {
color = area.defaultColor;
}
// Save the color to the color map.
colors.put(area, color);
// Call any "updating functions" that are appropriate for the specified area.
switch (area) {
case BackgroundMonthAndYearMenuLabels:
case BackgroundTodayLabel:
case BackgroundClearLabel:
if (parentCalendarPanel != null) {
parentCalendarPanel.zSetAllLabelIndicatorColorsToDefaultState();
}
break;
case DatePickerTextDisabled:
if (parentDatePicker != null) {
zApplyDisabledTextColor();
}
break;
default:
if (parentDatePicker != null) {
parentDatePicker.zDrawTextFieldIndicators();
}
zDrawIndependentCalendarPanelIfNeeded();
}
}
/**
* setColorBackgroundWeekNumberLabels, This sets the calendar background color for the week
* number labels. The default color is a medium sky blue.
*
* @param applyMatchingDefaultBorders This determines if this function will update the border
* label properties to show the appropriate default borders. The default border label settings
* are different, depending on the "colorBackgroundWeekNumberLabels". If you have not customized
* the border label properties, then it is recommended that you always set the
* "applyMatchingDefaultBorders" parameter to true. This will ensure that the calendar borders
* will always use the correct default settings. If you set this parameter to false, than the
* current border settings will not be changed by this function.
*/
public void setColorBackgroundWeekNumberLabels(Color colorBackgroundWeekNumberLabels,
boolean applyMatchingDefaultBorders) {
this.colorBackgroundWeekNumberLabels = colorBackgroundWeekNumberLabels;
if (applyMatchingDefaultBorders) {
setBorderPropertiesList(null);
}
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setColorBackgroundWeekdayLabels, This sets the calendar background color for the weekday
* labels. The default color is a medium sky blue.
*
* @param applyMatchingDefaultBorders This determines if this function will update the border
* label properties to show the appropriate default borders. The default border label settings
* are different, depending on the "colorBackgroundWeekdayLabels". If you have not customized
* the border label properties, then it is recommended that you always set the
* "applyMatchingDefaultBorders" parameter to true. This will ensure that the calendar borders
* will always use the correct default settings. If you set this parameter to false, than the
* current border settings will not be changed by this function.
*/
public void setColorBackgroundWeekdayLabels(Color colorBackgroundWeekdayLabels,
boolean applyMatchingDefaultBorders) {
this.colorBackgroundWeekdayLabels = colorBackgroundWeekdayLabels;
if (applyMatchingDefaultBorders) {
setBorderPropertiesList(null);
}
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setDateRangeLimits, This is a convenience function, for setting a DateVetoPolicy that will
* limit the allowed dates in the parent object to a specified minimum and maximum date value.
* Calling this function will always replace any existing DateVetoPolicy.
*
* If you only want to limit one side of the date range, then you can pass in "null" for the
* other date variable. If you pass in null for both values, then the current veto policy will
* be cleared.
*
* Important Note: The DatePicker or independent CalendarPanel associated with this settings
* instance is known as the "parent component". This function can only be called after the
* parent component is constructed with this settings instance. If this is called before the
* parent is constructed, then an exception will be thrown. For more details, see:
* "DatePickerSettings.setVetoPolicy()".
*
* Return value: It's possible to set a veto policy that vetoes the currently selected date.
* This function returns true if the selected date is allowed by the new veto policy and the
* other current settings, or false if the selected date is vetoed or disallowed. Setting a new
* veto policy does not modify the selected date. Is up to the programmer to resolve any
* potential conflict between a new veto policy, and the currently selected date.
*/
public boolean setDateRangeLimits(LocalDate firstAllowedDate, LocalDate lastAllowedDate) {
if (!hasParent()) {
throw new RuntimeException("DatePickerSettings.setDateRangeLimits(), "
+ "A date range limit can only be set after constructing the parent "
+ "DatePicker or the parent independent CalendarPanel. (The parent component "
+ "should be constructed using the DatePickerSettings instance where the "
+ "date range limits will be applied. The previous sentence is probably "
+ "simpler than it sounds.)");
}
if (firstAllowedDate == null && lastAllowedDate == null) {
return setVetoPolicy(null);
}
return setVetoPolicy(new DateVetoPolicyMinimumMaximumDate(
firstAllowedDate, lastAllowedDate));
}
/**
* setDefaultYearMonth, This sets which YearMonth should be displayed by default, when no date
* is currently selected. This is used only when a when a calendar panel (or calendar popup) is
* displayed or showing. If this is set to null, then the defaultYearMonth will be
* YearMonth.now().
*/
public void setDefaultYearMonth(YearMonth defaultYearMonth) {
this.defaultYearMonth = defaultYearMonth;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setEnableMonthMenu, This sets the month popup menu to be enabled or disabled. (Note: The
* month label is located in the header area of the calendar panel.) If this is true, then the
* month label will give a visual indication of any "mouse over" events, and the month menu will
* open when the month label is clicked. If this is false, then the month label will not
* indicate mouse over events, and the month menu can not be opened. The default value for this
* setting is true.
*
* Note: It is generally recommended to leave the month menu enabled. Disabling this menu can
* negatively impact calendar usability. When the month menu is disabled, the user may have to
* press the month navigation button many times to reach a desired month.
*/
public void setEnableMonthMenu(boolean enableMonthMenu) {
this.enableMonthMenu = enableMonthMenu;
}
/**
* setEnableYearMenu, This sets the year popup menu to be enabled or disabled. (Note: The year
* label is located in the header area of the calendar panel.) If this is true, then the year
* label will give a visual indication of any "mouse over" events, and the year menu will open
* when the year label is clicked. If this is false, then the year label will not indicate mouse
* over events, and the year menu can not be opened. The default value for this setting is true.
*
* Note: It is generally recommended to leave the year menu enabled. Disabling this menu can
* negatively impact calendar usability. When the year menu is disabled, it may become difficult
* or effectively impossible for the user to navigate to years that are far into the past or the
* future.
*/
public void setEnableYearMenu(boolean enableYearMenu) {
this.enableYearMenu = enableYearMenu;
}
/**
* setFirstDayOfWeek, This sets the day of the week that will be displayed in the far left
* column of the CalendarPanel, as the "first day of the week". The default value is generated
* using the locale of the settings instance.
*
* By default, If weekNumbersDisplayed is set to true, then the first day of the week will not
* match the setting. (weekNumbersDisplayed is false by default.) For additional details, see
* the javadocs for the following settings: "weekNumbersDisplayed", and
* "weekNumbersForceFirstDayOfWeekToMatch".
*/
public void setFirstDayOfWeek(DayOfWeek firstDayOfWeek) {
this.firstDayOfWeek = firstDayOfWeek;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontCalendarDateLabels, This sets the font for the date numbers in the calendar panel.
* (Technical note: The date numbers are in JLabel instances.)
*/
public void setFontCalendarDateLabels(Font fontCalendarDateLabels) {
this.fontCalendarDateLabels = fontCalendarDateLabels;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontCalendarWeekNumberLabels, This sets the font for the week numbers in the calendar
* panel. (This color will only appear if the week numbers are enabled.)
*/
public void setFontCalendarWeekNumberLabels(Font fontCalendarWeekNumberLabels) {
this.fontCalendarWeekNumberLabels = fontCalendarWeekNumberLabels;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontCalendarWeekdayLabels, This sets the font for the weekday labels in the calendar
* panel.
*/
public void setFontCalendarWeekdayLabels(Font fontCalendarWeekdayLabels) {
this.fontCalendarWeekdayLabels = fontCalendarWeekdayLabels;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontClearLabel, This sets the font for the clear label, (this also acts as a "button"), in
* the calendar panel.
*/
public void setFontClearLabel(Font fontClearLabel) {
this.fontClearLabel = fontClearLabel;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontInvalidDate, This sets the text field text font for invalid dates. The default font is
* a normal undecorated font. (Note: The color for invalid dates defaults to Color.red. See
* also: "colorTextInvalidDate".)
*/
public void setFontInvalidDate(Font fontInvalidDate) {
this.fontInvalidDate = fontInvalidDate;
}
/**
* setFontMonthAndYearMenuLabels, This sets the font for the (two) month and year menu labels
* (these also act as "buttons") in the calendar panel.
*/
public void setFontMonthAndYearMenuLabels(Font fontMonthAndYearMenuLabels) {
this.fontMonthAndYearMenuLabels = fontMonthAndYearMenuLabels;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontMonthAndYearNavigationButtons, This sets the font for the (four) month any year
* navigation buttons in the calendar panel.
*/
public void setFontMonthAndYearNavigationButtons(Font fontMonthAndYearNavigationButtons) {
this.fontMonthAndYearNavigationButtons = fontMonthAndYearNavigationButtons;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontTodayLabel, This sets the font for the today label, (this also acts as a "button"), in
* the calendar panel.
*/
public void setFontTodayLabel(Font fontTodayLabel) {
this.fontTodayLabel = fontTodayLabel;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFontValidDate, This sets the text field text font for valid dates. The default font is a
* normal undecorated font, as provided by JTextField.
*
* Note: Changing the font for valid dates may also change the default minimum size for the date
* picker. This will not affect the minimum size if it has been overridden by the programmer.
*/
public void setFontValidDate(Font fontValidDate) {
this.fontValidDate = fontValidDate;
// The font for the valid date can change the default minimum size.
// So we recalculate and set the minimum size, if needed.
if (parentDatePicker != null) {
parentDatePicker.zSetAppropriateTextFieldMinimumWidth();
}
}
/**
* setFontVetoedDate, This sets the text field text font for vetoed dates. The default font
* crosses out the vetoed date. (Has a strikethrough font attribute.)
*/
public void setFontVetoedDate(Font fontVetoedDate) {
this.fontVetoedDate = fontVetoedDate;
}
/**
* setFormatForDatesBeforeCommonEra, This sets the format that is used to display or parse BCE
* dates in the date picker, from a DateTimeFormatter instance. The default value for the date
* format is generated using the locale of the settings instance.
*
* For most desired date formats, it would probably be easier to use the other "pattern string"
* version of this function. (which accepts a date pattern string instead of a DateTimeFormatter
* instance.)
*
* Note: It is important to use the letter "u" (astronomical year) instead of "y" (year of era)
* when creating pattern strings for BCE dates. This is because the DatePicker uses ISO 8601,
* which specifies "Astronomical year numbering". (Additional details: The astronomical year
* "-1" and "1 BC" are not the same thing. Astronomical years are zero-based, and BC dates are
* one-based. Astronomical year "0", is the same year as "1 BC", and astronomical year "-1" is
* the same year as "2 BC", and so forth.)
*
* The various codes for the date pattern string are described at this link:
* https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
*
* If the date picker has already been constructed, then calling this function will cause
* immediate validation of the text field text.
*/
public void setFormatForDatesBeforeCommonEra(DateTimeFormatter formatForDatesBeforeCommonEra) {
this.formatForDatesBeforeCommonEra = formatForDatesBeforeCommonEra;
if (parentDatePicker != null) {
parentDatePicker.setTextFieldToValidStateIfNeeded();
}
}
/**
* setFormatForDatesBeforeCommonEra, This sets the format that is used to display or parse BCE
* dates in the date picker, from a DateTimeFormatter pattern string. The default value for the
* date format is generated using the locale of the settings instance.
*
* Note: It is important to use the letter "u" (astronomical year) instead of "y" (year of era)
* when creating pattern strings for BCE dates. This is because the DatePicker uses ISO 8601,
* which specifies "Astronomical year numbering". (Additional details: The astronomical year
* "-1" and "1 BC" are not the same thing. Astronomical years are zero-based, and BC dates are
* one-based. Astronomical year "0", is the same year as "1 BC", and astronomical year "-1" is
* the same year as "2 BC", and so forth.)
*
* The various codes for the date pattern string are described at this link:
* https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
*
* If the date picker has already been constructed, then calling this function will cause
* immediate validation of the text field text.
*/
public void setFormatForDatesBeforeCommonEra(String patternString) {
DateTimeFormatter formatter
= PickerUtilities.createFormatterFromPatternString(patternString, getLocale());
setFormatForDatesBeforeCommonEra(formatter);
}
/**
* setFormatForDatesCommonEra, This sets the format that is used to display or parse CE dates in
* the date picker, from a DateTimeFormatter instance. The default value for the date format is
* generated using the locale of the settings instance.
*
* For most desired date formats, it would probably be easier to use the other "pattern string"
* version of this function. (which accepts a date pattern string instead of a DateTimeFormatter
* instance.)
*
* The various codes for the date pattern string are described at this link:
* https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
*
* If the date picker has already been constructed, then calling this function will cause
* immediate validation of the text field text.
*
* Note: Changing the format for CE dates may also change the default minimum width of the date
* picker text field.
*/
public void setFormatForDatesCommonEra(DateTimeFormatter formatForDatesCommonEra) {
this.formatForDatesCommonEra = formatForDatesCommonEra;
if (parentDatePicker != null) {
parentDatePicker.setTextFieldToValidStateIfNeeded();
}
// Changing the format for AD dates can change the default minimum width of the text field.
// So if needed, set the appropriate minimum width.
if (parentDatePicker != null) {
parentDatePicker.zSetAppropriateTextFieldMinimumWidth();
}
}
/**
* setFormatForDatesCommonEra, This sets the format that is used to display or parse CE dates in
* the date picker, from a DateTimeFormatter pattern string. The default value for the date
* format is generated using the locale of the settings instance.
*
* The various codes for the date pattern string are described at this link:
* https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
*
* If the date picker has already been constructed, then calling this function will cause
* immediate validation of the text field text.
*
* Note: Changing the format for CE dates may also change the default minimum width of the date
* picker text field.
*/
public void setFormatForDatesCommonEra(String patternString) {
DateTimeFormatter formatter
= PickerUtilities.createFormatterFromPatternString(patternString, getLocale());
setFormatForDatesCommonEra(formatter);
}
/**
* setFormatForTodayButton, This sets the format that is used to format today's date into a date
* string, which is displayed on the today button. The default value is generated using the
* locale of the settings instance.
*/
public void setFormatForTodayButton(DateTimeFormatter formatForTodayButton) {
this.formatForTodayButton = formatForTodayButton;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setFormatsForParsing, This holds a list of formats that are used to attempt to parse dates
* that are typed by the user. When parsing a date, these formats are tried in the order that
* they appear in this list. Note that the formatForDatesCommonEra and
* formatForDatesBeforeCommonEra are always tried (in that order) before any other parsing
* formats. The default values for the formatsForParsing are generated using the pickerLocale,
* using the enum constants in java.time.format.FormatStyle.
*/
public void setFormatsForParsing(ArrayList formatsForParsing) {
this.formatsForParsing = formatsForParsing;
}
/**
* setGapBeforeButtonPixels, This specifies the desired width for the gap between the date
* picker and the toggle calendar button (in pixels). The default value is null. If this is left
* at null, then the default value is 3 pixels.
*/
public void setGapBeforeButtonPixels(Integer gapBeforeButtonPixels) {
this.gapBeforeButtonPixels = gapBeforeButtonPixels;
if (parentDatePicker != null) {
zApplyGapBeforeButtonPixels();
}
}
/**
* setHighlightPolicy,
*
* This sets a highlight policy for the parent DatePicker or parent independent CalendarPanel.
*
* If a highlight policy is supplied, it will be used to determine which dates should be
* highlighted in the calendar panel. The highlight policy can also supply tooltip text for any
* highlighted dates. See the demo class for an example of constructing a highlight policy. By
* default, there is no highlight policy. (The default value is null.)
*/
public void setHighlightPolicy(DateHighlightPolicy highlightPolicy) {
this.highlightPolicy = highlightPolicy;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setLocale, This will set the locale for this DatePickerSettings instance, and will set all
* other settings that depend on the locale to their default values.
*
* Warning: Every setting whose default value depends on the locale, will be overwritten
* whenever this function is called.
*
* This is a list of all the settings which are overwritten by this function: locale,
* translationArrayStandaloneLongMonthNames, translationArrayStandaloneShortMonthNames,
* translationToday, translationClear, formatForTodayButton, formatForDatesCommonEra,
* formatForDatesBeforeCommonEra, formatsForParsing, firstDayOfWeek, weekNumberRules.
*
* For most applications, it is generally recommended to only set the locale from the
* DatePickerSettings constructor. If you use setLocale() to change the locale after
* construction, then you will overwrite any previously customized locale-specific settings.
*
* Passing in "null" will apply the default locale for the current Java Virtual Machine.
*/
public void setLocale(Locale locale) {
// Check for null, which indicates that we should use the default locale.
if (locale == null) {
locale = Locale.getDefault();
}
// Fix a problem where the Hindi locale is not recognized by language alone.
if ("hi".equals(locale.getLanguage()) && (locale.getCountry().isEmpty())) {
locale = new Locale("hi", "IN");
}
this.locale = locale;
// Do not redraw the calendar until this function is complete.
zSkipDrawIndependentCalendarPanelIfNeeded = true;
// Set the default week number rules.
WeekFields localeWeekFields = WeekFields.of(locale);
setWeekNumberRules(localeWeekFields);
// Set the default "today" and "clear" translations for the locale.
String todayTranslation = TranslationSource.getTranslation(locale, "today", "Today");
setTranslationToday(todayTranslation);
String clearTranslation = TranslationSource.getTranslation(locale, "clear", "Clear");
setTranslationClear(clearTranslation);
// Set the default standalone month names for the locale.
String[] standaloneLongMonthNames
= ExtraDateStrings.getDefaultStandaloneLongMonthNamesForLocale(locale);
setTranslationArrayStandaloneLongMonthNames(standaloneLongMonthNames);
String[] standaloneShortMonthNames
= ExtraDateStrings.getDefaultStandaloneShortMonthNamesForLocale(locale);
setTranslationArrayStandaloneShortMonthNames(standaloneShortMonthNames);
// Create default formatters for displaying the today button, and AD and BC dates, in
// the specified locale.
DateTimeFormatter formatForToday
= DateTimeFormatter.ofLocalizedDate(FormatStyle.MEDIUM).withLocale(locale);
setFormatForTodayButton(formatForToday);
DateTimeFormatter formatForDatesCE = InternalUtilities.generateDefaultFormatterCE(locale);
setFormatForDatesCommonEra(formatForDatesCE);
DateTimeFormatter formatForDatesBCE = InternalUtilities.generateDefaultFormatterBCE(locale);
setFormatForDatesBeforeCommonEra(formatForDatesBCE);
// Create an array of all the FormatStyle enum values, from short to long.
FormatStyle[] allFormatStyles = new FormatStyle[]{
FormatStyle.SHORT, FormatStyle.MEDIUM, FormatStyle.LONG, FormatStyle.FULL};
// Create a set of default parsing formatters for the specified locale.
ArrayList parsingFormats = new ArrayList();
DateTimeFormatter parseFormat;
for (int i = 0; i < allFormatStyles.length; ++i) {
parseFormat = new DateTimeFormatterBuilder().parseLenient().parseCaseInsensitive().
appendLocalized(allFormatStyles[i], null).toFormatter(locale);
parsingFormats.add(parseFormat);
}
// Get any common extra parsing formats for the specified locale, and append them to
// the list of parsingFormatters.
ArrayList extraFormatters
= ExtraDateStrings.getExtraParsingFormatsForLocale(locale);
parsingFormats.addAll(extraFormatters);
// Save the parsing formats.
setFormatsForParsing(parsingFormats);
// Initialize the first day of the week.
DayOfWeek firstDayOfWeekDefault = WeekFields.of(locale).getFirstDayOfWeek();
setFirstDayOfWeek(firstDayOfWeekDefault);
// Draw the calendar.
zSkipDrawIndependentCalendarPanelIfNeeded = false;
zDrawIndependentCalendarPanelIfNeeded();
// Update the parent date picker text field if needed.
zDrawDatePickerTextFieldIfNeeded();
}
/**
* setSizeDatePanelMinimumHeight, This sets the minimum height, in pixels, of the date label
* area. The date label area is the part of the calendar panel that holds (only) the date
* labels. The remainder of the calendar panel is automatically resized to encompass the date
* label area. The default value for this variable is (6 * 18). If the default value is
* modified, the programmer may also wish to adjust sizeDatePanelPixelsExtraHeight.
*/
public void setSizeDatePanelMinimumHeight(int sizeDatePanelMinimumHeight) {
this.sizeDatePanelMinimumHeight = sizeDatePanelMinimumHeight;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setSizeDatePanelMinimumWidth, This sets the minimum width, in pixels, of the date label area.
* The date label area is the part of the calendar panel that holds (only) the date labels. The
* remainder of the calendar panel is automatically resized to encompass the date label area.
* The default value for this variable is (7 * 30). If the default value is modified, the
* programmer may also wish to adjust sizeDatePanelPixelsExtraWidth.
*/
public void setSizeDatePanelMinimumWidth(int sizeDatePanelMinimumWidth) {
this.sizeDatePanelMinimumWidth = sizeDatePanelMinimumWidth;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setSizeTextFieldMinimumWidth, This sets the minimum width in pixels, of the DatePicker text
* field. (The text field is located to the left of the date picker "popup calendar" button, and
* displays the currently selected date.)
*
* The default value for this setting is null. When this is set to null, a default width for the
* date picker text field will be automatically calculated and applied to fit "the largest
* possible date" (with a four digit year) that can be displayed with the current date picker
* settings. The settings used to calculate the default text field width include the locale (the
* language), the fontValidDate, and the formatForDatesCommonEra.
*/
public void setSizeTextFieldMinimumWidth(Integer minimumWidthInPixels) {
this.sizeTextFieldMinimumWidth = minimumWidthInPixels;
if (parentDatePicker != null) {
parentDatePicker.zSetAppropriateTextFieldMinimumWidth();
}
}
/**
* setSizeTextFieldMinimumWidthDefaultOverride, This specifies how the date picker should choose
* the appropriate minimum width for the date picker text field. (As described below.)
*
* If this is true, then the applied minimum width will be the largest of either the default, or
* any programmer supplied, minimum widths.
*
* If this is false, then any programmer supplied minimum width will always override the default
* minimum width. (Even if the programmer supplied width is too small to fit the dates that can
* be displayed in the DatePicker).
*
* The default value for this setting is true. This setting only has an effect if
* (sizeTextFieldMinimumWidth != null).
*
* See also: "setSizeTextFieldMinimumWidth()".
*/
public void setSizeTextFieldMinimumWidthDefaultOverride(boolean defaultShouldOverrideIfNeeded) {
this.sizeTextFieldMinimumWidthDefaultOverride = defaultShouldOverrideIfNeeded;
if (parentDatePicker != null) {
parentDatePicker.zSetAppropriateTextFieldMinimumWidth();
}
}
/**
* setTranslationArrayStandaloneLongMonthNames, This sets an array of month names to use for the
* calendar panel header, as translated to the current language. It is not expected that this
* variable will need to be changed by the programmer. The default values are generated using
* the locale of the settings instance, by retrieving the translated text for the current
* language from the class called java.text.DateFormatSymbols. This array is indexed with
* January = 0. The Calendar class month name constants can also be used for indexing.
* (Calendar.JANUARY, etc). Setting this to null will restore the default values.
*
* Expected array contents: The array should always have a length of 12. Each element should
* always contain a string that is not null and not empty.
*/
public void setTranslationArrayStandaloneLongMonthNames(String[] newTranslationArray) {
if (newTranslationArray == null) {
String[] defaultLongMonthNames
= ExtraDateStrings.getDefaultStandaloneLongMonthNamesForLocale(locale);
this.translationArrayStandaloneLongMonthNames = defaultLongMonthNames;
} else {
this.translationArrayStandaloneLongMonthNames = newTranslationArray;
}
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setTranslationArrayStandaloneShortMonthNames, This sets an array of short month names to use
* for the calendar panel header, as translated to the current language. It is not expected that
* this variable will need to be changed by the programmer. The default values are generated
* using the locale of the settings instance, by retrieving the translated text for the current
* language from the class called java.text.DateFormatSymbols. This array is indexed with
* January = 0. The Calendar class month name constants can also be used for indexing.
* (Calendar.JANUARY, etc). Setting this to null will restore the default values.
*
* Expected array contents: The array should always have a length of 12. Each element should
* always contain a string that is not null and not empty.
*/
public void setTranslationArrayStandaloneShortMonthNames(String[] newTranslationArray) {
if (newTranslationArray == null) {
String[] defaultShortMonthNames
= ExtraDateStrings.getDefaultStandaloneShortMonthNamesForLocale(locale);
this.translationArrayStandaloneShortMonthNames = defaultShortMonthNames;
} else {
this.translationArrayStandaloneShortMonthNames = newTranslationArray;
}
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setTranslationClear, This sets the text of the calendars "Clear" button, as translated to the
* current language. It is not expected that this variable will need to be changed by the
* programmer. If you wish to supply a new translation for the date picker, it would generally
* be better to add (or edit) your translation in the "TranslationResources.properties" file.
* The default value is generated using the locale of the settings instance, by retrieving the
* translated text for the current language from the properties file.
*/
public void setTranslationClear(String translationClear) {
this.translationClear = translationClear;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setTranslationToday, This sets the text of the calendars "Today" button, as translated to the
* current language. It is not expected that this variable will need to be changed by the
* programmer. If you wish to supply a new translation for the date picker, it would generally
* be better to add (or edit) your translation in the "TranslationResources.properties" file.
* The default value is generated from the locale of the settings instance, by retrieving the
* translated text for the current language from the properties file.
*/
public void setTranslationToday(String translationToday) {
this.translationToday = translationToday;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setVetoPolicy,
*
* This sets a veto policy for the parent DatePicker or parent independent CalendarPanel.
*
* Important Note: The DatePicker or independent CalendarPanel associated with this settings
* instance is known as the "parent component". This function can only be called after the
* parent component is constructed with this settings instance. If this is called before the
* parent is constructed, then an exception will be thrown.
*
* When a veto policy is supplied, it will be used to determine which dates can or can not be
* selected in the calendar panel. (Vetoed dates are also not accepted into the date picker text
* field). See the demo class for an example of constructing a veto policy.
*
* By default, there is no veto policy. Setting this function to null will clear any veto policy
* that has been set.
*
* Return value: It's possible to set a veto policy that vetoes the currently selected date.
* This function returns true if the selected date is allowed by the new veto policy and the
* other current settings, or false if the selected date is vetoed or disallowed. Setting a new
* veto policy does not modify the selected date. Is up to the programmer to resolve any
* potential conflict between a new veto policy, and the currently selected date.
*/
public boolean setVetoPolicy(DateVetoPolicy vetoPolicy) {
if (!hasParent()) {
throw new RuntimeException("DatePickerSettings.setVetoPolicy(), "
+ "A veto policy can only be set after constructing the parent DatePicker or "
+ "the parent independent CalendarPanel. (The parent component should be "
+ "constructed using the DatePickerSettings instance where the veto policy "
+ "will be applied. The previous sentence is probably simpler than it sounds.)");
}
this.vetoPolicy = vetoPolicy;
// If the parent is an independent calendar panel, redraw the panel to show the new policy.
zDrawIndependentCalendarPanelIfNeeded();
// Return true if the selected date is allowed by the new policy, otherwise return false.
LocalDate parentDate = zGetParentSelectedDate();
return isDateAllowed(parentDate);
}
/**
* setVisibleDateTextField, This sets the visibility of the DatePicker text field. This can be
* used in conjunction with "setGapBeforeButtonPixels(0)" to create an instance of the date
* picker that only displays the toggle calendar button. One reason a developer might want to do
* this, is if they wished to provide their own component to display any selected date.
*/
public void setVisibleDateTextField(boolean isVisible) {
isVisibleDateTextField = isVisible;
if (parentDatePicker != null) {
parentDatePicker.zApplyVisibilityOfComponents();
}
}
/**
* setVisibleClearButton, This sets the visibility of the named component.
*/
public void setVisibleClearButton(boolean isVisible) {
isVisibleClearButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisibleMonthMenuButton, This sets the visibility of the named component.
*/
public void setVisibleMonthMenuButton(boolean isVisible) {
isVisibleMonthMenuButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisibleNextMonthButton, This sets the visibility of the named component.
*/
public void setVisibleNextMonthButton(boolean isVisible) {
isVisibleNextMonthButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisibleNextYearButton, This sets the visibility of the named component.
*/
public void setVisibleNextYearButton(boolean isVisible) {
isVisibleNextYearButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisiblePreviousMonthButton, This sets the visibility of the named component.
*/
public void setVisiblePreviousMonthButton(boolean isVisible) {
isVisiblePreviousMonthButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisiblePreviousYearButton, This sets the visibility of the named component.
*/
public void setVisiblePreviousYearButton(boolean isVisible) {
isVisiblePreviousYearButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisibleTodayButton, This sets the visibility of the named component.
*/
public void setVisibleTodayButton(boolean isVisible) {
isVisibleTodayButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setVisibleYearMenuButton, This sets the visibility of the named component.
*/
public void setVisibleYearMenuButton(boolean isVisible) {
isVisibleYearMenuButton = isVisible;
zApplyIndependentCalendarPanelButtonVisibilityIfNeeded();
}
/**
* setWeekNumberRules, This sets the week number rules that will be used to show the week
* numbers (the weeks of the year), whenever the week numbers are displayed on this calendar.
*
* The definitions for the first day of the week, and for the minimum number of days that
* constitutes the first week of the year, varies between locales. The Java time WeekFields
* class specifies those rules.
*
* If you set this setting to null, then the weekNumberRules will be set to match the
* DatePickerSettings locale. By default, the week number rules will match the
* DatePickerSettings locale.
*
* If you would like the week number rules to be the same for all calendars (regardless of the
* locale), then you should consider setting the weekNumberRules to one of these two widely used
* rule sets: WeekFields.ISO or WeekFields.SUNDAY_START.
*/
public void setWeekNumberRules(WeekFields weekNumberRules) {
if (weekNumberRules == null) {
weekNumberRules = WeekFields.of(locale);
}
this.weekNumberRules = weekNumberRules;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setWeekNumbersDisplayed, This specifies whether or not numbers for the "week of the year"
* should be displayed on the calendar panel. The week numbers will be shown if this is true, or
* they will not be shown if this is false. This is false by default.
*
* The week numbers are locale sensitive, because the definition of the first day of the week,
* and the definition for the minimum number of days in the first week of the year, varies
* between locales.
*
* By default, when "weekNumbersDisplayed" is true, the first day of the week used by the
* calendar will always match the weekNumberRules definition for first day of the week. This
* behavior can be changed by modifying the setting "weekNumbersForceFirstDayOfWeekToMatch".
*
* @param weekNumbersDisplayed This determines whether the week numbers should be displayed on
* the calendar. They will be shown if this is true, or not shown that this is false
*
* @param applyMatchingDefaultBorders This determines if this function will update the border
* label properties to show the appropriate default borders. The default border label settings
* are different, depending on "showWeekNumbers". If you have not customized the border label
* properties, then it is recommended that you always set the "applyMatchingDefaultBorders"
* parameter to true. This will ensure that the calendar borders will always use the correct
* default settings. If you set this parameter to false, than the current border settings will
* not be changed by this function.
*/
public void setWeekNumbersDisplayed(boolean weekNumbersDisplayed,
boolean applyMatchingDefaultBorders) {
this.weekNumbersDisplayed = weekNumbersDisplayed;
if (applyMatchingDefaultBorders) {
setBorderPropertiesList(null);
}
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* setWeekNumbersWillOverrideFirstDayOfWeek, This setting determines how to resolve any conflict
* between the "weekNumberRules" setting and the "firstDayOfWeek" setting. Note: This setting
* only has an effect when "weekNumbersDisplayed" is true.
*
* 1) If this setting is true (Default): Whenever the week numbers are displayed, then the first
* day of the week that is displayed on the calendar will always match the currently set
* "weekNumberRules". This enforces a strict and consistent definition for the week numbers.
* Specifically, this guarantees that all seven dates in each calendar row will belong to a
* single week number. Note: The WeekNumberRules are an instance of the java.time.temporal
* "WeekFields" class. For more information about how week numbers are defined, see the
* WeekFields javadocs.
*
* 2) If this setting is false: The first day of the week that is displayed on the calendar will
* always match the "firstDayOfWeek" setting, and a more "flexible" definition of week numbers
* will be applied. Using a firstDayOfWeek that does not match the week number rules will cause
* each calendar row to contain dates that fall inside two different week numbers. (As defined
* by the weekNumberRules.) In this circumstance, the displayed week numbers will be determined
* by a "majority rules" system, which is defined below.
*
* The "majority rules" system: Under the majority rule system, the calendar will count the
* number of days in each row that belong to each week number. In a single row, four (or more)
* days will match one week number, and three (or less) days will match a different week number.
* The most commonly occurring week number will be displayed next to each row.
*
* To summarize: If your program needs to implement a strict week number definition, then it is
* recommended to leave this setting at its default value (of true). If it is more important to
* have a flexible first day of the week, then you could set this value to false. When this
* setting is false, the displayed week numbers will follow a "majority rules" system, and will
* not exactly match the week number rules.
*/
public void setWeekNumbersWillOverrideFirstDayOfWeek(
boolean weekNumbersWillOverrideFirstDayOfWeek) {
this.weekNumbersWillOverrideFirstDayOfWeek = weekNumbersWillOverrideFirstDayOfWeek;
zDrawIndependentCalendarPanelIfNeeded();
}
/**
* zApplyAllowEmptyDates, This applies the named setting to the parent component.
*
* Implementation Notes:
*
* This cannot throw an exception while the parent DatePicker or parent CalendarPanel is being
* constructed, because a veto policy cannot be set until after the parent component is
* constructed.
*/
void zApplyAllowEmptyDates() {
// If we don't have a parent, then there is nothing to do here. (So, we return.)
if (!hasParent()) {
return;
}
// Find out if we need to initialize a null date.
LocalDate selectedDate = zGetParentSelectedDate();
if ((!allowEmptyDates) && (selectedDate == null)) {
// We need to initialize the current date, so find out if today is vetoed.
LocalDate today = LocalDate.now(clock);
if (InternalUtilities.isDateVetoed(vetoPolicy, today)) {
throw new RuntimeException("Exception in DatePickerSettings.zApplyAllowEmptyDates(), "
+ "Could not initialize a null date to today, because today is vetoed by "
+ "the veto policy. To prevent this exception, always call "
+ "setAllowEmptyDates() -before- setting a veto policy.");
}
// Initialize the current date.
zSetParentSelectedDate(today);
}
}
/**
* zApplyAllowKeyboardEditing, This applies the named setting to the parent component.
*/
void zApplyAllowKeyboardEditing() {
if (parentDatePicker == null) {
return;
}
// Set the editability of the date picker text field.
parentDatePicker.getComponentDateTextField().setEditable(allowKeyboardEditing);
// Set the text field border color based on whether the text field is editable.
Color textFieldBorderColor = (allowKeyboardEditing)
? InternalConstants.colorEditableTextFieldBorder
: InternalConstants.colorNotEditableTextFieldBorder;
parentDatePicker.getComponentDateTextField().setBorder(new CompoundBorder(
new MatteBorder(1, 1, 1, 1, textFieldBorderColor), new EmptyBorder(1, 3, 2, 2)));
}
/**
* zApplyGapBeforeButtonPixels, This applies the named setting to the parent component.
*/
void zApplyGapBeforeButtonPixels() {
int gapPixels = (gapBeforeButtonPixels == null) ? 3 : gapBeforeButtonPixels;
ConstantSize gapSizeObject = new ConstantSize(gapPixels, ConstantSize.PIXEL);
ColumnSpec columnSpec = ColumnSpec.createGap(gapSizeObject);
FormLayout layout = ((FormLayout) parentDatePicker.getLayout());
layout.setColumnSpec(2, columnSpec);
}
/**
* zApplyIndependentCalendarPanelButtonVisibilityIfNeeded, If needed, this will apply the
* visibility settings for buttons to the independent CalendarPanel. This function only has an
* effect if the parent of this settings instance is an independent CalendarPanel (and not a
* DatePicker).
*/
private void zApplyIndependentCalendarPanelButtonVisibilityIfNeeded() {
if (parentCalendarPanel != null) {
parentCalendarPanel.zApplyVisibilityOfButtons();
}
}
void zApplyDisabledTextColor()
{
parentDatePicker.getComponentDateTextField().setDisabledTextColor(
getColor(DateArea.DatePickerTextDisabled));
}
/**
* zDrawDatePickerTextFieldIfNeeded, If needed, this will redraw the parent date picker text
* field. This function only has an effect if the parent of this settings instance is a
* DatePicker.
*/
void zDrawDatePickerTextFieldIfNeeded() {
if (parentDatePicker != null) {
parentDatePicker.setTextFieldToValidStateIfNeeded();
}
}
/**
* zDrawIndependentCalendarPanelIfNeeded, If needed, this will redraw the independent
* CalendarPanel. This function only has an effect if the parent of this settings instance is an
* independent CalendarPanel (and not a DatePicker).
*/
private void zDrawIndependentCalendarPanelIfNeeded() {
if (zSkipDrawIndependentCalendarPanelIfNeeded) {
return;
}
if (parentCalendarPanel != null) {
parentCalendarPanel.drawCalendar();
}
}
/**
* zGetParentSelectedDate, Returns the currently selected date from the parent DatePicker or
* parent independent CalendarPanel (using whichever parent currently exists). If this settings
* instance does not have a parent, then this will return null. Note that any calling code
* should generally verify whether or not this settings instance has a parent, before calling
* this function.
*/
private LocalDate zGetParentSelectedDate() {
if (!hasParent()) {
return null;
}
boolean useDatePicker = (parentDatePicker != null);
return (useDatePicker) ? parentDatePicker.getDate() : parentCalendarPanel.getSelectedDate();
}
/**
* zGetDefaultBorderPropertiesList, This creates and returns a list of default border properties
* for the calendar. The default border properties will be slightly different depending on
* whether or not the week numbers are currently displayed in the calendar.
*
* Technical notes: This does not save the default border properties to the date picker settings
* class. This does not clear the existing borders. This does not apply the border properties
* list to the calendar. This does not set the upper left corner calendar label to be visible or
* invisible.
*/
private ArrayList zGetDefaultBorderPropertiesList() {
ArrayList results = new ArrayList();
Color defaultDateBoxBorderColor = new Color(99, 130, 191);
Color defaultWeekdayEndcapsBorderColor = colorBackgroundWeekdayLabels;
Color defaultWeekNumberEndcapsBorderColor = colorBackgroundWeekNumberLabels;
// Set the borders properties for the date box.
CalendarBorderProperties dateBoxBorderProperties = new CalendarBorderProperties(
new Point(3, 3), new Point(5, 5), defaultDateBoxBorderColor, 1);
results.add(dateBoxBorderProperties);
// Set the borders properties for the weekday label endcaps.
CalendarBorderProperties weekdayLabelBorderProperties = new CalendarBorderProperties(
new Point(3, 2), new Point(5, 2), defaultWeekdayEndcapsBorderColor, 1);
results.add(weekdayLabelBorderProperties);
// Set the border properties for borders above and below the week numbers.
// Note that the week number borders are only displayed when the week numbers are also
// displayed. (This is true of any borders located in columns 1 and 2.)
CalendarBorderProperties weekNumberBorderProperties = new CalendarBorderProperties(
new Point(2, 3), new Point(2, 5), defaultWeekNumberEndcapsBorderColor, 1);
results.add(weekNumberBorderProperties);
// Return the results.
return results;
}
/**
* zGetDefaultYearMonthAsUsed, This returns the default YearMonth, but substitutes
* YearMonth.now() for any null value. This will never return null.
*/
YearMonth zGetDefaultYearMonthAsUsed() {
return (defaultYearMonth == null) ? YearMonth.now(clock) : defaultYearMonth;
}
/**
* zSetParentCalendarPanel, This sets the parent calendar panel for these settings. A settings
* instance may only be used for one picker component. If the setting instance already has a
* parent component, then an exception will be thrown.
*
* This is package private, and is only intended to be called from the CalendarPanel class.
*/
void zSetParentCalendarPanel(CalendarPanel parentCalendarPanel) {
if (hasParent()) {
throw new RuntimeException("DatePickerSettings.setParentCalendarPanel(), "
+ "A DatePickerSettings instance can only be used as the settings for "
+ "one parent object. (Settings instances cannot be reused for multiple "
+ "DatePickers, multiple independent CalendarPanels, or for combinations "
+ "of both. )");
}
this.parentCalendarPanel = parentCalendarPanel;
}
/**
* zSetParentDatePicker, This sets the parent date picker for these settings. This is only
* intended to be called from the constructor of the DatePicker class.
*/
void zSetParentDatePicker(DatePicker parentDatePicker) {
if (hasParent()) {
throw new RuntimeException("DatePickerSettings.setParentCalendarPanel(), "
+ "A DatePickerSettings instance can only be used as the settings for "
+ "one parent object. (Settings instances cannot be reused for multiple "
+ "DatePickers, multiple independent CalendarPanels, or for combinations "
+ "of both.)");
}
this.parentDatePicker = parentDatePicker;
}
/**
* zSetParentSelectedDate, Sets the currently selected date for the parent DatePicker or parent
* independent CalendarPanel (using whichever parent currently exists). If this settings
* instance does not have a parent, then this will not do anything. Note that any calling code
* should generally verify whether or not this settings instance has a parent, before calling
* this function.
*/
private void zSetParentSelectedDate(LocalDate dateValue) {
if (parentDatePicker != null) {
parentDatePicker.setDate(dateValue);
}
if (parentCalendarPanel != null) {
parentCalendarPanel.setSelectedDate(dateValue);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy