fr.tireme.schemadoc.graphics
Interface ModelGraphicsManager

All Known Implementing Classes:

XMLSpyModelGraphicsManagerImpl

public interface ModelGraphicsManager

Responsible of all the loading of graphics representing all objects found within the documentation.
For now, the sole known implementation is the class XMLSpy graphics.

Since:

21 avril 2003

Version:

2.0

Author:

pierre

Method Summary

boolean	currentGraphicHasAreas() Description of the Method
void	debugDumpStructure() Used for debug purpose in order o understand the managed structure
org.w3c.dom.Element	getCurrentGraphic() Description of the Method
java.lang.String	getCurrentGraphicHeight() Gets the currentGraphicHeight attribute of the ModelGraphicsManager object
java.lang.String	getCurrentGraphicImgFile() Gets the ImgFile from the current graphic
java.lang.String	getCurrentGraphicWidth() Gets the currentGraphicWidth attribute of the ModelGraphicsManager object
boolean	hasGraphic(java.lang.String objId) Enable to know if a specific element have an image associated
void	loadFile() Description of the Method
void	removeNonNeededImagesFiles() Remove all images files that are created by a documentation tool and that are not needed by schmeadoc.
boolean	setCurrentGraphic(java.lang.String objId)

Method Detail

hasGraphic

boolean hasGraphic(java.lang.String objId)
                   throws StandardException

Enable to know if a specific element have an image associated

Parameters:

objId - May either be a full or a simple objID

Returns:

Description of the Returned Value

Throws:

StandardException

setCurrentGraphic

boolean setCurrentGraphic(java.lang.String objId)
                          throws StandardException

Parameters:

objId - May either be a full or a simple objID

Returns:

Description of the Returned Value

Throws:

StandardException

getCurrentGraphicImgFile

java.lang.String getCurrentGraphicImgFile()

Gets the ImgFile from the current graphic

Returns:

image file path

getCurrentGraphicWidth

java.lang.String getCurrentGraphicWidth()

Gets the currentGraphicWidth attribute of the ModelGraphicsManager object

Returns:

The currentGraphicWidth value

getCurrentGraphicHeight

java.lang.String getCurrentGraphicHeight()

Gets the currentGraphicHeight attribute of the ModelGraphicsManager object

Returns:

The currentGraphicHeight value

currentGraphicHasAreas

boolean currentGraphicHasAreas()
                               throws StandardException

Description of the Method

Returns:

Description of the Returned Value

Throws:

StandardException

removeNonNeededImagesFiles

void removeNonNeededImagesFiles()

Remove all images files that are created by a documentation tool and that are not needed by schmeadoc. This is specially useful for XML Spy implementation

getCurrentGraphic

org.w3c.dom.Element getCurrentGraphic()

Description of the Method

Returns:

Description of the Returned Value

loadFile

void loadFile()
              throws Xml2outputExcept

Description of the Method

Throws:

Xml2outputExcept - Description of Exception

debugDumpStructure

void debugDumpStructure()
                        throws Xml2outputExcept

Used for debug purpose in order o understand the managed structure

Throws:

Xml2outputExcept