如何扩展使用 FXML 的自定义 JavaFX 组件

Question

如果自定义 JavaFX 组件使用 FXML 作为视图，我如何正确扩展它以添加或修改其 GUI 组件？

作为示例场景，假设我使用以下方法创建自定义 JavaFX 组件：

SpecializedButton.java（控制器）

package test;

import java.io.IOException;
import javafx.fxml.FXML;
import javafx.fxml.FXMLLoader;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.layout.HBox;

public class SpecializedButton extends HBox
{
    @FXML private Button button;
    @FXML private Label label;

    public SpecializedButton() 
    {
        FXMLLoader loader = new FXMLLoader( getClass().getResource( "SpecializedButton.fxml" ) );

        loader.setRoot( this );
        loader.setController( this );

        try {
            loader.load();
        } catch ( IOException e ) {
            throw new RuntimeException( e );
        }
    }

    // specialized methods for this specialized button
    // ...
    public void doSomething() {
        button.setText( "Did something!" );
    }
}

SpecializedButton.fxml（视图）

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

<?import java.lang.*?>
<?import javafx.scene.control.*?>
<?import javafx.scene.layout.*?>
<?import javafx.scene.layout.AnchorPane?>
<?import javafx.scene.control.Button?>

<fx:root type="HBox" xmlns="http://javafx.com/javafx/8" xmlns:fx="http://javafx.com/fxml/1">
   <children>
      <AnchorPane HBox.hgrow="ALWAYS">
         <children>
            <Label fx:id="label" text="Click to do something: " AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0" />
         </children>
      </AnchorPane>
      <AnchorPane HBox.hgrow="ALWAYS">
         <children>
            <Button fx:id="button" onAction="#doSomething" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0" />
         </children>
      </AnchorPane>
   </children>
</fx:root>

MyApp.java

package test;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application
{
    public static void main( String[] args )
    {
        launch( args );
    }

    public void start( Stage stage ) throws Exception
    {
        stage.setScene( new Scene( new SpecializedButton(), 300, 50 ) );
        stage.show();
    }
}

SpecializedButton 类加载 FXML 视图 (SpecializedButton.fxml) 并充当它的控制器。

SpecializedButton FXML 视图只是创建了一个 HBox，其中包含两个 AnchorPanes 以及一个标签和一个按钮，分别位于左侧和右侧。单击按钮时，它会调用 SpecializedButton 控制器类中的 doSomething()。

---

问题

通过此设置，我使用 FXML 将视图与应用程序逻辑分开。

但是，如果我想创建一个扩展 SpecializedButton 的新 HighlySpecializedButton 类，我也不知道如何“扩展”视图。

如果我想使用 SpecializedButton 视图，但要为 HighSpecializedButton 修改它，我必须将视图代码复制到新的 FXML 文件中，从而导致重复代码而不是正确继承。

如果我不使用 FXML，而是在 Java 类中创建 GUI 组件，扩展该类将使我能够正确继承和添加/修改超类中的组件。

我显然误解了有关 JavaFX 的一些非常重要的概念。

---

问题

在这种情况下，FXML 视图是否如此“愚蠢”，以至于每次我想从自定义组件继承时都必须创建一个全新的 FXML 视图？

或者，如果我误解了真正的问题，创建可扩展的自定义 JavaFX 组件（无论是否使用 FXML）的正确方法是什么？

如果有任何见解，我将不胜感激。提前致谢！

Answer 1

据我了解，您希望能够扩展现有组件并避免 复制并粘贴新组件的整个标记。

您可以使用@DefaultProperty 注释为组件定义扩展点。 看看例如javafx.scene.layout.Pane：有一个ObservableList getChildren() 用@DefaultProperty("children") 定义。 这样，当您使用 e.x 和 HBox（扩展 Pane）作为组件的根元素时，所有子组件都会添加到 Pane 定义的 children 属性中。

你可以用同样的方式在 FXML 中定义扩展点：

SpecializedButton.fxml（我为这个例子做了一点简化）

<fx:root type="HBox">
  <HBox>
    <Label fx:id="label" text="Click to do something: " />
    <HBox fx:id="extension"></HBox>
  </HBox>

  <HBox>
    <Button fx:id="button" onAction="#doSomething"/>
  </HBox>
</fx:root>

HBox fx:id="extension" 将是我的扩展点：

@DefaultProperty(value = "extension")
public class SpecializedButton extends HBox
{
    @FXML private HBox extension;

    public ObservableList<Node> getExtension() {
        return extension.getChildren();
    }
    // ... more component specific code
}

SuperSpecializedButton.fxml

<fx:root type="SpecializedButton">
  <Label text="EXTENDED HALLO"/>
</fx:root>

还有：

public class SuperSpecializedButton extends SpecializedButton
{
    // ... more component specific code
}

如您所见，我只需要为超专业化组件定义fxml即可。

This code will work only on JavaFX >= 2.1。之前超类的组件注入不适用于 FXMLLoader。

我在 github 上添加了一个工作示例：https://github.com/matrak/javafx-extend-fxml

Answer 2

我以前没有这样做过，但是当你实例化一个新的自定义组件时，你可以实现 Initializable 接口来设置视图组件。

要添加新组件（标签、按钮、img 等...），我会将视图文件中的所有子组件包装在 AnchorPane、GridPane、VBox 或您希望以编程方式添加更多组件的组件中。由于您正在从 HBox 扩展您的课程，因此您已经可以这样做了。

我会这样做：

public class SpecializedButton extends HBox implements Initializable{

@FXML private Button button;
@FXML private Label label;

public SpecializedButton(){
    FXMLLoader loader = new FXMLLoader( getClass().getResource( "SpecializedButton.fxml" ) );

    loader.setRoot( this );
    loader.setController( this );

    try {
        loader.load();
    } catch ( IOException e ) {
        throw new RuntimeException( e );
    }
}

// specialized methods for this specialized button
// ...
public void doSomething() {
    button.setText( "Did something!" );
}

@Override
public void initialize(URL url, ResourceBundle rb) {
    button.setText("Initialized Text");
}  
}

所以对于HighlySpecializedButton 类：

public class HighlySpecializedButton extends SpecializedButton {



public HighlySpecializedButton (){
    super();
}

// HighlySpecializedButton methods


@Override
public void initialize(URL url, ResourceBundle rb) {
    this.getChildren().add(new Button("New Button"));

}  
}

希望对你有帮助