跳至主要内容

DateField

在 ChatGPT 中打开
阴影 dwc-field 23.02
Java API

DateField 组件允许用户通过年、月和日输入或选择日期。它会自动处理验证，因此格式不正确的日期会在表单提交之前被捕获。

使用 DateField​

Inheritance

This class is a Field component, and inherits its features and behaviors. For an overview of Field properties, events, and other important information, please refer to the Field documentation.

DateField 扩展了共享的 Field 类，该类提供了所有字段组件的共同特性。以下示例创建了出发和返回的 DateField，保持同步，并有最小和最大限制，以限制可选择的范围。

显示代码

字段值 (LocalDate)​

DateField 组件内部将其值存储为 LocalDate 对象，表示没有时间或时区信息的日期。这允许在不同系统间准确处理基于日历的输入。

显示值与解析值

虽然 显示值 会根据用户的浏览器区域设置进行调整，以确保符合区域习惯的格式（例如，在美国为 MM/DD/YYYY，在欧洲为 DD.MM.YYYY），解析值 始终依赖于固定格式 yyyy-MM-dd。

获取和设置 LocalDate 值​

要检索当前值，请使用 getValue() 方法：

LocalDate value = dateField.getValue();

要以编程方式设置值，请使用 setValue() 方法：

dateField.setValue(LocalDate.of(2024, 4, 27));

使用 setText()​

您还可以使用原始字符串分配值，但必须遵循准确的 yyyy-MM-dd 格式：

dateField.setText("2024-04-27"); // 有效

dateField.setText("04/27/2024"); // 无效
警告

使用 setText() 方法时，如果组件无法解析 yyyy-MM-dd 格式的输入，将抛出 IllegalArgumentException。

用法​

DateField 非常适合在您的应用中选择和显示日期。以下是一些使用 DateField 的例子：

  1. 事件安排和日历：日期字段在涉及事件安排、预约预订或跟踪重要日期的应用中是必不可少的。

  2. 表单输入：简化用户填写需要日期的表单（如生日）的日期选择过程。

  3. 预订和预约系统：涉及预订和预约系统的应用通常要求用户输入特定日期。日期字段简化了这一过程，并确保准确选择日期。

  4. 任务管理和截止日期：日期字段在涉及任务管理或设定截止日期的应用中非常有价值。用户可以轻松指定到期日期、开始日期或其他时间敏感信息。

最小值和最大值​

最小值​

setMin() 方法定义了用户可以输入的最早日期。如果输入日期早于指定的最小值，则会失败约束验证。当与 setMax() 一起使用时，最小值必须是与最大值相同或早于该最大值的日期。

dateField.setMin(LocalDate.of(2023, 1, 1)); // 最小允许：2023年1月1日

最大值​

setMax() 方法定义了组件接受的最晚日期。如果输入的日期晚于指定的最大值，则输入无效。当同时定义这两个值时，最大值必须是与最小值相同或晚于该最小值的日期。

dateField.setMax(LocalDate.of(2023, 12, 31)); // 最大允许：2023年12月31日

静态工具​

DateField 类还提供以下静态实用方法：

  • fromDate(String dateAsString)：将 yyyy-MM-dd 格式的日期字符串转换为 LocalDate 对象，然后可以在此字段或其他地方使用。

  • toDate(LocalDate date)：将 LocalDate 对象转换为 yyyy-MM-dd 格式的日期字符串。

  • isValidDate(String dateAsString)：检查给定字符串是否为有效的 yyyy-MM-dd 日期。

最佳实践​

为了确保在使用 DateField 组件时提供最佳用户体验，请考虑以下最佳实践：

  • 无障碍性：使用合适的标签，以确保具有辅助技术的用户能够轻松导航并使用您应用中的日期字段。

  • 自动填充当前日期：如果适合您应用的使用案例，可自动填充当前日期到日期字段中。