Module org.testfx

Package org.testfx.toolkit

Interface ToolkitService

All Known Implementing Classes:

ToolkitServiceImpl

public interface ToolkitService

Interface that handles setting up an Application, Stage, Scene, or rootNode and application cleanup on the JavaFX Application Thread.

Method Summary

Modifier and Type	Method	Description
Future<Void>	cleanupApplication(Application application)	Calls ApplicationService.stop(Application) on the given application.
Future<Application>	setupApplication(Supplier<Stage> stageSupplier, Class<? extends Application> applicationClass, String... applicationArgs)	Creates, initializes, and starts the given applicationClass and returns a Future whose Future.get() returns the created application.
Future<Application>	setupApplication(Supplier<Stage> stageSupplier, Supplier<Application> applicationSupplier, String... applicationArgs)	Creates, initializes, and starts the supplied application and returns a Future whose Future.get() returns the created application.
Future<Void>	setupFixture(Runnable runnable)	Runs the given runnable on the JavaFX Application Thread.
<T> Future<T>	setupFixture(Callable<T> callable)	Runs the given callable on the JavaFX Application Thread.
Future<Stage>	setupPrimaryStage(CompletableFuture<Stage> primaryStageFuture, Class<? extends Application> applicationClass, String... applicationArgs)	If the given CompletableFuture.isDone(), returns that future; otherwise, launches the given application with its arguments.
Future<Scene>	setupScene(Stage stage, Supplier<? extends Scene> sceneSupplier)	Sets the given scene as the given stage's scene on the JavaFX Application Thread and returns a Future whose Future.get() returns the given scene.
Future<Parent>	setupSceneRoot(Stage stage, Supplier<? extends Parent> sceneRootSupplier)	Wraps the parent in a scene, sets that scene as the given stage's scene on the JavaFX Application Thread, and returns a Future whose Future.get() returns the given parent.
Future<Stage>	setupStage(Stage stage, Consumer<Stage> stageConsumer)	Calls the stageConsumer with the given stage on the JavaFX Application Thread and returns a Future whose Future.get() returns that stage.

Method Detail

setupPrimaryStage

Future<Stage> setupPrimaryStage(CompletableFuture<Stage> primaryStageFuture,
                                Class<? extends Application> applicationClass,
                                String... applicationArgs)

If the given CompletableFuture.isDone(), returns that future; otherwise, launches the given application with its arguments.

setupFixture

Future<Void> setupFixture(Runnable runnable)

Runs the given runnable on the JavaFX Application Thread.

setupFixture

<T> Future<T> setupFixture(Callable<T> callable)

Runs the given callable on the JavaFX Application Thread.

setupStage

Future<Stage> setupStage(Stage stage,
                         Consumer<Stage> stageConsumer)

Calls the stageConsumer with the given stage on the JavaFX Application Thread and returns a Future whose Future.get() returns that stage.

setupScene

Future<Scene> setupScene(Stage stage,
                         Supplier<? extends Scene> sceneSupplier)

Sets the given scene as the given stage's scene on the JavaFX Application Thread and returns a Future whose Future.get() returns the given scene.

setupSceneRoot

Future<Parent> setupSceneRoot(Stage stage,
                              Supplier<? extends Parent> sceneRootSupplier)

Wraps the parent in a scene, sets that scene as the given stage's scene on the JavaFX Application Thread, and returns a Future whose Future.get() returns the given parent.

setupApplication

Future<Application> setupApplication(Supplier<Stage> stageSupplier,
                                     Class<? extends Application> applicationClass,
                                     String... applicationArgs)

Creates, initializes, and starts the given applicationClass and returns a Future whose Future.get() returns the created application.

setupApplication

Future<Application> setupApplication(Supplier<Stage> stageSupplier,
                                     Supplier<Application> applicationSupplier,
                                     String... applicationArgs)

Creates, initializes, and starts the supplied application and returns a Future whose Future.get() returns the created application.

cleanupApplication

Future<Void> cleanupApplication(Application application)

Calls ApplicationService.stop(Application) on the given application.