de.carne.jfx.stage

Class StageController

java.lang.Object

de.carne.jfx.fxml.FXMLController<javafx.stage.Stage>

de.carne.jfx.stage.StageController

Direct Known Subclasses:

LogViewController

public abstract class StageController
extends FXMLController<javafx.stage.Stage>

Controller class for Stage based scenes.

See Also:

FXMLController

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	StageController.BackgroundTask<V> Base class for Task run by this stage.

Constructor Summary

Constructors

Constructor and Description
StageController()

Method Summary

Modifier and Type	Method and Description
void	close(boolean sync) Close the controller's stage.
protected static java.util.concurrent.ScheduledExecutorService	getExecutorService() Get the ScheduledExecutorService shared by all stage controllers.
protected javafx.stage.Modality	getModality() This function is called during stage initialization to determine the stages's modality.
protected java.util.prefs.Preferences	getPreferences() Get the Preferences object associated with this stage.
protected boolean	getResizable() This function is called during stage initialization to determine whether the stage is resizable.
protected javafx.stage.StageStyle	getStyle() This function is called during stage initialization to determine the stages's style.
javafx.stage.Window	getWindow() Get the UI window.
boolean	isBlocked() Check whether this stage is currently blocked.
<R,C extends DialogController<R>> C	loadDialog(java.util.function.Function<C,javafx.scene.control.Dialog<R>> dialogFactory, java.lang.Class<C> controllerClass) Load and create new dialog.
static <C extends StageController> C	loadPrimaryStage(javafx.stage.Stage primaryStage, java.lang.Class<C> controllerClass) Load the JavaFX application's primary stage.
<C extends StageController> C	loadStage(java.lang.Class<C> controllerClass) Load and create new stage.
protected void	setBlocked(boolean blocked) This function is called to block/unblock this stage when either the first background task has been scheduled or the last background task has been finished.
protected void	setSystemMenuBar() This function is called on root stages to determine the system menu bar.
protected void	setupStage(javafx.stage.Stage stage) This function is called during stage initialization to perform the actual stage setup.
protected void	setupUI(javafx.stage.Window owner, javafx.stage.Stage stage, javafx.scene.Parent fxmlRoot) This function is called during UI initialization to perform the actual UI setup.
void	show() Show the controller's stage and return.
void	showAndWait() Show the controller's stage and wait until it is closed.
void	syncPreferences() Sync any Preferences object associated with this stage.

Methods inherited from class de.carne.jfx.fxml.FXMLController

getResources, getUI, loadUI

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

getExecutorService

protected static java.util.concurrent.ScheduledExecutorService getExecutorService()

Get the ScheduledExecutorService shared by all stage controllers.

Returns:

The ScheduledExecutorService to use for background processing.

loadPrimaryStage

public static <C extends StageController> C loadPrimaryStage(javafx.stage.Stage primaryStage,
                                                             java.lang.Class<C> controllerClass)
                                                      throws java.io.IOException

Load the JavaFX application's primary stage.

This function is used to load and setup the JavaFX application's primary stage as submitted to Application.start(Stage).

Type Parameters:

C - The actual StageController type.

Parameters:

primaryStage - The primary stage to setup.

controllerClass - The controller class to use.

Returns:

The constructed controller which is bound to the submitted primary stage.

Throws:

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

loadStage

public <C extends StageController> C loadStage(java.lang.Class<C> controllerClass)
                                        throws java.io.IOException

Load and create new stage.

The newly created stage is owned by the calling controller's stage.

Type Parameters:

C - The actual controller type.

Parameters:

controllerClass - The controller class to use.

Returns:

The constructed controller which is bound to the newly created stage.

Throws:

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

getWindow

public final javafx.stage.Window getWindow()

Description copied from class: FXMLController

Get the UI window.

Specified by:

getWindow in class FXMLController<javafx.stage.Stage>

Returns:

The UI window.

setupUI

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

Description copied from class: FXMLController

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

Specified by:

setupUI in class FXMLController<javafx.stage.Stage>

Parameters:

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

stage - The constructed UI object.

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

loadDialog

public <R,C extends DialogController<R>> C loadDialog(java.util.function.Function<C,javafx.scene.control.Dialog<R>> dialogFactory,
                                                      java.lang.Class<C> controllerClass)
                                               throws java.io.IOException

Load and create new dialog.

The newly created dialog is owned by the calling controller's stage.

Type Parameters:

R - The actual dialog result type.

C - The actual controller type.

Parameters:

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

controllerClass - The controller class to use.

Returns:

The constructed controller which is bound to the newly created dialog.

Throws:

java.io.IOException - if an I/O error occurs during dialog loading.

setSystemMenuBar

protected void setSystemMenuBar()

This function is called on root stages to determine the system menu bar.

This default implementation searches the stage scene's top level nodes for a MenuBar node and if found, makes it the system's menu bar.

See Also:

MenuBar.setUseSystemMenuBar(boolean)

getStyle

protected javafx.stage.StageStyle getStyle()

This function is called during stage initialization to determine the stages's style.

The default style is StageStyle.DECORATED.

Returns:

The stage style to use.

See Also:

StageStyle

getModality

protected javafx.stage.Modality getModality()

This function is called during stage initialization to determine the stages's modality.

The default modality is Modality.WINDOW_MODAL.

Returns:

The modality to use.

See Also:

Modality

getResizable

protected boolean getResizable()

This function is called during stage initialization to determine whether the stage is resizable.

The default is to make the stage resizable.

Returns:

true, if the stage is resizable.

setupStage

protected void setupStage(javafx.stage.Stage stage)

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

Parameters:

stage - The stage to setup.

setBlocked

protected void setBlocked(boolean blocked)

This function is called to block/unblock this stage when either the first background task has been scheduled or the last background task has been finished.

Parameters:

blocked - Whether the stage should blocked or unblocked.

See Also:

StageController.BackgroundTask

isBlocked

public boolean isBlocked()

Check whether this stage is currently blocked.

A stage is considered block when at least one unfinished background task exists.

Returns:

true if at least one unfinished background task exists.

See Also:

StageController.BackgroundTask

getPreferences

@Nullable
protected java.util.prefs.Preferences getPreferences()

Get the Preferences object associated with this stage.

Override this function to associate a Preferences object with this stage.

Returns:

The Preferences object associated with this stage or null if there is none.

show

public void show()

Show the controller's stage and return.

See Also:

Stage.show()

showAndWait

public void showAndWait()

Show the controller's stage and wait until it is closed.

See Also:

Stage.showAndWait()

close

public void close(boolean sync)

Close the controller's stage.

Parameters:

sync - Flag to control whether associated data (preferences) should synced.

See Also:

Stage.close(), syncPreferences()

syncPreferences

public void syncPreferences()

Sync any Preferences object associated with this stage.

Any error encountered during syncing will be logged and discarded.

See Also:

Preferences.sync()