MaskedDateField

MaskedDateField 是一个用于结构化日期输入的文本输入控件。它允许用户以数字的形式输入日期，并在字段失去焦点时根据定义的掩码自动格式化输入。掩码是一个字符串，用于指定期望的日期格式，从而引导用户的输入和显示。

此组件支持灵活的解析、验证、本地化和值恢复。在注册、预订和调度等需要一致的、特定地区格式日期的表单中，它特别有用。

寻找时间输入？

MaskedDateField 仅专注于日期值。如果您需要一个类似的组件来输入和格式化时间，请查看 MaskedTimeField。

基础

MaskedDateField 可以在有或没有参数的情况下实例化。您可以定义初始值、标签、占位符和用于值更改的事件侦听器。

显示代码

Java

掩码规则

MaskedDateField 支持全球使用的多种日期格式，这些格式根据日、月和年的顺序而有所不同。常见模式包括：

日/月/年（在大多数欧洲地区使用）
月/日/年（在美国使用）
年/月/日（在中国、日本和韩国使用；也是 ISO 标准：YYYY-MM-DD）

在这些格式中，本地变体包括分隔符的选择（例如，-、/ 或 .）、年份是两位还是四位数字、以及单个位数的月份或日期是否用前导零填充。

为了处理这种多样性，MaskedDateField 使用格式指示符，每个指示符以 % 开头，后跟一个表示日期特定部分的字母。这些指示符定义输入的解析方式和日期的显示方式。

日期格式指示符

格式	描述
`%Y`	年
`%M`	月
`%D`	日

修饰符

修饰符允许更精准地控制日期组件的格式化：

修饰符	描述
`z`	前零填充
`s`	短文本表示
`l`	长文本表示
`p`	压缩数字
`d`	十进制格式（默认格式）

这些可以组合以构建多种日期掩码。

日期格式本地化

MaskedDateField 通过设置适当的区域设置来适应本地日期格式。这确保日期以符合用户期望的方式显示和解析。

地区	格式	示例
美国	MM/DD/YYYY	`07/04/2023`
欧洲	DD/MM/YYYY	`04/07/2023`
ISO 标准	YYYY-MM-DD	`2023-07-04`

要应用本地化，请使用 setLocale() 方法。它接受一个 java.util.Locale，并自动调整格式和解析：

dateField.setLocale(Locale.FRANCE);

解析逻辑

MaskedDateField 根据定义的日期掩码解析用户输入。它同时接受完整和简略的数值输入，带或不带分隔符，允许灵活的输入，同时确保有效的日期。解析行为取决于掩码定义的格式顺序（例如，%Mz/%Dz/%Yz 代表月/日/年）。该格式决定了数字序列的解释方式。

例如，假设今天是 2012年9月15日，以下是各种输入的解释方式：

示例解析场景

输入	YMD (ISO)	MDY (US)	DMY (EU)
`1`	一个数字始终被解释为当前月份内的日期数字，因此这将被解释为 2012年9月1日。	同 YMD	同 YMD
`12`	两个数字始终被解释为当前月份内的日期数字，因此这将被解释为 2012年9月12日。	同 YMD	同 YMD
`112`	三个数字被解释为一个位数的月份数字后跟两位数的日期数字，因此这将被解释为 2012年1月12日。	同 YMD	三个数字被解释为一个位数的日期数字后跟两位数的月份数字，因此这将被解释为 2012年12月1日。
`1004`	四个数字被解释为 MMDD，因此这将被解释为 2012年10月4日。	同 YMD	四个数字被解释为 DDMM，因此这将被解释为 2012年4月10日。
`020304`	六个数字被解释为 YYMMDD，因此这将被解释为 2002年3月4日。	六个数字被解释为 MMDDYY，因此这将被解释为 2004年2月3日。	六个数字被解释为 DDMMYY，因此这将被解释为 2004年3月2日。
`8 digits`	八个数字被解释为 YYYYMMDD。例如，`20040612` 是 2004年6月12日。	八个数字被解释为 MMDDYYYY。例如，`06122004` 是 2004年6月12日。	八个数字被解释为 DDMMYYYY。例如，`06122004` 是 2004年12月6日。
`12/6`	用任何有效分隔符分隔的两个数字被解释为 MM/DD，因此这将被解释为 2012年12月6日。注意：除了字母和数字以外的所有字符均被视为有效分隔符。	同 YMD	用任何分隔符分隔的两个数字被解释为 DD/MM，因此这将被解释为 2012年6月12日。
`3/4/5`	2012年4月5日	2005年3月4日	2005年4月3日

文本日期解析 25.11

默认情况下，MaskedDateField 仅接受数字输入作为日期。然而，您可以启用 文本日期解析 以允许用户在输入中输入月份和日期的名称。该功能特别适用于创建更自然的日期输入。

要启用文本解析，请使用 setTextualDateParsing() 方法：

dateField.setTextualDateParsing(true);

月份名称替代

当启用文本解析时，您可以在掩码中使用特殊修饰符以接受月份名称而非数字值：

%Ms - 接受短月份名称（如 Jan、Feb、Mar 等）
%Ml - 接受长月份名称（如 January、February、March 等）

月份名称可以出现在掩码中的任何位置，并且字段仍会接受数字输入作为后备。

示例

掩码	输入	结果
`%Ms/%Dz/%Yz`	`Sep/01/25`	有效 - 解析为 2025年9月1日
`%Ml/%Dz/%Yz`	`September/01/25`	有效 - 解析为 2025年9月1日
`%Dz/%Ml/%Yz`	`01/September/25`	有效 - 解析为 2025年9月1日
`%Mz/%Dz/%Yz`	`09/01/25`	有效 - 数字后备仍然有效

信息

所有 12 个月都以短（Jan、Feb、Mar、Apr、May、Jun、Jul、Aug、Sep、Oct、Nov、Dec）和长（January、February 等）形式支持。

星期名称装饰

可在输入中包含星期几的名称以提高可读性，但它们 仅为装饰目的，在解析时会被去除。它们不会影响实际的日期值。

%Ds - 接受短星期名称（如 Mon、Tue、Wed 等）
%Dl - 接受长星期名称（如 Monday、Tuesday、Wednesday 等）

星期名称需要数字日期

当使用星期几的名称（%Ds 或 %Dl）时，您的掩码 必须还包括 %Dz 或 %Dd 来指定实际的日期数字。没有数字日期组件，输入将无效。

示例

掩码	输入	结果
`%Ds %Mz/%Dz/%Yz`	`Mon 09/01/25`	有效 - 星期名称为装饰
`%Dl %Mz/%Dz/%Yz`	`Monday 09/01/25`	有效 - 星期名称为装饰
`%Mz/%Dz/%Yz %Ds`	`09/01/25 Tue`	有效 - 星期名称在末尾
`%Dl/%Mz/%Yz`	`Monday/09/25`	无效 - 缺少 `%Dz`
`%Mz/%Dl/%Yz`	`09/Monday/25`	无效 - 缺少 `%Dz`

所有 7 天的星期都以短（Mon、Tue、Wed、Thu、Fri、Sat、Sun）和长（Monday、Tuesday 等）形式支持。

额外解析规则

文本日期解析包括多个有用的功能：

不区分大小写： 输入如 MONDAY 09/01/25、monday 09/01/25 或 Monday 09/01/25 都会以相同方式处理。
区域感知： 月和日的名称必须与字段的配置区域匹配。例如，使用法语区域时，使用 septembre 而不是 September。除非区域设置为英语，否则将不识别英语名称。
- 法语区域：septembre/01/25 被识别为九月
- 德语区域：Montag 09/01/25 被识别为星期一的名称

设置最小/最大约束

您可以通过使用 setMin() 和 setMax() 方法限制 MaskedDateField 中允许的日期范围：

dateField.setMin(LocalDate.of(2020, 1, 1));
dateField.setMax(LocalDate.of(2030, 12, 31));

这两个方法接受类型为 java.time.LocalDate 的值。超出定义范围的输入将被视为无效。

恢复值

MaskedDateField 包含一个恢复功能，可将字段的值重置为预定义或原始状态。这对于还原用户输入或重置为默认日期非常有用。

dateField.setRestoreValue(LocalDate.of(2025, 1, 1));
dateField.restoreValue();

恢复值的方式

以编程方式， 通过调用 restoreValue()
通过键盘， 按下 ESC （这是默认的恢复键，除非被事件侦听器重写）

您可以使用 setRestoreValue() 设置要恢复的值，传递一个 LocalDate 实例。

显示代码

Java

验证模式

您可以使用正则表达式通过 setPattern() 方法应用客户端验证规则：

dateField.setPattern("^\\d{2}/\\d{2}/\\d{4}$");

该模式确保只有与 MM/DD/YYYY 格式（两个数字、斜杠、两个数字、斜杠、四个数字）匹配的值被视为有效。

正则表达式格式

模式必须遵循 JavaScript RegExp 语法，如此处所述 here。

关于输入处理的注意事项

字段尝试根据当前掩码解析和格式化数字日期输入。然而，用户仍然可以手动输入不符合预期格式的值。如果输入在语法上是有效的，但在语义上不正确或无法解析（例如 99/99/9999），则可能通过模式检查，但逻辑验证失败。即使设置了正则表达式模式，您也应始终在应用逻辑中验证输入值，以确保日期格式正确且合理。

日期选择器

MaskedDateField 包含一个内置的日历选择器，允许用户以视觉方式选择日期，而不是手动输入。这提高了不太技术化用户的可用性，或者在需要精确输入时。

显示代码

Java

访问选择器

您可以使用 getPicker() 访问日期选择器：

DatePicker picker = dateField.getPicker();

显示/隐藏选择器图标

使用 setIconVisible() 显示或隐藏字段旁边的日历图标：

picker.setIconVisible(true); // 显示图标

自动打开行为

您可以配置选择器在用户与字段交互时（例如点击、按下 Enter 或箭头键）自动打开：

picker.setAutoOpen(true);

强制通过选择器进行选择

为了确保用户只能通过日历选择器选择日期（而不是手动输入），请结合以下两个设置：

dateField.getPicker().setAutoOpen(true); // 用户交互时打开选择器
dateField.setAllowCustomValue(false);    // 禁用手动文本输入

此设置确保所有日期输入都通过选择器 UI 进行，这在您希望严格控制格式并消除键入输入的解析问题时非常有用。

手动打开日历

要以编程方式打开日历：

picker.open();

或者使用别名：

picker.show(); // 等同于 open()

在日历中显示周数

选择器可以选择性地在日历视图中显示周数：

picker.setShowWeeks(true);