org.jrebirth.af.core.application

Class AbstractApplication<P extends Pane>

java.lang.Object

javafx.application.Application

org.jrebirth.af.core.application.AbstractApplication<P>

Type Parameters:

P - The root node of the stage, must extends Pane to allow children management

All Implemented Interfaces:

ApplicationMessages, JRebirthApplication<P>, MessageContainer

Direct Known Subclasses:

DefaultApplication

@Configuration(value=".*jrebirth")
@Localized(value=".*_rb")
public abstract class AbstractApplication<P extends Pane>
extends Application
implements JRebirthApplication<P>, ApplicationMessages

The abstract class AbstractApplication is the base class of a JRebirth Application. This the class to extend if you want to build an application using JRebirth WCS-MVC (Wave-Command-Service-Model-View-Controller).

Author:

Sébastien Bordes

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

Application.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
private static String	APP_SUFFIX_CLASSNAME The default suffix for Application main class.
private static JRLogger	LOGGER The class logger.
private static String	PARAM Default parameter replacement string.
private P	rootNode The root node of the scene built by reflection.
private Scene	scene The application scene.
private Stage	stage The application primary stage.

Fields inherited from interface org.jrebirth.af.core.application.ApplicationMessages

ATTACH_JAT_UEH, ATTACH_JIT_UEH, CSS_LOADING_ERROR, INIT_ERROR, NO_CSS_DEFINED, OVERRIDE_FIRST_MODEL_CLASS, START_APPLICATION, START_ERROR, STARTED_SUCCESSFULLY, STOP_APPLICATION, STOP_ERROR, STOPPED_SUCCESSFULLY

Constructor Summary

Constructors

Constructor and Description
AbstractApplication()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCSS(Scene scene, StyleSheetItem styleSheetItem) Attach a new CSS file to the scene using the default classloader.
protected P	buildRootPane() Build dynamically the root pane.
protected Scene	buildScene() Initialize the properties of the scene. 800x600 with transparent background and a Region as Parent Node
protected abstract void	customizeScene(Scene scene) Customize the default scene.
protected abstract void	customizeStage(Stage stage) Customize the primary stage.
protected String	getApplicationTitle() Return the application title.
protected Thread.UncaughtExceptionHandler	getDefaultUncaughtExceptionHandler() Build and return the Default Uncaught Exception Handler for All threads which don't have any handler.
protected abstract List<FontItem>	getFontToPreload() Return the list of FontEnum to load for CSS.
protected KeyCode	getFullScreenKeyCode() Return the #KeyCode used to put the application in full screen mode.
protected KeyCode	getIconifiedKeyCode() Return the #KeyCode used to iconify the application.
protected Thread.UncaughtExceptionHandler	getJatUncaughtExceptionHandler() Build and return the Uncaught Exception Handler for JavaFX Application Thread.
protected Thread.UncaughtExceptionHandler	getJitUncaughtExceptionHandler() Build and return the Uncaught Exception Handler for JRebirth Internal Thread.
Thread.UncaughtExceptionHandler	getPoolUncaughtExceptionHandler() Build and return the Uncaught Exception Handler for JRebirth Thread Pool.
P	getRootNode() Return the root node of the main scene of this application.
Scene	getScene() Return the scene of the main stage of this application.
private String	getShortClassName() Return the application class name without the Application suffix.
Stage	getStage() Return the main stage of this application.
void	init()
protected void	initializeExceptionHandler() Initialize all Uncaught Exception Handler.
private void	initializeScene() Initialize the default scene.
private void	initializeStage() Customize the primary Stage.
protected static void	launchNow(Class<? extends Application> appClass, String... args) Launch the Given JavaFX Application (without any preloader).
protected static void	launchNow(String... args) Launch the Current JavaFX Application (without any preloader).
private void	loadConfigurationFiles() Load all configuration files before showing anything.
private void	loadMessagesFiles() Load all Messages files before showing anything.
private void	manageDefaultStyleSheet(Scene scene) Attach default CSS file if none have been previously attached.
protected abstract void	postInit() Perform custom task after application initialization phase and before starting phase.
protected abstract void	preInit() Perform custom task before application initialization phase.
protected static void	preloadAndLaunch(Class<? extends Application> appClass, Class<? extends Preloader> preloaderClass, String... args) Launch the given JavaFX Application with given preloader.
protected static void	preloadAndLaunch(Class<? extends Preloader> preloaderClass, String... args) Launch the Current JavaFX Application with given preloader.
protected static void	preloadAndLaunch(String... args) Launch the Current JavaFX Application with Default JRebirth preloader.
void	preloadFonts() Preload JRebirth wrapped fonts to allow them to be used directly by CSS.
void	start(Stage primaryStage)
void	stop()

Methods inherited from class javafx.application.Application

getHostServices, getParameters, launch, launch, notifyPreloader

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.core.application.JRebirthApplication

getFirstModelClass, getPostBootWaveList, getPreBootWaveList

Field Detail

PARAM

private static final String PARAM

Default parameter replacement string.

See Also:

Constant Field Values

APP_SUFFIX_CLASSNAME

private static final String APP_SUFFIX_CLASSNAME

The default suffix for Application main class.

See Also:

Constant Field Values

LOGGER

private static final JRLogger LOGGER

The class logger.

stage

private transient Stage stage

The application primary stage.

scene

private transient Scene scene

The application scene.

rootNode

private transient P extends Pane rootNode

The root node of the scene built by reflection.

Constructor Detail

AbstractApplication

public AbstractApplication()

Method Detail

preloadAndLaunch

protected static void preloadAndLaunch(String... args)

Launch the Current JavaFX Application with Default JRebirth preloader.

Parameters:

args - arguments passed to java command line

preloadAndLaunch

protected static void preloadAndLaunch(Class<? extends Preloader> preloaderClass,
                    String... args)

Launch the Current JavaFX Application with given preloader.

Parameters:

preloaderClass - the preloader class used as splash screen with progress

args - arguments passed to java command line

preloadAndLaunch

protected static void preloadAndLaunch(Class<? extends Application> appClass,
                    Class<? extends Preloader> preloaderClass,
                    String... args)

Launch the given JavaFX Application with given preloader.

Parameters:

appClass - the JavaFX application class to launch

preloaderClass - the preloader class used as splash screen with progress

args - arguments passed to java command line

launchNow

protected static void launchNow(String... args)

Launch the Current JavaFX Application (without any preloader).

Parameters:

args - arguments passed to java command line

launchNow

protected static void launchNow(Class<? extends Application> appClass,
             String... args)

Launch the Given JavaFX Application (without any preloader).

Parameters:

appClass - the JavaFX application class to launch

args - arguments passed to java command line

init

public final void init()
                throws CoreException

Overrides:

init in class Application

Throws:

CoreException

preInit

protected abstract void preInit()

Perform custom task before application initialization phase.

postInit

protected abstract void postInit()

Perform custom task after application initialization phase and before starting phase.

start

public final void start(Stage primaryStage)
                 throws CoreException

Specified by:

start in class Application

Throws:

CoreException

loadConfigurationFiles

private void loadConfigurationFiles()

Load all configuration files before showing anything.

loadMessagesFiles

private void loadMessagesFiles()

Load all Messages files before showing anything.

stop

public final void stop()
                throws CoreException

Overrides:

stop in class Application

Throws:

CoreException

initializeStage

private void initializeStage()

Customize the primary Stage.

customizeStage

protected abstract void customizeStage(Stage stage)

Customize the primary stage.

Parameters:

stage - the primary stage to customize

initializeScene

private void initializeScene()

Initialize the default scene.

preloadFonts

public void preloadFonts()

Preload JRebirth wrapped fonts to allow them to be used directly by CSS.

Specified by:

preloadFonts in interface JRebirthApplication<P extends Pane>

getFontToPreload

protected abstract List<FontItem> getFontToPreload()

Return the list of FontEnum to load for CSS.

Returns:

the list of fontEnum to load

customizeScene

protected abstract void customizeScene(Scene scene)

Customize the default scene.

Parameters:

scene - the scene to customize

addCSS

protected void addCSS(Scene scene,
          StyleSheetItem styleSheetItem)

Attach a new CSS file to the scene using the default classloader.

Parameters:

scene - the scene that will hold this new CSS file

styleSheetItem - the stylesheet item to add

getApplicationTitle

protected String getApplicationTitle()

Return the application title. This method could be overridden. By default it will will return JRebirthParameters.APPLICATION_NAME JRebirthParameters.APPLICATION_VERSION string. The default application is: ApplicationClass powered by JRebirth
If version is equals to "0.0.0", it will not be appended

Returns:

the application title

getShortClassName

private String getShortClassName()

Return the application class name without the Application suffix.

Returns:

the application class short name

manageDefaultStyleSheet

private void manageDefaultStyleSheet(Scene scene)

Attach default CSS file if none have been previously attached.

Parameters:

scene - the scene to check

buildScene

protected final Scene buildScene()
                          throws CoreException

Initialize the properties of the scene. 800x600 with transparent background and a Region as Parent Node

Returns:

the scene built

Throws:

CoreException - if build fails

buildRootPane

protected P buildRootPane()
                                throws CoreException

Build dynamically the root pane.

Returns:

the root pane

Throws:

CoreException - if build fails

initializeExceptionHandler

protected void initializeExceptionHandler()

Initialize all Uncaught Exception Handler.

getStage

public Stage getStage()

Return the main stage of this application.

Specified by:

getStage in interface JRebirthApplication<P extends Pane>

Returns:

Returns the stage.

getScene

public final Scene getScene()

Return the scene of the main stage of this application.

Specified by:

getScene in interface JRebirthApplication<P extends Pane>

Returns:

Returns the scene.

getRootNode

public P getRootNode()

Return the root node of the main scene of this application.

Specified by:

getRootNode in interface JRebirthApplication<P extends Pane>

Returns:

Returns the rootNode.

getFullScreenKeyCode

protected KeyCode getFullScreenKeyCode()

Return the #KeyCode used to put the application in full screen mode.
Can be overridden
Default is F11

Returns:

the full screen shortcut

getIconifiedKeyCode

protected KeyCode getIconifiedKeyCode()

Return the #KeyCode used to iconify the application.
Can be overridden
Default is F10

Returns:

the iconify shortcut

getDefaultUncaughtExceptionHandler

protected Thread.UncaughtExceptionHandler getDefaultUncaughtExceptionHandler()

Build and return the Default Uncaught Exception Handler for All threads which don't have any handler.

Returns:

the uncaught exception handler for All threads which don't have any handler.

getJatUncaughtExceptionHandler

protected Thread.UncaughtExceptionHandler getJatUncaughtExceptionHandler()

Build and return the Uncaught Exception Handler for JavaFX Application Thread.

Returns:

the uncaught exception handler for JavaFX Application Thread

getJitUncaughtExceptionHandler

protected Thread.UncaughtExceptionHandler getJitUncaughtExceptionHandler()

Build and return the Uncaught Exception Handler for JRebirth Internal Thread.

Returns:

the uncaught exception handler for JRebirth Internal Thread

getPoolUncaughtExceptionHandler

public Thread.UncaughtExceptionHandler getPoolUncaughtExceptionHandler()

Build and return the Uncaught Exception Handler for JRebirth Thread Pool.

Returns:

the uncaught exception handler for JRebirth Thread Pool