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

Question

我创建了一个自定义组件TableBlock，由Label和TableView组成。TableView可以有1到1000行，行数由FXML文件中的"rowsFromPrefs"参数定义。此参数用于创建TableView。TableView完全由Java代码创建，在fxml中只有其标签和带有行数的参数。

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

在我的情况下，当initialize()开始时，变量rowsFromPrefs仍为空！但是，如果我尝试从其他线程（而不是JavaFX-launcher）获取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>

- Dmitry Lazarev

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()。那个 FXMLLoader 的加载过程将在控制器上设置 @FXML 注入字段（执行构造函数的 TableBlock 对象），然后调用 initialize()。

因此，在调用 setRowsFromPrefs("2"); 之前，initialize() 作为调用 TableBlock 构造函数中的 FXMLLoader.load() 的一部分被调用。

因此，总之，TableBlock.initialize() 在解析 TableBlock.fxml 并将其中定义的任何元素注入到相应的 @FXML 注释字段之后被调用，但这发生在加载 View.fxml 之前。

修复此问题的一种方法是将 rowsFromPrefs 传递给 TableBlock 构造函数。为此，请使用 @NamedArg 注释。

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(...)方法中。如果您打算让rowsFromPrefs对于每个TableBlock实例都固定不变，则使用上述选项，并仅在想要在单个TableBlock实例的生命周期内更改rowsFromBlocks时使用第二个选项。

- James_D

---

非常感谢您详细的解释。我认为NamedArg是一个合适的解决方案。 - Dmitry Lazarev