com.illucit.partyinvoice

Class FxmlHelper

java.lang.Object

com.illucit.partyinvoice.FxmlHelper

public class FxmlHelper
extends Object

Helper class for loading FXML documents.

Author:

Christian Simon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FxmlHelper.InnerDocumentHandler<C> Functional interface for to handle a loaded inner document.
static interface	FxmlHelper.StageHandler<C> Functional interface for to handle a loaded stage.

Constructor Summary

Constructors

Constructor and Description
FxmlHelper()

Method Summary

Modifier and Type	Method and Description
static <T> T	loadFxml(PartyInvoiceApp app, String view) Load view from FXML file.
static <C,T> T	loadFxml(PartyInvoiceApp app, String view, Class<C> controllerClass, FxmlHelper.InnerDocumentHandler<C> handler) Load view from FXML file with a handle for the controller.
static javafx.stage.Stage	loadFxmlStage(PartyInvoiceApp app, String view, String titleKey) Load Stage from FXML file.
static <C> javafx.stage.Stage	loadFxmlStage(PartyInvoiceApp app, String view, String titleKey, Class<C> controllerClass, FxmlHelper.StageHandler<C> handler) Load Stage from FXML file with a handler for the controller.

Methods inherited from class java.lang.Object

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

Constructor Detail

FxmlHelper

public FxmlHelper()

Method Detail

loadFxml

public static <T> T loadFxml(PartyInvoiceApp app,
                             String view)

Load view from FXML file. No handler for Stage and controller is given. If the controller is an AbstractController, the app is automatically assigned.

Type Parameters:

T - parent element class

Parameters:

app - the app

view - view location (relative to the view prefix VIEW_PREFIX in the same package of this class)

Returns:

parent of the FXML document

loadFxml

public static <C,T> T loadFxml(PartyInvoiceApp app,
                               String view,
                               Class<C> controllerClass,
                               FxmlHelper.InnerDocumentHandler<C> handler)

Load view from FXML file with a handle for the controller. If the controller is an AbstractController, the app is automatically assigned.

Type Parameters:

C - controller class

T - parent element class

Parameters:

app - the app

view - view location (relative to the view prefix VIEW_PREFIX in the same package of this class)

controllerClass - class the controller should have

handler - handler to be called when the FXML and the controller are loaded

Returns:

parent of the FXML document

loadFxmlStage

public static javafx.stage.Stage loadFxmlStage(PartyInvoiceApp app,
                                               String view,
                                               String titleKey)

Load Stage from FXML file. No handler for Stage and controller is given. If the controller is an AbstractController, the app is automatically assigned.

Parameters:

app - the app

view - view location (relative to the view prefix VIEW_PREFIX in the same package of this class)

titleKey - the message key to be used for the stage

Returns:

the created stage or null, if the loading of the FXML failed

loadFxmlStage

public static <C> javafx.stage.Stage loadFxmlStage(PartyInvoiceApp app,
                                                   String view,
                                                   String titleKey,
                                                   Class<C> controllerClass,
                                                   FxmlHelper.StageHandler<C> handler)

Load Stage from FXML file with a handler for the controller. If the controller is an AbstractController, the app is automatically assigned.

Type Parameters:

C - controller class

Parameters:

app - the app

view - view location (relative to the view prefix VIEW_PREFIX in the same package of this class)

titleKey - the message key to be used for the stage

controllerClass - class the controller should have

handler - handler to be called when the FXML and the controller are loaded

Returns:

the created stage or null, if the loading of the FXML failed