将自定义 FXML 属性设置为自定义 javafx 组件的参数

Question

我创建了自定义组件 TableBlock。它由Label 和TableView 组成。例如，TableView 可以有 1 到 1000 行。行数由 FXML 文件中的参数“rowsFromPrefs”定义。创建 TableView 需要此参数。 TableView 完全由 JAva 代码创建，在 fxml 中只是它的标签和参数，带有许多行。

据我所知，JavaFX 在构造 FXML 组件时，首先调用构造函数，然后调用 @FXML 注释字段，然后启动 initialize() 方法。

在我的例子中，当 initialize() 启动时，变量 rowsFromPrefs 仍然为空！但是，如果我尝试从其他线程（不是 JavaFX 启动器）获取 rowsFromPrefs 的值，我会看到它定义了 =“2”，就像它应该的那样。

所以我无法理解 Java 在什么时候从 FXML 文件中分配对象参数。创建对象时如何将参数从 fxml 文件传递​​给对象。

我看到了构造函数参数的@NamedArg 注释。创建对象时是否只有一种传递参数的方式？

控制器可以定义一个initialize()方法，当其相关文档的内容已经完全加载时，将在一个实现控制器上调用一次：

TableBlock.java

public class TableBlock extends VBox{
    @FXML
    private String rowsFromPrefs;
    @FXML
    private Label label;

public TableBlock() {
    FXMLLoader fxmlLoader = new   FXMLLoader(getClass().getResource("TableBlock.fxml"));
    fxmlLoader.setRoot(this);
    fxmlLoader.setController(this);
    try {
        fxmlLoader.load();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

@FXML
public void initialize() {
    this.table = createTable(rowsFromPrefs);
}

public String getRowsFromPrefs() {
    System.out.println("getRowsFromPrefs");
    return rowsFromPrefs;
}


public void setRowsFromPrefs(String rowsFromPrefs) {
    this.rowsFromPrefs = rowsFromPrefs;
}

}

TableBlock.fxml

<?xml version="1.0" encoding="UTF-8"?>

<?import javafx.scene.control.*?>
<?import ru.laz.model.controls.*?>
<?import java.lang.*?>
<?import javafx.scene.layout.*?>
<?import javafx.scene.layout.AnchorPane?>
<?import ru.laz.model.controls.tableblock.*?>


<fx:root type="javafx.scene.layout.VBox" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1">
   <children>
      <Label text="Label" />
   </children>
</fx:root>

View.java

public class View extends Application {
Parent root = null;
private Scene scene;

@Override
    public void init() {
    try {
            root = FXMLLoader.load(getClass().getResource("View.fxml"));
            root.requestLayout();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
}

@Override
    public void start(final Stage stage) throws Exception {
     scene = new Scene(root, 640, 480, Color.LIGHTGRAY);
     stage.show();
}

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

}

View.fxml

<?xml version="1.0" encoding="UTF-8"?>

<?import java.lang.*?>
<?import javafx.scene.layout.*?>
<?import javafx.scene.control.*?>
<?import ru.laz.model.controls.tableblock.*?>


<AnchorPane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1">
   <children>
      <TableBlock rowsFromPrefs="2" id="IDDQD"/>
   </children>
</AnchorPane>

Answer 1

首先，请注意rowsFromPrefs 上的@FXML 注释没有任何作用。 @FXML 当当前对象为控制器的 FXML 文件具有一个具有 fx:id 属性且其值与字段名称匹配的元素时，会导致为该字段注入一个值。由于TableBlock.fxml 没有带有fx:id="rowsFromPrefs" 的元素，所以这个注解没有做任何事情。

当正在加载View.fxml 的FXMLLoader 遇到<TableBlock> 元素时，它会通过调用其构造函数来创建TableBlock 实例。然后它将设置属性指定的值。所以你的 FXML 元素

<TableBlock rowsFromPrefs="2" id="IDDQD"/>

本质上等价于

TableBlock tableBlock = new TableBlock();
tableBlock.setRowsFromPrefs("2");
tableBlock.setId("IDDQD");

当然，TableBlock 的构造函数只是按照代码所说的去做：它创建一个FXMLLoader，为该FXMLLoader 设置根和控制器，然后调用load()。 that FXMLLoader 的加载过程将在控制器上设置@FXML-injected 字段（构造函数正在执行的TableBlock 对象），然后调用initialize()。

所以initialize() 被调用作为FXMLLoader.load() 调用的一部分，在TableBlock 构造函数中；当然，这一切都发生在setRowsFromPrefs("2"); 被调用之前。

总而言之，TableBlock.initialize() 是在 TableBlock.fxml 被解析之后调用的，并且在那里定义的任何元素都被注入到它们对应的 @FXML 注释字段中，但这发生在 View.fxml 被加载之前。

解决此问题的一种方法是将rowsFromPrefs 传递给TableBlock 构造函数。为此，请使用@NamedArg annotation：

public class TableBlock extends VBox{

    private final String rowsFromPrefs;

    @FXML
    private Label label;

    public TableBlock(@NamedArg("rowsFromPrefs") String rowsFromPrefs) {

        this.rowsFromPrefs = rowsFromPrefs ;
        FXMLLoader fxmlLoader = new   FXMLLoader(getClass().getResource("TableBlock.fxml"));
        fxmlLoader.setRoot(this);
        fxmlLoader.setController(this);
        try {
            fxmlLoader.load();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @FXML
    public void initialize() {
        this.table = createTable(rowsFromPrefs);
    }

    public String getRowsFromPrefs() {
        System.out.println("getRowsFromPrefs");
        return rowsFromPrefs;
    }


}

现在，您在 FXML 中的属性将被传递给构造函数而不是 set 方法，因此 rowsFromPrefs 将在您调用 fxmlLoader.load() 之前根据需要进行初始化。

当然，另一种选择是将代码从initialize() 方法移动到setRowsFromPrefs(...) 方法。如果您打算为每个 TableBlock 实例修复 rowsFromPrefs，我将使用上述选项，并且仅当您希望能够在单个 TableBlock 实例的生命周期内更改 rowsFromBlocks 时才使用第二个选项.