com.highqsoft.interfaces.fwk

Interface FwkApplicationInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPrintableInterface, FwkPropertyChangeInterface, FwkThreadInterface, FwkTransferableInterface, FwkVetoableChangeInterface, javax.infobus.InfoBusMember, java.awt.print.Pageable, java.awt.print.Printable, java.lang.Runnable, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Subinterfaces:

FwkHelpBrokerInterface, FwkServiceControlManagerInterface, MEDInterface, OdsxPresentorInterface, OdsxSelectorInterface, P2DLayouterInterface

All Known Implementing Classes:

AsamCommander, BusMonitor, ColumnDisplay, DataManager, FwkApplication, FwkDesktopApplication, FwkHelpBroker, FwkOutputStreamApplication, FwkServiceControlManager, GarbageCollector, HQL, MED, OdsxBaseElementFilter, OdsxFilterEditor, OdsxPresentor, OdsxSelector, P2DLayouter, P2DTest, ResourceMonitor

public interface FwkApplicationInterface
extends FwkInfoBusMemberInterface, FwkDOMHandlerInterface, FwkControlledByInterface, FwkPrintableInterface, FwkThreadInterface

The FwkApplicationInterface defines the basic methods for a frame implementation. These basic methods are common to applets, frames and applications.

Since:

$Date: 2017/04/28 08:47:43 $

Version:

$Revision: 1.11 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecuteStateListener(FwkExecuteStateListenerInterface l) Add an execution state listener.
boolean	exit() Exit the application gracefully and release all related resources
void	fireExecuteStateEvent(FwkExecuteStateEventInterface event) Fire an execute state event.
FwkPortInterface	getFwkPort() Get the FwkPort of application.
FwkPanelInterface	getPanel() Get the panel of an application.
FwkPanelInterface	getStatusPanel() Get the status panel of an application.
boolean	hasFwkPort() Return a boolean whether the application has a FwkPort,
void	init() Initialize the application.
boolean	isEternal() Return a boolean whether or not the application is eternal.
boolean	isRegistered() Return a boolean whether the application is registered.
void	register() Register the application with the FwkApplicationBus.
void	register(FwkArrayInterface mimeTypes) Register the application with the FwkApplicationBus.
void	register(java.lang.String[] mimeTypes) Register the application with the FwkApplicationBus.
void	removeExecuteStateListener(FwkExecuteStateListenerInterface l) Remove an execution state listener.
void	setArguments(java.lang.String[] args)
void	setEternal(boolean eternalFlag) This method sets the eternal flag of the application.
void	setPanel(FwkPanelInterface panel) Set the asam commander panel.
void	setServiceControlManager(FwkServiceControlManagerInterface serviceControlManager) Set the service control manager of this application.
void	unregister() Unregister the application.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPrintableInterface

getPrintJobName, setPageFormat

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface java.awt.print.Printable

print

Methods inherited from interface java.awt.print.Pageable

getNumberOfPages, getPageFormat, getPrintable

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkThreadInterface

getPriority, isInterrupted, setPriority, start, stop

Methods inherited from interface java.lang.Runnable

run

Method Detail

exit

boolean exit()

Exit the application gracefully and release all related resources

Returns:

true if successful.

getFwkPort

FwkPortInterface getFwkPort()

Get the FwkPort of application.

Returns:

The FWK port of the application or null if there isn't one.

See Also:

hasFwkPort()

getPanel

FwkPanelInterface getPanel()

Get the panel of an application. Panels in the FWK environment are always JavaBeans.

Returns:

The panel of the application.

setPanel

void setPanel(FwkPanelInterface panel)

Set the asam commander panel.

Parameters:

panel - The panel of the application.

getStatusPanel

FwkPanelInterface getStatusPanel()

Get the status panel of an application. Panels in the FWK environment are always JavaBeans.

Returns:

The status panel of the application.

hasFwkPort

boolean hasFwkPort()

Return a boolean whether the application has a FwkPort,

Returns:

true if the application has a FwkPort.

init

void init()

Initialize the application. Called by the main procedure to inform this application that it has been loaded into the system. It is always called before the first time that the start method is called.

See Also:

setArguments()

isEternal

boolean isEternal()

Return a boolean whether or not the application is eternal. Eternal application (e.g. the online help subsystem). Eternal applications never die (exit) once they have been started. The only way for them to exit is if they are the last living application and their graphical user interface is invisible.

Returns:

true if the application is eternal.

isRegistered

boolean isRegistered()

Return a boolean whether the application is registered.

Returns:

true if the application is already registered.

register

void register()
              throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Throws:

java.lang.RuntimeException

register

void register(FwkArrayInterface mimeTypes)
              throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Parameters:

mimeTypes - The mimetype array.

Throws:

java.lang.RuntimeException - if the application is eternal and already registered.

register

void register(java.lang.String[] mimeTypes)
              throws java.lang.RuntimeException

Register the application with the FwkApplicationBus.

Parameters:

mimeTypes - The mimetype list.

Throws:

java.lang.RuntimeException - if the application is eternal and already registered.

setArguments

void setArguments(java.lang.String[] args)

setEternal

void setEternal(boolean eternalFlag)

This method sets the eternal flag of the application. Eternal application (e.g. the online help subsystem). Eternal applications never die (exit) once they have been started. The only way for them to exit is if they are the last living application and their graphical user interface is invisible. This method fires a property change event on property "Eternal".

Parameters:

eternalFlag - Set to true if the application shall be eternal.

setServiceControlManager

void setServiceControlManager(FwkServiceControlManagerInterface serviceControlManager)

Set the service control manager of this application. The application must respond properly to the requests from the Service Control Manager. This method is used to tell the application whom to talk to.

Parameters:

serviceControlManager - The service control manager.

unregister

void unregister()

Unregister the application.

addExecuteStateListener

void addExecuteStateListener(FwkExecuteStateListenerInterface l)

Add an execution state listener.

Parameters:

l - The listener.

removeExecuteStateListener

void removeExecuteStateListener(FwkExecuteStateListenerInterface l)

Remove an execution state listener.

Parameters:

l - The listener.

fireExecuteStateEvent

void fireExecuteStateEvent(FwkExecuteStateEventInterface event)

Fire an execute state event.

Parameters:

event - The event to be fired.