Comment comprendre et utiliser " <fx:root>` , en JavaFX?

<fx:root> fournit une solution à la question de la définition d'un composant réutilisable avec FXML.

Comme un exemple, imaginez que vous souhaitez définir un simple composant personnalisé composé d'un TextField et Button contenues dans un HBox. Vous avez besoin d'être représenté par une sous-classe de Node, de sorte que vous pouvez écrire du code comme

VBox vbox = new VBox();
vbox.getChildren().add(new MyComponent());

La question est, vous avez besoin d'une classe Java qui est une sous-classe de Node, ainsi que le FXML. En Java pur (pas de FXML), vous pouvez le faire avec:

public class MyComponent extends HBox {
    private TextField textField ;
    private Button button ;

    public MyComponent() {
        textField = new TextField();
        button = new Button();
        this.getChildren().addAll(textField, button);
    }
}

À l'aide de FXML pour définir le composant personnalisé sans <fx:root> élément présente un problème, parce que vous avez besoin de la FXML à être une sorte de nœud, puis un autre nœud de l'instance pour représenter la classe elle d'emballage:

<HBox>
<TextField fx:id="textField"/>
<Button fx:id="button" />
</HBox>

et

public class MyComponent extends HBox {
    @FXML
    private TextField textField ;
    @FXML
    private Button button ;
    public MyComponent() {
        try {
            FXMLLoader loader = new FXMLLoader(getClass().getResource("MyComponent.fxml"));
            loader.setController(this);
            HBox hbox = loader.load();
            this.getChildren().add(hbox);
        } catch (IOException exc) {
            //handle exception
        }
    }
}

Cette résultats dans MyComponent composé d'une HBox l'enchaînement d'un HBox habillage de la zone de texte et un Bouton. Supplémentaires, redondant HBox est un résultat d'avoir besoin d'un Nœud pour le FXML racine et un Nœud pour représenter le composant.

<fx:root> donne un mécanisme pour créer le Nœud que le composant (la classe Java) et puis charger le fichier FXML à utiliser que le nœud racine:

<fx:root type="javafx.scene.layout.HBox">
<TextField fx:id="textField" />
<Button fx:id="button" />
</fx:root>

et

public class MyComponent extends HBox {
    @FXML 
    private TextField textField ;
    @FXML
    private Button button ;
    public MyComponent() {
        try {
            FXMLLoader loader = new FXMLLoader(getClass().getResource("MyComponent.fxml"));
            loader.setController(this);
            loader.setRoot(this);
            loader.load();
        } catch (IOException exc) {
            //handle exception
        }
    }
}

Maintenant MyComponent a la même structure que l'original de toutes-version de Java, un HBox contenant un TextField et un Button. Vous ne pouvez pas faire cela en utilisant le FXML sans <fx:root> élément.