org.tentackle.swing.rdc.app

Class DesktopApplication

java.lang.Object

org.tentackle.app.AbstractApplication

org.tentackle.swing.rdc.app.DesktopApplication

All Implemented Interfaces:

DomainContextProvider, org.tentackle.session.SessionProvider

public abstract class DesktopApplication
extends AbstractApplication

Abstract class to handle the application's lifecycle. Tentackle applications should extend this class and invoke start(java.lang.String[]). To shutdown gracefully, application should invokd stop(). At minimum, the method doCreateWindow() must be implemented.

The subclass just needs to provide a main-method, for example:

 public static void main(String args[]) {
   new MyAbstractApplication().start(args);
 }
 

Author:

harald

Constructor Summary

Constructors

Constructor and Description
DesktopApplication(String name, Icon logo) Creates a swing desktop application.

Method Summary

Modifier and Type	Method and Description
void	changeLookAndFeel(String name) Changes the look and feel.
protected void	configureModificationTracker()
protected void	configurePreferences() Installs the preferences backend. The option "systemprefs" forces usage of system preferences only.
DomainContext	createDomainContext(org.tentackle.session.Session session)
LoginDialog	createLoginDialog(org.tentackle.session.SessionInfo sessionInfo, Icon logo) Creates the login dialog.
JMenu	createLookAndFeelMenu() Creates a menu to select the look and feel.
protected void	doConfigureApplication() Do anything what's necessary after the connection has been established.
protected abstract FormWindow	doCreateWindow() Creates the top level window. The method must not setVisible(true) and is executed from within the EventQueue.
protected void	doFinishStartup() Finishes the startup. Invoked after all has been displayed.
protected void	doInitializeGUI() Initializes the GUI. The default implementation initializes the Tentackle-EventQueue.
protected DomainContext	doLogin() Connects to the database backend (or application server).
protected void	doShowWindow() Shows the window.
protected void	doStop(int exitValue) Terminates the application gracefully.
protected void	doStop(int exitValue, Exception ex) Terminates the application gracefully.
org.tentackle.misc.CommandLine	getCommandLine() Gets the command line.
static DesktopApplication	getDesktopApplication() Gets the running desktop application.
Icon	getLogo() Gets the logo.
FormWindow	getWindow() Gets the application's window.
protected void	installLookAndFeels() Installs the available look and feels.
boolean	isServer()
void	setLookAndFeel(String name) Sets the look and feel.
<T extends PersistentDomainObject<T>> void	showEditDialog(Class<T> clazz) Brings up a non-modal edit dialog for a given class.
<T extends PersistentDomainObject<T>> T	showEditDialog(Component comp, Class<T> clazz, boolean modal) Brings up an edit dialog for a given class.
<T extends PersistentDomainObject<T>> T	showEditDialog(Component comp, T object, boolean modal) Brings up an edit dialog for a given object.
void	showLoginStatus(String msg) Displays a message during login.
<T extends PersistentDomainObject<T>> void	showSearchDialog(Class<T> clazz) Brings up a search dialog for a given class.
<T extends PersistentDomainObject<T>> void	showSearchDialog(FormWindow w, Class<T> clazz) Brings up a search dialog for a given class.
void	start(String[] args) Launches the application.
void	stop() Gracefully terminates the application.

Methods inherited from class org.tentackle.app.AbstractApplication

applyProperties, configureSecurityManager, createSession, createSessionInfo, deregisterJdbcDrivers, detectContainer, detectJNLP, 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,
                          Icon logo)

Creates a swing desktop application.

Parameters:

name - the application's name

logo - the application's logo icon

Method Detail

getDesktopApplication

public static DesktopApplication getDesktopApplication()

Gets the running desktop application.

Returns:

the application

isServer

public boolean isServer()

Specified by:

isServer in class AbstractApplication

configureModificationTracker

protected void configureModificationTracker()

Overrides:

configureModificationTracker 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 AWT 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

getLogo

public Icon getLogo()

Gets the logo.

Returns:

the logo

getWindow

public FormWindow getWindow()

Gets the application's window.

Returns:

the window, null if not yet defined.

setLookAndFeel

public void setLookAndFeel(String name)

Sets the look and feel.

Parameters:

name - the name of the look and feel

changeLookAndFeel

public void changeLookAndFeel(String name)

Changes the look and feel. This method should be invoked if the user changed the look and feel intentionally. The default implementation just invokes setLookAndFeel, but applications can override it to save the setting, e.g. in the preferences.

Parameters:

name - the name of the l&f

createLookAndFeelMenu

public JMenu createLookAndFeelMenu()

Creates a menu to select the look and feel. The current implementation returns only the tentackle look and feels.

Returns:

a JMenu with all available look and feels

showLoginStatus

public void showLoginStatus(String msg)

Displays a message during login. If the login dialog is visible, the message will be shown there. Otherwise it will simply be logged.

Parameters:

msg - the status message

showEditDialog

public <T extends PersistentDomainObject<T>> T showEditDialog(Component comp,
                                                              T object,
                                                              boolean modal)

Brings up an edit dialog for a given object.

Type Parameters:

T - the PDO type

Parameters:

comp - some component of the owner window, null if none

object - the object to createPdo the dialog for

modal - true if modal, else non-modal

Returns:

the edited object if modal, else null

showEditDialog

public <T extends PersistentDomainObject<T>> T showEditDialog(Component comp,
                                                              Class<T> clazz,
                                                              boolean modal)

Brings up an edit dialog for a given class.

Type Parameters:

T - the PDO type

Parameters:

comp - some component of the owner window, null if none

clazz - is the object's class

modal - true if modal, else non-modal

Returns:

the edited object if modal, else null

showEditDialog

public <T extends PersistentDomainObject<T>> void showEditDialog(Class<T> clazz)

Brings up a non-modal edit dialog for a given class. The owner window is the application's frame. This is the preferred method to be used in edit menus of application frames.

Type Parameters:

T - the PDO type

Parameters:

clazz - is the object's class

showSearchDialog

public <T extends PersistentDomainObject<T>> void showSearchDialog(FormWindow w,
                                                                   Class<T> clazz)

Brings up a search dialog for a given class. Searchdialogs have no owner but use the owner as the related window.

Type Parameters:

T - the PDO type

Parameters:

w - is the related window, null if none

clazz - is the object's class

showSearchDialog

public <T extends PersistentDomainObject<T>> void showSearchDialog(Class<T> clazz)

Brings up a search dialog for a given class. The owner is the application frame. This is the preferred method to be used in search menus of application frames.

Type Parameters:

T - the PDO type

Parameters:

clazz - is the object's class

configurePreferences

protected void configurePreferences()

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

Overrides:

configurePreferences in class AbstractApplication

installLookAndFeels

protected void installLookAndFeels()

Installs the available look and feels. The default implementation installs all Tentackle Plafs.

createLoginDialog

public LoginDialog createLoginDialog(org.tentackle.session.SessionInfo sessionInfo,
                                     Icon logo)

Creates the login dialog.

Parameters:

sessionInfo - the session info

logo - the application logo

Returns:

the login dialog

doLogin

protected DomainContext doLogin()
                         throws org.tentackle.misc.ApplicationException

Connects to the database backend (or application server).

Notice: if the application is started via JNLP (Java WebStart) and the commandline option "--backend=" is given, it is interpreted as a URL to the backend-properties file relative to the JNLP codebase. If it starts with "<protocol>://" it is taken as an absolute URL.
Example:

 --backend=http://www.tentackle.org/Invoicer/backend.properties

 is the same as:

 --backend=backend.properties

 if the codebase is http://www.tentackle.org/Invoicer.
 

Returns:

the connected context db, null if login aborted or authentication failed

Throws:

org.tentackle.misc.ApplicationException - if login failed

doConfigureApplication

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

Do anything what's necessary after the connection has been established. Setup preferences, etc... The default creates the modification thread (but does not start it), installs the Preferences, tentackle's SecurityManager and the look and feels.

Overrides:

doConfigureApplication in class AbstractApplication

Throws:

org.tentackle.misc.ApplicationException - if failed

doCreateWindow

protected abstract FormWindow doCreateWindow()
                                      throws org.tentackle.misc.ApplicationException

Creates the top level window.
The method must not setVisible(true) and is executed from within the EventQueue.

Returns:

the toplevel window, ready for showing

Throws:

org.tentackle.misc.ApplicationException - if failed

doInitializeGUI

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

Initializes the GUI.
The default implementation initializes the Tentackle-EventQueue.

Throws:

org.tentackle.misc.ApplicationException - if failed

See Also:

FormUtilities.getEventQueue()

doShowWindow

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

Shows the window. The default implementation invokes setVisible(true). If the window is a FormContainer, setFormValue() and saveValues() will be invoked as well.

Throws:

org.tentackle.misc.ApplicationException - if failed

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()