org.eclipse.fx.ui.di

Interface FXMLBuilder<N>

Type Parameters:

N - the root type loaded by the builder

All Known Implementing Classes:

InjectingFXMLLoader

public interface FXMLBuilder<N>

Builder for an FXMLLoader

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FXMLBuilder.Data<N,C> Data struct holing root node and controller

Method Summary

Modifier and Type	Method and Description
@NonNull FXMLBuilder<N>	builderFactory(@NonNull javafx.util.BuilderFactory builderFactory) Associate a builder factory with the loader
N	load() Load the FXML-Document
<C> FXMLBuilder.Data<N,C>	loadWithController() Load the FXML and return the root node and the controller
@NonNull FXMLBuilder<N>	resourceBundle(@NonNull java.util.ResourceBundle resourceBundle) Associate a resource bundle with the loader

Method Detail

resourceBundle

@NonNull FXMLBuilder<N> resourceBundle(@NonNull java.util.ResourceBundle resourceBundle)

Associate a resource bundle with the loader

Parameters:

resourceBundle - the resource bundle

Returns:

the builder instance

builderFactory

@NonNull FXMLBuilder<N> builderFactory(@NonNull javafx.util.BuilderFactory builderFactory)

Associate a builder factory with the loader

Parameters:

builderFactory - the builder factory

Returns:

the builder instance

load

N load()
throws java.io.IOException

Load the FXML-Document

Returns:

the root node

Throws:

java.io.IOException - if there is a problem loading the fxml

loadWithController

<C> FXMLBuilder.Data<N,C> loadWithController()
                                      throws java.io.IOException

Load the FXML and return the root node and the controller

Returns:

a structure holding root node and controller

Throws:

java.io.IOException - if there is a problem loading the fxml