moe.tristan.easyfxml.spring.application

Class FxUiManager

java.lang.Object

moe.tristan.easyfxml.spring.application.FxUiManager

public abstract class FxUiManager
extends Object

The FxUiManager is one take on a bootstrapping class for the JavaFX UI.

The goal being both to decouple the GUI code from the main class and also to offer a somewhat declarative entry point for the JavaFX side of your project.

Every method's overriding possibilities is detailed on it.

The minimal overriding is that of :

- title() for the main stage's title.

- mainComponent() for the main scene info as a FxmlNode.

- getStylesheet() that is optionally overriden if you use a custom stylesheet. If you don't need one, ignore it.

Field Summary

Fields

Modifier and Type	Field and Description
protected EasyFxml	easyFxml

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FxUiManager(EasyFxml easyFxml) You are expected to call super() with an EasyFxml instance received from Spring.

Method Summary

Modifier and Type	Method and Description
protected javafx.scene.Scene	getScene(FxmlNode node) Simple utility class to load an FxmlNode as a Scene for use with mainComponent()
protected Optional<FxmlStylesheet>	getStylesheet()
protected abstract FxmlNode	mainComponent()
protected void	onSceneCreated(javafx.scene.Scene mainScene) Called right after the main Scene was created if you want to edit it.
protected void	onStageCreated(javafx.stage.Stage mainStage) Called as we enter the startGui(Stage) method.
void	startGui(javafx.stage.Stage mainStage) Called by FxSpringApplication after Spring and JavaFX are started.
protected abstract String	title()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

easyFxml

protected final EasyFxml easyFxml

Constructor Detail

FxUiManager

protected FxUiManager(EasyFxml easyFxml)

You are expected to call super() with an EasyFxml instance received from Spring.

i.e.:

 \@Component
 public class MyUiManager extends FxUiManager {
      \@Autowired
      public MyUiManager(EasyFxml easyFxml) {
          super(easyFxml);
      }
      ...
 }
 

Parameters:

easyFxml - received from Spring DI

Method Detail

startGui

public void startGui(javafx.stage.Stage mainStage)

Called by FxSpringApplication after Spring and JavaFX are started. This is the equivalent of Application.start(Stage) in traditional JavaFX apps.

Parameters:

mainStage - The main stage of the application feeded by JavaFX

title

protected abstract String title()

Returns:

The title to give the main stage

mainComponent

protected abstract FxmlNode mainComponent()

Returns:

The component to load in the main stage upon startup

onSceneCreated

protected void onSceneCreated(javafx.scene.Scene mainScene)

Called right after the main Scene was created if you want to edit it.

Parameters:

mainScene - The main scene of the application

onStageCreated

protected void onStageCreated(javafx.stage.Stage mainStage)

Called as we enter the startGui(Stage) method.

Parameters:

mainStage - The main stage, supplied by JavaFX's Application.start(Stage) method.

getStylesheet

protected Optional<FxmlStylesheet> getStylesheet()

Returns:

If overriden, this function returns the FxmlStylesheet to apply to the main window.

getScene

protected javafx.scene.Scene getScene(FxmlNode node)

Simple utility class to load an FxmlNode as a Scene for use with mainComponent()

Parameters:

node - the node to load in the Scene

Returns:

The ready-to-use Scene

Throws:

RuntimeException - if the scene could not be loaded properly