com.highqsoft.fwk

Class FwkApplication

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.fwk.FwkApplication

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class FwkApplication
extends FwkInfoBusMember
implements FwkApplicationInterface

The default implementation of the FWK application functionality. This application functionality is the same for applet based applications, frame based applications and applications without a GUI.

Property Keyword	Datatype	Default	Description
classname.Height	int	-1	The height of a newly created frame. The classname must be the full java specific classname of your application.
classname.Width	int	-1	The width of a newly created frame. The classname must be the full java specific classname of your application.
classname.X	int	-1	The x position of a newly created frame. The classname must be the full java specific classname of your application.
classname.Y	int	-1	The y position of a newly created frame. The classname must be the full java specific classname of your application.

Since:

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

Version:

$Revision: 1.14 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Thread	applicationThread
protected java.lang.String[]	args
protected FwkControllerInterface	controller
protected static FwkDescriptionInterface	descriptor
protected boolean	eternal
protected java.util.HashMap	executeStateListeners
protected java.awt.print.PageFormat	pageFormat
protected FwkPanelInterface	panel
protected FwkPortInterface	port
protected boolean	readingDOM
protected FwkServiceControlManagerInterface	serviceControlManager
protected FwkStatusLabel	statusLabel
protected FwkPanelInterface	statusPanel
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

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

Constructor Summary

Constructors

Constructor and Description
FwkApplication()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecuteStateListener(FwkExecuteStateListenerInterface l) Add an execution state listener.
boolean	destroyController() Destroy the application GUI.
boolean	exit() Exit the application gracefully and release all related resources
void	fireExecuteStateEvent(FwkExecuteStateEventInterface event) Fire an execute state event.
FwkControllerInterface	getController() Get the controller instance of the application.
static FwkDescriptionInterface	getDescriptor()
FwkPortInterface	getFwkPort() Get the FwkPort of application.
int	getNumberOfPages() Get the total number of pages printed by this application.
java.awt.print.PageFormat	getPageFormat(int pi) Returns the PageFormat of the page specified by pageIndex.
FwkPanelInterface	getPanel() Get the panel of this application.
java.awt.print.Printable	getPrintable(int pi) Returns the Printable instance responsible for rendering the page specified by pageIndex.
java.lang.String	getPrintJobName() Get the name of the printjob.
int	getPriority() Get the priority of the thread.
FwkPanelInterface	getStatusPanel() Get the status panel of this application.
java.lang.String	getVersion() Return the version string of the FWK component.
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	isInterrupted() Test whether the thread is interruped.
boolean	isRegistered() Return a boolean whether the application is registered.
int	print(java.awt.Graphics gp, java.awt.print.PageFormat pf, int pi) The application print command.
java.lang.Object	readConstructor(org.w3c.dom.Document document, org.w3c.dom.Element node) Read a construtor dom node.
void	readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element) Read from DOM
boolean	readingDOM() Get the DOM reading flag.
void	readingDOM(boolean flag) Set a flag that the object is currently reading the DOM.
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.
abstract void	run() Run the application.
void	setArguments(java.lang.String[] args)
void	setController(FwkControllerInterface controller) Set the controller instance of the application.
void	setEternal(boolean eternalFlag) This method sets the eternal flag of the application.
void	setPageFormat(java.awt.print.PageFormat pf, int pi) Set the pageformat of the printable object.
void	setPanel(FwkPanelInterface panel) Set the panel of this application.
void	setPriority(int prio) Set the priority of the thread.
void	setServiceControlManager(FwkServiceControlManagerInterface serviceControlManager) Set the service control manager of this application.
void	start() Start the framework application.
void	stop() Stop the FWK application thread.
void	unregister() Unregister the application.
org.w3c.dom.Element	writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write a construtor dom node.
org.w3c.dom.Element	writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write the container as child to the given DOM node.
boolean	writeToXML(java.lang.String filename, boolean validate) Writes the canvas to an XML file.

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, finalize, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setInfoBusName, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, release, removeDataItemChangeListener, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCommands, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

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

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

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

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.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

release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

panel

protected FwkPanelInterface panel

statusPanel

protected FwkPanelInterface statusPanel

statusLabel

protected FwkStatusLabel statusLabel

args

protected java.lang.String[] args

applicationThread

protected transient java.lang.Thread applicationThread

eternal

protected boolean eternal

pageFormat

protected java.awt.print.PageFormat pageFormat

port

protected FwkPortInterface port

controller

protected FwkControllerInterface controller

readingDOM

protected boolean readingDOM

serviceControlManager

protected FwkServiceControlManagerInterface serviceControlManager

executeStateListeners

protected java.util.HashMap executeStateListeners

Constructor Detail

FwkApplication

public FwkApplication()

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkInfoBusMember

getDescriptor

public static FwkDescriptionInterface getDescriptor()

exit

public boolean exit()

Exit the application gracefully and release all related resources

Specified by:

exit in interface FwkApplicationInterface

Returns:

true if successful.

destroyController

public boolean destroyController()

Destroy the application GUI.

Specified by:

destroyController in interface FwkControllerInterface

Overrides:

destroyController in class FwkPersistence

Returns:

true if the operation was successful.

getFwkPort

public FwkPortInterface getFwkPort()

Get the FwkPort of application.

Specified by:

getFwkPort in interface FwkApplicationInterface

Returns:

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

See Also:

hasFwkPort()

getController

public FwkControllerInterface getController()

Get the controller instance of the application. The controller must implement the FwkWindowInterface.

Specified by:

getController in interface FwkControlledByInterface

Returns:

The controller instance of the application.

getPanel

public FwkPanelInterface getPanel()

Get the panel of this application. Panels in the FWK environment are always JavaBeans. This method is designed to be overwritten by an implementation.

Specified by:

getPanel in interface FwkApplicationInterface

Returns:

The panel of the application.

setPanel

public void setPanel(FwkPanelInterface panel)

Set the panel of this application.

Specified by:

setPanel in interface FwkApplicationInterface

Parameters:

panel - The panel of the application.

getStatusPanel

public FwkPanelInterface getStatusPanel()

Get the status panel of this application. Panels in the FWK environment are always JavaBeans. This method is designed to be overwritten by an implementation.

Specified by:

getStatusPanel in interface FwkApplicationInterface

Returns:

The status panel of the application.

hasFwkPort

public boolean hasFwkPort()

Return a boolean whether the application has a FwkPort.

Specified by:

hasFwkPort in interface FwkApplicationInterface

Returns:

true if the application has a FwkPort.

init

public 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.

Specified by:

init in interface FwkApplicationInterface

See Also:

setArguments()

isEternal

public 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.

Specified by:

isEternal in interface FwkApplicationInterface

Returns:

true if the application is eternal.

isRegistered

public boolean isRegistered()

Return a boolean whether the application is registered.

Specified by:

isRegistered in interface FwkApplicationInterface

Returns:

true if the application is already registered.

register

public void register()
              throws FwkException

Register the application with the FwkApplicationBus.

Specified by:

register in interface FwkApplicationInterface

Throws:

FwkException

register

public void register(FwkArrayInterface mimeTypes)
              throws FwkException

Register the application with the FwkApplicationBus.

Specified by:

register in interface FwkApplicationInterface

Parameters:

mimeTypes - The mimetype array.

Throws:

FwkException - if the application is eternal and already registered.

register

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

Register the application with the FwkApplicationBus.

Specified by:

register in interface FwkApplicationInterface

Parameters:

mimeTypes - The mimetype list.

Throws:

FwkException - if the application is eternal and already registered.

run

public abstract void run()

Run the application. This method is called by the Java Virtual Machine if a start() is requested. User components should never call this method.

Add this method to implement meaningful functionality.

Specified by:

run in interface java.lang.Runnable

setArguments

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

Specified by:

setArguments in interface FwkApplicationInterface

setController

public void setController(FwkControllerInterface controller)

Set the controller instance of the application. The controller must implement the FwkWindowInterface.

Specified by:

setController in interface FwkControlledByInterface

Parameters:

controller - The controller instance of the application.

setEternal

public 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.

Specified by:

setEternal in interface FwkApplicationInterface

Parameters:

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

setServiceControlManager

public 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.

Specified by:

setServiceControlManager in interface FwkApplicationInterface

Parameters:

serviceControlManager - The service control manager.

addExecuteStateListener

public void addExecuteStateListener(FwkExecuteStateListenerInterface l)

Add an execution state listener.

Specified by:

addExecuteStateListener in interface FwkApplicationInterface

Parameters:

l - The listener.

removeExecuteStateListener

public void removeExecuteStateListener(FwkExecuteStateListenerInterface l)

Remove an execution state listener.

Specified by:

removeExecuteStateListener in interface FwkApplicationInterface

Parameters:

l - The listener.

fireExecuteStateEvent

public void fireExecuteStateEvent(FwkExecuteStateEventInterface event)

Fire an execute state event.

Specified by:

fireExecuteStateEvent in interface FwkApplicationInterface

Parameters:

event - The event to be fired.

start

public void start()

Start the framework application.

Specified by:

start in interface FwkThreadInterface

setPriority

public void setPriority(int prio)

Set the priority of the thread.

Specified by:

setPriority in interface FwkThreadInterface

Parameters:

prio - This value is passed to the java.lang.Thread

See Also:

Thread

getPriority

public int getPriority()

Get the priority of the thread.

Specified by:

getPriority in interface FwkThreadInterface

See Also:

Thread

isInterrupted

public boolean isInterrupted()

Test whether the thread is interruped.

Specified by:

isInterrupted in interface FwkThreadInterface

Returns:

true if the tread is interrupted.

stop

public void stop()

Stop the FWK application thread. The thread is terminated gracefully by setting a flag to the run method to stop after the next cycle.

Specified by:

stop in interface FwkThreadInterface

unregister

public void unregister()

Unregister the application.

Specified by:

unregister in interface FwkApplicationInterface

print

public int print(java.awt.Graphics gp,
        java.awt.print.PageFormat pf,
        int pi)
          throws java.awt.print.PrinterException

The application print command. Prints the page at the specified index into the specified Graphics context in the specified format. A PrinterJob calls the Printable interface to request that a page be rendered into the context specified by graphics. The format of the page to be drawn is specified by pageFormat. The zero based index of the requested page is specified by pageIndex. If the requested page does not exist then this method returns NO_SUCH_PAGE; otherwise PAGE_EXISTS is returned. The Graphics class or subclass implements the PrinterGraphics interface to provide additional information. If the Printable object aborts the print job then it throws a PrinterException.
By default this method returns NO_SUCH_PAGE. You must overwrite this method to get a meanningful result.

Specified by:

print in interface java.awt.print.Printable

Parameters:

gp - the context into which the page is drawn

pf - the size and orientation of the page being drawn

pi - the zero based index of the page to be drawn

Returns:

PAGE_EXISTS if the page is rendered successfully or NO_SUCH_PAGE if pageIndex specifies a non-existent page.

Throws:

java.awt.print.PrinterException - thrown when the print job is terminated.

See Also:

Printable

getNumberOfPages

public int getNumberOfPages()

Get the total number of pages printed by this application.
By default this method returns 0. You must overwrite this method to get a meaningful result.

Specified by:

getNumberOfPages in interface java.awt.print.Pageable

Parameters:

The - total number of pages to be printed.

See Also:

Pageable

getPageFormat

public java.awt.print.PageFormat getPageFormat(int pi)

Returns the PageFormat of the page specified by pageIndex.

Specified by:

getPageFormat in interface java.awt.print.Pageable

Parameters:

pi - The page index.

See Also:

Pageable, PageFormat

setPageFormat

public void setPageFormat(java.awt.print.PageFormat pf,
                 int pi)

Set the pageformat of the printable object. If the pageformat is null the object should reset the pageformat.

Specified by:

setPageFormat in interface FwkPrintableInterface

Parameters:

pf - The new pageformat.

pi - The page index.

getPrintable

public java.awt.print.Printable getPrintable(int pi)

Returns the Printable instance responsible for rendering the page specified by pageIndex.

Specified by:

getPrintable in interface java.awt.print.Pageable

Parameters:

pi - The page index.

See Also:

Pageable, PageFormat

getPrintJobName

public java.lang.String getPrintJobName()

Get the name of the printjob.

Specified by:

getPrintJobName in interface FwkPrintableInterface

Returns:

The print job name.

readConstructor

public java.lang.Object readConstructor(org.w3c.dom.Document document,
                               org.w3c.dom.Element node)

Read a construtor dom node.

Specified by:

readConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

readFromDOM

public void readFromDOM(org.w3c.dom.Document doc,
               org.w3c.dom.Element element)

Read from DOM

Specified by:

readFromDOM in interface FwkDOMHandlerInterface

writeConstructor

public org.w3c.dom.Element writeConstructor(org.w3c.dom.Document document,
                                   FwkXmlDtdInterface dtd,
                                   org.w3c.dom.Node node,
                                   java.util.Map classProperties)

Write a construtor dom node.

Specified by:

writeConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

the create document element.

writeToDOM

public org.w3c.dom.Element writeToDOM(org.w3c.dom.Document document,
                             FwkXmlDtdInterface dtd,
                             org.w3c.dom.Node node,
                             java.util.Map classProperties)

Write the container as child to the given DOM node.

Specified by:

writeToDOM in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

node - The parent node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

The create document element.

writeToXML

public boolean writeToXML(java.lang.String filename,
                 boolean validate)

Writes the canvas to an XML file.

Specified by:

writeToXML in interface FwkDOMHandlerInterface

Parameters:

filename - The name of the xml file.

validate - Write a validated cml file.

readingDOM

public void readingDOM(boolean flag)

Set a flag that the object is currently reading the DOM.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Parameters:

flag - true if the object reads currently fom DOM.

readingDOM

public boolean readingDOM()

Get the DOM reading flag.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Returns:

true if the object reads currently fom DOM.