com.highqsoft.interfaces.fwk

Interface FwkDOMHandlerInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, FwkDescriptionInterface, FwkInterface, FwkTransferableInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Subinterfaces:

CommandContainerInterface, FwkApplicationInterface, FwkHelpBrokerInterface, FwkPanelInterface, FwkPropertyGroupInterface, FwkServiceControlManagerInterface, MEDInterface, OdsxFilterInterface, OdsxFilterValueInterface, OdsxPresentorInterface, OdsxPresentorPanelInterface, OdsxSelectorInterface, OdsxSelectorPanelInterface, P2DAxisInterface, P2DCanvasInterface, P2DChannelInterface, P2DComponentInterface, P2DContainerInterface, P2DImageInterface, P2DLayouterInterface, P2DLayoutInterface, P2DLegendInterface, P2DMarkerInterface, P2DPlotInterface, P2DRainViewInterface, P2DShapeInterface, P2DTextInterface

All Known Implementing Classes:

AsamCommander, AsamCommanderInstanceSelectorPane, AsamCommanderPanel, BusMonitor, BusMonitorPanel, ColumnDisplay, ColumnDisplayPanel, ColumnEditor, CommandContainer, DataManager, DataManagerCommandContainer, DataManagerPanel, FwkApplication, FwkAuthenticationDialogPane, FwkChangePasswordDialogPane, FwkColorDialogPane, FwkDesktopApplication, FwkDialogPane, FwkDOMHandler, FwkFileChooserDialogPane, FwkFileDialogPane, FwkFontDialogPane, FwkHelp, FwkHelpBroker, FwkInfoBusDialogPane, FwkListDialogPane, FwkOutputStreamApplication, FwkPanel, FwkPropertyEditorDialogPane, FwkPropertyGroup, FwkServiceControlManager, FwkServiceControlManagerPanel, FwkTextDialogPane, FwkTextFieldDialogPane, FwkToggleDialogPane, GarbageCollector, HQL, MED, MEDCalculatorBasicPane, MEDDataGenerators, MEDDataManipulators, MEDInfoBusSelectionDialogPane, MEDMarkerDelete.DeletePane, MEDMarkerGenerators, MEDMarkerThreshold.ThresholdPane, MEDMouseBehaviors, MEDMousePointers, MEDPanel, MEDPlotControls, MoMaXPluginDialogPane, OdsSecurityAdmin, OdsxAttributeEditorPane, OdsxBaseElementFilter, OdsxBaseElementFilterPanel, OdsxColumnAssignmentPane, OdsxDebugLevelEditorPane, OdsxEditorPresentor, OdsxFilter, OdsxFilterEditor, OdsxFilterEditorPane, OdsxFilterEditorPanel, OdsxFilterValue, OdsxInstanceCopyPane, OdsxInstanceCreatePane, OdsxInstanceEditorPane, OdsxMeasurementCreatePane, OdsxPresentor, OdsxPresentorPanel, OdsxQueryTablePresentor, OdsxSelector, OdsxSelectorPanel, OdsxTablePresentorPanel, OdsxTextPresentorPanel, OdsxTranslateDialogPane, P2DAxis, P2DCanvas, P2DChannel, P2DComponent, P2DContainer, P2DImage, P2DLayout, P2DLayouter, P2DLegend, P2DMarker, P2DPlot, P2DRainView, P2DRangeDialogPane, P2DShape, P2DTest, P2DText, P2DTopLayout, QueryTablePresentor, ResourceMonitor, RightsDialogAEPanel, RightsDialogIEPanel, RightsDialogPanel, ToolBarPanel, TrafficLight, UserDialogPanel

public interface FwkDOMHandlerInterface
extends FwkDescriptionInterface

The FwkDOMHandlerInterface describes which functionality a component must implement to handle a DOM.

Since:

$Date: 2017/04/06 13:29:09 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCompany() Get the company that is responsable for that handler.
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.
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) Write the object to the given XML file.

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 com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Method Detail

readConstructor

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

Read a construtor dom node.

Parameters:

document - The documnent Object Model.

node - The node.

readFromDOM

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

Read from DOM

Parameters:

document - The documnent Object Model.

node - The node.

writeConstructor

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.

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The parent node.

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

Returns:

The created document element node.

writeToDOM

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.

Parameters:

document - The documnent Object Model.

node - The parent node.

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

Returns:

The create document element.

writeToXML

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

Write the object to the given XML file.

Parameters:

filename - The name of the xml file.

validate - Write a validated cml file.

getCompany

java.lang.String getCompany()

Get the company that is responsable for that handler.

Specified by:

getCompany in interface FwkDescriptionInterface

Returns:

The company

See Also:

FwkDescriptionInterface.setCompany(String)

readingDOM

void readingDOM(boolean flag)

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

Parameters:

flag - true if the object reads currently fom DOM.

readingDOM

boolean readingDOM()

Get the DOM reading flag.

Returns:

true if the object reads currently fom DOM.