javax.rad.application
Interface ILauncher

All Superinterfaces:

IComponent, IContainer, IExceptionListener, IFrame, INamedObject, IResource, IToolBarPanel, IWindow

All Known Implementing Classes:

SwingApplet.SwingAppletLauncher, SwingApplication, UILauncher

public interface ILauncher
extends IFrame, IExceptionListener

The ILauncher defines a platform and technology independent IApplication launcher. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

Field Summary

static String	ENVIRONMENT_DESKTOP the name for desktop environment.
static String	ENVIRONMENT_HEADLESS the name for headless environment.
static String	ENVIRONMENT_MOBILE the name for mobile environment.
static String	ENVIRONMENT_WEB the name for web environment.
static String	PARAM_APPLICATIONLANGUAGE the parameter name for the application language.
static String	PARAM_APPLICATIONNAME the parameter name for the application name.
static String	PARAM_CODEBASE the parameter name for the codebase.
static String	PARAM_ENVIRONMENT the parameter name for the launcher environment.
static String	PARAM_LOGFACTORY the parameter name for the full qualified class name of the logfactory.
static String	PARAM_SERVERBASE the parameter name for the server base.
static String	PARAM_UIFACTORY the parameter name for the full qualified class name of the UI factory.

Fields inherited from interface javax.rad.ui.container.IFrame

ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, NORMAL

Fields inherited from interface javax.rad.ui.container.IToolBarPanel

AREA_BOTTOM, AREA_LEFT, AREA_RIGHT, AREA_TOP

Method Summary

void	cancelPendingThreads() Cancel/Interrupts all pending threads.
String	getEnvironmentName() Gets the name of the environment for this launcher.
void	getFileHandle(IFileHandleReceiver pFileHandleReceiver, String pTitle) Technology independent getFileHandle.
String	getParameter(String pName) Gets a configuration parameter of the application.
String	getRegistryKey(String pKey) Gets the value for a specific key from the applications registry.
void	saveFileHandle(IFileHandle pFileHandle, String pTitle) Technology independent saveFileHandle.
void	setParameter(String pName, String pValue) Sets a configuration parameter of the application.
void	setRegistryKey(String pKey, String pValue) Sets the value for a specific key to the applications registry.
void	showDocument(String pDocumentName, IRectangle pBounds, String pTarget) Requests that external application shows a document indicated by the pDocumentname argument.
void	showFileHandle(IFileHandle pFileHandle) Technology independent showFileHandle.
void	showFileHandle(IFileHandle pFileHandle, IRectangle pBounds, String pTarget) Technology independent showFileHandle.

Methods inherited from interface javax.rad.ui.container.IFrame

getIconImage, getMenuBar, getState, getTitle, isResizable, setIconImage, setMenuBar, setResizable, setState, setTitle

Methods inherited from interface javax.rad.ui.container.IWindow

centerRelativeTo, dispose, eventWindowActivated, eventWindowClosed, eventWindowClosing, eventWindowDeactivated, eventWindowDeiconified, eventWindowIconified, eventWindowOpened, isActive, isDisposed, pack, toBack, toFront

Methods inherited from interface javax.rad.ui.container.IToolBarPanel

addToolBar, addToolBar, getToolBar, getToolBarArea, getToolBarCount, indexOfToolBar, removeAllToolBars, removeToolBar, removeToolBar, setToolBarArea

Methods inherited from interface javax.rad.ui.IContainer

add, add, add, add, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, setLayout

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Methods inherited from interface javax.rad.util.event.IExceptionListener

handleException

Field Detail

ENVIRONMENT_HEADLESS

static final String ENVIRONMENT_HEADLESS

the name for headless environment.

See Also:

Constant Field Values

ENVIRONMENT_DESKTOP

static final String ENVIRONMENT_DESKTOP

the name for desktop environment.

See Also:

Constant Field Values

ENVIRONMENT_WEB

static final String ENVIRONMENT_WEB

the name for web environment.

See Also:

Constant Field Values

ENVIRONMENT_MOBILE

static final String ENVIRONMENT_MOBILE

the name for mobile environment.

See Also:

Constant Field Values

PARAM_SERVERBASE

static final String PARAM_SERVERBASE

the parameter name for the server base. This property contains the server connection information, e.g. http://localhost:8080/demo. Other connection relevant properties should reference this parameter.

See Also:

Constant Field Values

PARAM_CODEBASE

static final String PARAM_CODEBASE

the parameter name for the codebase. Used for loading resources during application lifecycle.

See Also:

Constant Field Values

PARAM_APPLICATIONNAME

static final String PARAM_APPLICATIONNAME

the parameter name for the application name.

See Also:

Constant Field Values

PARAM_APPLICATIONLANGUAGE

static final String PARAM_APPLICATIONLANGUAGE

the parameter name for the application language.

See Also:

Constant Field Values

PARAM_LOGFACTORY

static final String PARAM_LOGFACTORY

the parameter name for the full qualified class name of the logfactory.

See Also:

Constant Field Values

PARAM_UIFACTORY

static final String PARAM_UIFACTORY

the parameter name for the full qualified class name of the UI factory.

See Also:

Constant Field Values

PARAM_ENVIRONMENT

static final String PARAM_ENVIRONMENT

the parameter name for the launcher environment.

See Also:

Constant Field Values

Method Detail

getParameter

String getParameter(String pName)

Gets a configuration parameter of the application.

Parameters:

pName - the parameter name

Returns:

the value of the parameter or null if the parameter does not exist

setParameter

void setParameter(String pName,
                  String pValue)

Sets a configuration parameter of the application.

Parameters:

pName - the parameter name

pValue - the value for the parameter or null to delete the parameter

showDocument

void showDocument(String pDocumentName,
                  IRectangle pBounds,
                  String pTarget)
                  throws Throwable

Requests that external application shows a document indicated by the pDocumentname argument. The target argument indicates where the document should be displayed. Applications can also ignore the target information.

Parameters:

pDocumentName - the location/filename of the document. (local or network adress)

pBounds - the bounds for the document, if supported from the implementation

pTarget - a String indicating where to display the document.

Throws:

Throwable - if the document couldn't opened/shown

showFileHandle

void showFileHandle(IFileHandle pFileHandle,
                    IRectangle pBounds,
                    String pTarget)
                    throws Throwable

Technology independent showFileHandle. A file chooser dialog should occur. This Function returns immediate.

Parameters:

pFileHandle - the IFileHandle to save.

pBounds - the bounds for the document, if supported from the implementation

pTarget - a String indicating where to display the document.

Throws:

Throwable - if an error occurs during saving the file.

showFileHandle

void showFileHandle(IFileHandle pFileHandle)
                    throws Throwable

Technology independent showFileHandle. A file chooser dialog should occur. This Function returns immediate.

Parameters:

pFileHandle - the IFileHandle to save.

Throws:

Throwable - if an error occurs during saving the file.

saveFileHandle

void saveFileHandle(IFileHandle pFileHandle,
                    String pTitle)
                    throws Throwable

Technology independent saveFileHandle. A file chooser dialog should occur. This Function returns immediate.

Parameters:

pFileHandle - the IFileHandle to save.

pTitle - the title for the dialog or null to set a default title

Throws:

Throwable - if an error occurs during saving the file.

getFileHandle

void getFileHandle(IFileHandleReceiver pFileHandleReceiver,
                   String pTitle)
                   throws Throwable

Technology independent getFileHandle. A file chooser dialog should occur, and as result this function informs the IFileHandle receiver.

Parameters:

pFileHandleReceiver - the IFileHandle receiver that should receive the file.

pTitle - the title for the dialog or null to set a default title

Throws:

Throwable - if an error occurs during getting the file.

cancelPendingThreads

void cancelPendingThreads()

Cancel/Interrupts all pending threads.

setRegistryKey

void setRegistryKey(String pKey,
                    String pValue)

Sets the value for a specific key to the applications registry. The registry is a local store for persistent values.

Parameters:

pKey - the key to set

pValue - the value to set or null to remove the key from the registry

getRegistryKey

String getRegistryKey(String pKey)

Gets the value for a specific key from the applications registry.

Parameters:

pKey - the key to get

Returns:

the value for the key or null if the key is not available

getEnvironmentName

String getEnvironmentName()

Gets the name of the environment for this launcher. The environment could be used to en-/disable features.

Returns:

the name of the environment, e.g. ENVIRONMENT_HEADLESS, ENVIRONMENT_DESKTOP