de.carne.jfx

Class StageController

java.lang.Object

de.carne.jfx.StageController

Direct Known Subclasses:

AboutInfoController, LogViewController, MessageBoxController

public abstract class StageController
extends java.lang.Object

Abstract base class for controlling JFX stages (including scene setup).

Constructor Summary

Constructors

Constructor and Description
StageController()

Method Summary

Modifier and Type	Method and Description
protected boolean	canClose() Called every time the stage receives a close request to check whether the stage can be closed or not.
protected java.util.ResourceBundle	getBundle() Get the controller's resource bundle.
protected java.util.concurrent.ScheduledExecutorService	getExecutorService() Get the ScheduledExecutorService to use for background processing.
protected javafx.stage.Modality	getModality() Called during stage setup to get the stage's modality.
protected java.util.prefs.Preferences	getPreferences() Get the controller's optional preferences object.
protected boolean	getResizable() Called during stage setup to get the stage's resizable flag.
javafx.stage.Stage	getStage() Get the controller's stage.
protected javafx.stage.StageStyle	getStyle() Called during stage setup to get the stage's style.
protected javafx.scene.control.MenuBar	getSystemMenuBar() Get the controller's optional system menu bar.
<T extends StageController> T	openRootStage(java.lang.Class<T> controllerClass) Create a new root stage and set it up with the JFX scene of the submitted controller class.
<T extends StageController> T	openStage(java.lang.Class<T> controllerClass) Create a new stage owned by this controller's stage and set it up with the JFX scene of the submitted controller class.
void	reportUnexpectedException(java.lang.Throwable unexpected) Report an unexpected exception to the user.
static <T extends StageController> T	setupPrimaryStage(javafx.stage.Stage controllerStage, java.lang.Class<T> controllerClass) Setup a an existing stage with the JFX scene of the submitted controller class.
protected void	setupStage(javafx.stage.Stage controllerStage) Called during stage setup to perform the actual controller specific setup steps.
MessageBoxResult	showMessageBox(java.lang.String message, java.lang.Throwable details, MessageBoxStyle... styles) Show a message box.
protected void	syncPreferences() Synchronize the controller's preferences.

Methods inherited from class java.lang.Object

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

Constructor Detail

StageController

public StageController()

Method Detail

getBundle

protected java.util.ResourceBundle getBundle()

Get the controller's resource bundle.

Returns:

The controller's resource bundle.

getExecutorService

protected java.util.concurrent.ScheduledExecutorService getExecutorService()

Get the ScheduledExecutorService to use for background processing.

Returns:

The ScheduledExecutorService to use for background processing.

getSystemMenuBar

protected javafx.scene.control.MenuBar getSystemMenuBar()

Get the controller's optional system menu bar.

Override this function to define the application's system menu bar MenuBar.setUseSystemMenuBar(boolean)).

Returns:

The controller's system menu bar or null if the controller doesn't have one.

getPreferences

protected java.util.prefs.Preferences getPreferences()

Get the controller's optional preferences object.

Returns:

The controller's preferences object or null if the controller doesn't have one.

syncPreferences

protected void syncPreferences()

Synchronize the controller's preferences.

getStyle

protected javafx.stage.StageStyle getStyle()

Called during stage setup to get the stage's style.

Derived classes can override this to change it's style.

Returns:

The style to use for stage setup.

getModality

protected javafx.stage.Modality getModality()

Called during stage setup to get the stage's modality.

Derived classes can override this to change it's modality.

Returns:

The modality to use for stage setup.

getResizable

protected boolean getResizable()

Called during stage setup to get the stage's resizable flag.

Derived classes can override this to change it's resizable behavior.

Returns:

The resizable flag to use for stage setup.

canClose

protected boolean canClose()

Called every time the stage receives a close request to check whether the stage can be closed or not.

Returns:

true if the stage can be closed. Returning false rejects the close request.

setupStage

protected void setupStage(javafx.stage.Stage controllerStage)
                   throws java.io.IOException

Called during stage setup to perform the actual controller specific setup steps.

Derived classes overriding this function have to make sure to invoke the super's version prior to performing their setup steps.

Parameters:

controllerStage - The stage to setup.

Throws:

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

See Also:

setupPrimaryStage(Stage, Class)

setupPrimaryStage

public static <T extends StageController> T setupPrimaryStage(javafx.stage.Stage controllerStage,
                                                              java.lang.Class<T> controllerClass)
                                                       throws java.io.IOException

Setup a an existing stage with the JFX scene of the submitted controller class.

Type Parameters:

T - The controller class.

Parameters:

controllerStage - The primary stage to setup.

controllerClass - The controller class to derive the FXML resource from.

Returns:

The loaded Scene's controller instance.

Throws:

java.io.IOException - if an I/O error occurs while loading the FXML resource.

openRootStage

public <T extends StageController> T openRootStage(java.lang.Class<T> controllerClass)
                                            throws java.io.IOException

Create a new root stage and set it up with the JFX scene of the submitted controller class.

Type Parameters:

T - The controller class.

Parameters:

controllerClass - The controller class to derive the FXML resource from.

Returns:

The loaded Scene's controller instance.

Throws:

java.io.IOException - if an I/O error occurs while loading the FXML resource.

openStage

public <T extends StageController> T openStage(java.lang.Class<T> controllerClass)
                                        throws java.io.IOException

Create a new stage owned by this controller's stage and set it up with the JFX scene of the submitted controller class.

Type Parameters:

T - The controller class.

Parameters:

controllerClass - The controller class to derive the FXML resource from.

Returns:

The loaded Scene's controller instance.

Throws:

java.io.IOException - if an I/O error occurs while loading the FXML resource.

getStage

public javafx.stage.Stage getStage()

Get the controller's stage.

Returns:

The controller's stage.

showMessageBox

public MessageBoxResult showMessageBox(java.lang.String message,
                                       java.lang.Throwable details,
                                       MessageBoxStyle... styles)

Show a message box.

Parameters:

message - The message to display.

details - The (optional) exception causing the message.

styles - The message box style.

Returns:

The message box result.

reportUnexpectedException

public void reportUnexpectedException(java.lang.Throwable unexpected)

Report an unexpected exception to the user.

Parameters:

unexpected - The exception to report.