org.tentackle.fx.rdc.app

Class DesktopApplication<C extends FxController>

java.lang.Object

org.tentackle.app.AbstractApplication

org.tentackle.fx.rdc.app.DesktopApplication<C>

Type Parameters:

C - the main controller type

All Implemented Interfaces:

DomainContextProvider, org.tentackle.session.SessionProvider

public abstract class DesktopApplication<C extends FxController>
extends AbstractApplication

Java FX tentackle desktop application.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
DesktopApplication(String name) Creates an FX desktop application.

Method Summary

Modifier and Type	Method and Description
void	configureMainStage(javafx.stage.Stage mainStage) Configures and sets the main stage.
protected void	configureModificationTracker()
protected void	configurePreferences() Installs the preferences backend. The option "systemprefs" forces usage of system preferences only.
protected void	configureSecurityManager()
DomainContext	createDomainContext(org.tentackle.session.Session session)
LoginFailedHandler	createLoginFailedHandler(javafx.scene.Parent view, org.tentackle.session.SessionInfo sessionInfo) Creates the login failed handler.
protected void	doFinishStartup() Finishes the startup. Invoked after all has been displayed.
void	doLogin(javafx.scene.Parent view, org.tentackle.session.SessionInfo sessionInfo) Performs the login and final startup of the application.
protected void	doStop(int exitValue) Terminates the application gracefully.
protected void	doStop(int exitValue, Exception ex) Terminates the application gracefully.
Class<? extends FxApplication>	getApplicationClass() Gets the FX application class.
org.tentackle.misc.CommandLine	getCommandLine() Gets the command line.
static DesktopApplication<?>	getDesktopApplication() Gets the running desktop application.
FxApplication	getFxApplication() Gets the FX application instance. This is the instance of the class provided by getApplicationClass(). The FX-application ususally provides a login-view and is responsible to spawn the main view after successful login.
C	getMainController() Gets the main controller.
abstract Class<? extends C>	getMainControllerClass() Gets the main-controller to be displayed initially. Maintains the main-scene of the application.
javafx.stage.Stage	getMainStage() Gets the main stage.
Thread.UncaughtExceptionHandler	getUncaughtExceptionHandler() Gets the exception handler.
boolean	isServer()
void	registerUncaughtExceptionHandler() Registers a handler for uncaught exceptions.
void	setFxApplication(FxApplication fxApplication) Sets the FX application instance.
void	setMainController(C mainController) Sets the main controller instance.
void	showApplicationStatus(String msg, double progress) Displays a message during login.
void	start(String[] args) Launches the application.
void	stop() Gracefully terminates the application.

Methods inherited from class org.tentackle.app.AbstractApplication

createSession, createSessionInfo, deregisterJdbcDrivers, detectContainer, detectJNLP, doConfigureApplication, doInitialize, getCreationTime, getDomainContext, getName, getProperties, getProperty, getRunningApplication, getSession, getSessionInfo, getUser, getUser, isDeployedByJNLP, isRunningInContainer, logStackdump, register, setDomainContext, setName, setProperties, setSessionInfo, toString, unregister, updateSessionInfoAfterLogin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.pdo.DomainContextProvider

on, op

Constructor Detail

DesktopApplication

public DesktopApplication(String name)

Creates an FX desktop application.

Parameters:

name - the application name

Method Detail

getDesktopApplication

public static DesktopApplication<?> getDesktopApplication()

Gets the running desktop application.

Returns:

the application

getMainControllerClass

public abstract Class<? extends C> getMainControllerClass()

Gets the main-controller to be displayed initially.
Maintains the main-scene of the application.

Returns:

the main controller class

configureMainStage

public void configureMainStage(javafx.stage.Stage mainStage)

Configures and sets the main stage.

If overridden, make sure to invoke super.configureMainStage!

Parameters:

mainStage - the main stage

getMainStage

public javafx.stage.Stage getMainStage()

Gets the main stage.

Returns:

the stage

setMainController

public void setMainController(C mainController)

Sets the main controller instance.

Parameters:

mainController - the main controller

getMainController

public C getMainController()

Gets the main controller.

Returns:

the main controller

createLoginFailedHandler

public LoginFailedHandler createLoginFailedHandler(javafx.scene.Parent view,
                                                   org.tentackle.session.SessionInfo sessionInfo)

Creates the login failed handler.

Parameters:

view - the view

sessionInfo - the session info

Returns:

the handler

doLogin

public void doLogin(javafx.scene.Parent view,
                    org.tentackle.session.SessionInfo sessionInfo)

Performs the login and final startup of the application.

The method must hide the view when the main application windows is displayed after successful login.

Notice that this method is invoked from within the FX thread.

Parameters:

view - the view to hide if login succeeded and application window visible

sessionInfo - the session info

getFxApplication

public FxApplication getFxApplication()

Gets the FX application instance.
This is the instance of the class provided by getApplicationClass().
The FX-application ususally provides a login-view and is responsible to spawn the main view after successful login.

Returns:

the FX application

setFxApplication

public void setFxApplication(FxApplication fxApplication)

Sets the FX application instance.

Parameters:

fxApplication - the FX application

getApplicationClass

public Class<? extends FxApplication> getApplicationClass()

Gets the FX application class.

Returns:

the fx application class

showApplicationStatus

public void showApplicationStatus(String msg,
                                  double progress)

Displays a message during login.

Parameters:

msg - the status message

progress - the progress, 0 to disable, negative if infinite, 1.0 if done

registerUncaughtExceptionHandler

public void registerUncaughtExceptionHandler()

Registers a handler for uncaught exceptions.

getUncaughtExceptionHandler

public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

Gets the exception handler.

Returns:

the handler

isServer

public boolean isServer()

Specified by:

isServer in class AbstractApplication

createDomainContext

public DomainContext createDomainContext(org.tentackle.session.Session session)

Overridden to create a DomainContext with a thread-local session.

In deskop client apps there are 2 threads using their own session:

1. the FX thread
2. the ModificationTracker thread

By using the thread-local session, PDOs can be used from both threads without having to worry about the correct session.

Overrides:

createDomainContext in class AbstractApplication

Returns:

the domain context

start

public void start(String[] args)

Launches the application.

Parameters:

args - the arguments (usually from commandline)

stop

public void stop()

Gracefully terminates the application. Usually invoked from an exit-Button or when window is closed.

getCommandLine

public org.tentackle.misc.CommandLine getCommandLine()

Gets the command line.

Returns:

the command line

configurePreferences

protected void configurePreferences()

Installs the preferences backend.
The option "systemprefs" forces usage of system preferences only.

Overrides:

configurePreferences in class AbstractApplication

configureSecurityManager

protected void configureSecurityManager()

Overrides:

configureSecurityManager in class AbstractApplication

configureModificationTracker

protected void configureModificationTracker()

Overrides:

configureModificationTracker in class AbstractApplication

doFinishStartup

protected void doFinishStartup()
                        throws org.tentackle.misc.ApplicationException

Finishes the startup.
Invoked after all has been displayed. The default implementation starts the modification thread, unless "--nomodthread" given.

Overrides:

doFinishStartup in class AbstractApplication

Throws:

org.tentackle.misc.ApplicationException - if failed

doStop

protected void doStop(int exitValue,
                      Exception ex)

Terminates the application gracefully. (this is the only do.. method that does not throw AbstractApplicationException)

Parameters:

exitValue - the doStop value for System.exit()

ex - an exception causing the termination, null if none

doStop

protected void doStop(int exitValue)

Terminates the application gracefully.

Parameters:

exitValue - the doStop value for System.exit()