de.schwarzrot.app
Interface Application<C extends ApplicationConfig>

Type Parameters:

C - - the type of application configuration

All Superinterfaces:

ApplicationListener, EventListener

All Known Implementing Classes:

AbstractApplication

public interface Application<C extends ApplicationConfig>
extends ApplicationListener

interface for toplevel applications. There exists a default implementation AbstractApplication.

Author:

Reinhard Mantey

See Also:

AbstractApplication

Field Summary

static String	ID_NOT_IMPLEMENTED
static String	TITLE_ERROR
static String	TITLE_HINT
static String	TITLE_NOT_IMPLEMENTED

Method Summary

AbstractStatusBar	createStatusBar()
void	destroy()
ApplicationActionHandler	getActionHandler()
C	getAppConfig()
ClassLoader	getClassLoader()
JComponent	getConfigPage()
Container	getContentPane()
JToolBar	getExtraToolBar(int orientation)
DefaultMutableTreeNode	getHelpRoot()
JComponent	getInfo()
Window	getMainWindow() returns the window, which contains the applications toplevel window.
JMenuBar	getMenuBar()
String	getName()
Point	getStartupPos(int defX, int defY)
Dimension	getStartupSize(Dimension defaultSize)
AbstractStatusBar	getStatusBar()
String	getTitleKey()
JToolBar	getToolBar()
MainFrame	getTopWindow() returns the area, where the visual parts of the application are shown.
String	getVersion()
void	init()
boolean	preExit() called by desktop before the application will be closed.
void	refresh()
void	setAppConfig(C acb)
void	setClassLoader(ClassLoader cl)
void	setHelpRoot(DefaultMutableTreeNode root)
void	setMenuBar(JMenuBar mb)
void	setName(String name)
void	setTitle(String title)
void	setToolBar(JToolBar tb)
void	setTopWindow(MainFrame topWindow)
void	start()
void	stop()

Methods inherited from interface org.springframework.context.ApplicationListener

onApplicationEvent

Field Detail

ID_NOT_IMPLEMENTED

static final String ID_NOT_IMPLEMENTED

See Also:

Constant Field Values

TITLE_NOT_IMPLEMENTED

static final String TITLE_NOT_IMPLEMENTED

See Also:

Constant Field Values

TITLE_HINT

static final String TITLE_HINT

See Also:

Constant Field Values

TITLE_ERROR

static final String TITLE_ERROR

See Also:

Constant Field Values

Method Detail

createStatusBar

AbstractStatusBar createStatusBar()

destroy

void destroy()

getActionHandler

ApplicationActionHandler getActionHandler()

getAppConfig

C getAppConfig()

getClassLoader

ClassLoader getClassLoader()

getConfigPage

JComponent getConfigPage()

getContentPane

Container getContentPane()

getExtraToolBar

JToolBar getExtraToolBar(int orientation)

getHelpRoot

DefaultMutableTreeNode getHelpRoot()

getInfo

JComponent getInfo()

getMainWindow

Window getMainWindow()

returns the window, which contains the applications toplevel window. This is always a window - usable as parent for dialogs or so, but it does not necessarily be identical with the return value of getTopWindow. If both return values differ, the window from getMainWindow() is the parent of getTopWindow().

Returns:

the applications main window

getMenuBar

JMenuBar getMenuBar()

getName

String getName()

getStartupPos

Point getStartupPos(int defX,
                    int defY)

getStartupSize

Dimension getStartupSize(Dimension defaultSize)

getStatusBar

AbstractStatusBar getStatusBar()

getTitleKey

String getTitleKey()

getToolBar

JToolBar getToolBar()

getTopWindow

MainFrame getTopWindow()

returns the area, where the visual parts of the application are shown. That may be a window, but need not be. The returned type depends on the active desktop implementation.

Returns:

the applications top visual area

getVersion

String getVersion()

init

void init()

preExit

boolean preExit()

called by desktop before the application will be closed. An application can signal with the return value, that it is stil busy and should not be closed. The application should not assume, that the return value is respected in all cases.

Returns:

- a returnvalue of true means "ok to exit", false means "I'm still busy"

refresh

void refresh()

setAppConfig

void setAppConfig(C acb)

setClassLoader

void setClassLoader(ClassLoader cl)

setHelpRoot

void setHelpRoot(DefaultMutableTreeNode root)

setMenuBar

void setMenuBar(JMenuBar mb)

setName

void setName(String name)

setTitle

void setTitle(String title)

setToolBar

void setToolBar(JToolBar tb)

setTopWindow

void setTopWindow(MainFrame topWindow)

start

void start()

stop

void stop()