如何使用 JavaFX 创建基于日期列表的 DatePicker

本文介绍了如何使用 JavaFX 创建一个 DatePicker 组件，使其只允许用户选择预定义的日期列表中的日期。通过自定义 DateCell 的 dayCellFactory，可以禁用 DatePicker 中不在列表中的日期，从而实现特定的日期选择限制。

在 JavaFX 应用程序中，有时我们需要限制用户只能从预先定义的日期列表中选择日期。例如，在排班系统中，可能只允许用户选择已经安排了班次的日期。本文将介绍如何使用 DatePicker 和 DateCell 来实现这一功能。

核心思路：自定义 DateCell

DatePicker 允许我们通过 dayCellFactory 属性自定义日期单元格 (DateCell) 的外观和行为。我们可以创建一个自定义的 DateCell，并在其中判断当前日期是否在允许的日期列表中。如果不在列表中，则禁用该日期单元格。

立即学习“Java免费学习笔记（深入）”；

实现步骤

1. 准备日期列表： 首先，你需要一个 List<LocalDate>，其中包含允许选择的日期。

   

   小羊标书

   一键生成百页标书，让投标更简单高效

   下载

   List<LocalDate> dateList = new ArrayList<>();
   dateList.add(LocalDate.of(2023, 10, 26));
   dateList.add(LocalDate.of(2023, 10, 27));
   dateList.add(LocalDate.of(2023, 10, 28));
   // 添加更多日期

2. 创建自定义 DateCellFactory： 创建一个 Callback<DatePicker, DateCell>，用于生成自定义的 DateCell。

   import javafx.scene.control.DateCell;
   import javafx.scene.control.DatePicker;
   import javafx.util.Callback;
   import java.time.LocalDate;
   import java.util.List;
   
   final Callback<DatePicker, DateCell> dayCellFactory = new Callback<DatePicker, DateCell>() {
       @Override
       public DateCell call(final DatePicker datePicker) {
           return new DateCell() {
               @Override
               public void updateItem(LocalDate item, boolean empty) {
                   super.updateItem(item, empty);
                   // 如果日期为空或者不在列表中，则禁用
                   setDisable(empty || !dateList.contains(item));
               }
           };
       }
   };

   • Callback<DatePicker, DateCell>：定义了一个回调函数，它接受一个 DatePicker 对象作为输入，并返回一个 DateCell 对象。
   • updateItem(LocalDate item, boolean empty)：此方法在每次单元格需要更新时调用。item 参数是当前日期，empty 参数指示单元格是否为空。
   • setDisable(empty || !dateList.contains(item))：此行代码是关键。它根据日期是否在 dateList 中设置单元格的禁用状态。如果日期为空或不在列表中，则单元格将被禁用。

3. 将 DateCellFactory 应用于 DatePicker： 将创建的 dayCellFactory 设置给 DatePicker 的 dayCellFactory 属性。

   DatePicker datePicker = new DatePicker();
   datePicker.setDayCellFactory(dayCellFactory);

完整示例代码

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.control.DateCell;
import javafx.scene.control.DatePicker;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;
import javafx.util.Callback;

import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;

public class DatePickerExample extends Application {

    @Override
    public void start(Stage primaryStage) {
        List<LocalDate> dateList = new ArrayList<>();
        dateList.add(LocalDate.of(2023, 10, 26));
        dateList.add(LocalDate.of(2023, 10, 27));
        dateList.add(LocalDate.of(2023, 10, 28));

        final Callback<DatePicker, DateCell> dayCellFactory = new Callback<DatePicker, DateCell>() {
            @Override
            public DateCell call(final DatePicker datePicker) {
                return new DateCell() {
                    @Override
                    public void updateItem(LocalDate item, boolean empty) {
                        super.updateItem(item, empty);
                        setDisable(empty || !dateList.contains(item));
                    }
                };
            }
        };

        DatePicker datePicker = new DatePicker();
        datePicker.setDayCellFactory(dayCellFactory);

        StackPane root = new StackPane(datePicker);
        Scene scene = new Scene(root, 300, 250);

        primaryStage.setTitle("DatePicker Example");
        primaryStage.setScene(scene);
        primaryStage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

注意事项

• 确保 dateList 在 dayCellFactory 内部可以访问。可以使用成员变量或者将其作为参数传递给 dayCellFactory。
• updateItem 方法会被频繁调用，因此避免在此方法中执行耗时的操作。
• 可以根据需要自定义 DateCell 的其他属性，例如背景颜色、字体等，以进一步定制外观。

总结

通过自定义 DatePicker 的 dayCellFactory，我们可以灵活地控制哪些日期可以被选择。这对于需要限制用户输入日期的应用程序非常有用。本文提供了一个简单的示例，展示了如何基于日期列表创建受限制的 DatePicker。你可以根据自己的需求进行修改和扩展。