de.carne.jfx.fxml

Class FXMLController<U>

java.lang.Object

de.carne.jfx.fxml.FXMLController<U>

Type Parameters:

U - The actual JavaFX UI type.

Direct Known Subclasses:

DialogController, StageController

public abstract class FXMLController<U>
extends java.lang.Object

This class is used for setting up and controlling FXML based scenes.

Controller classes must conform to the name pattern (.+)Controller and must be derived from one of this class' subclasses. In addition a FXML file has to be created for defining the scene content as well as a resource bundle for text resources. All these artifacts are bound together by their names as follows:

• MyStageController (controller class)
• MyStage.fxml (FXML resource defining the stage content)
• MyStageI18N*.properties (resource bundle)

Constructor Summary

Constructors

Constructor and Description
FXMLController()

Method Summary

Modifier and Type	Method and Description
protected java.util.ResourceBundle	getResources() Get the UI resource bundle.
U	getUI() Get the UI object.
abstract javafx.stage.Window	getWindow() Get the UI window.
protected static <U,C extends FXMLController<U>> C	loadUI(@Nullable javafx.stage.Window owner, java.util.function.Function<C,U> uiFactory, java.lang.Class<C> controllerClass) Perform the basic UI setup by loading the UI resource bundle, the scene content as well as the controller class and bind all together.
protected abstract void	setupUI(@Nullable javafx.stage.Window owner, U ui, javafx.scene.Parent fxmlRoot) This function is called during UI initialization to perform the actual UI setup.

Methods inherited from class java.lang.Object

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

Constructor Detail

FXMLController

public FXMLController()

Method Detail

getResources

protected final java.util.ResourceBundle getResources()

Get the UI resource bundle.

Returns:

The UI resource bundle.

getUI

public final U getUI()

Get the UI object.

Returns:

The UI object.

getWindow

public abstract javafx.stage.Window getWindow()

Get the UI window.

Returns:

The UI window.

loadUI

protected static <U,C extends FXMLController<U>> C loadUI(@Nullable javafx.stage.Window owner,
                                                          java.util.function.Function<C,U> uiFactory,
                                                          java.lang.Class<C> controllerClass)
                                                   throws java.io.IOException

Perform the basic UI setup by loading the UI resource bundle, the scene content as well as the controller class and bind all together.

Type Parameters:

U - The JavaFX UI object type.

C - The actual FXMLController type.

Parameters:

owner - The UI object's owner (may by null).

uiFactory - The factory function used to create the actual UI object by invoking it with the constructed controller.

controllerClass - The controller class to use.

Returns:

The constructed controller which is bound to the constructed scene and UI object.

Throws:

java.io.IOException - if an I/O error occurs during stage setup.

setupUI

protected abstract void setupUI(@Nullable javafx.stage.Window owner,
                                U ui,
                                javafx.scene.Parent fxmlRoot)

This function is called during UI initialization to perform the actual UI setup.

Parameters:

owner - The UI object's owner (may by null).

ui - The constructed UI object.

fxmlRoot - The scene's root node as defined by the FXML resource.