fr.tireme.schemadoc.graphics
Interface ModelGraphicsManager

All Known Implementing Classes:

XMLSpyModelGraphicsManagerImpl

public interface ModelGraphicsManager

Responsible of all the loading of graphics that are 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()
void	debugDumpStructure() Used for debug purpose in order o understand the managed structure.
org.w3c.dom.Element	getCurrentGraphic()
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	loadData()
void	removeNonNeededImagesFiles(java.io.File dataFilePath) Remove all images files that are created by a documentation tool and that are not needed by schemadoc.
boolean	setCurrentGraphic(java.lang.String objId) Set the current managed graphic.

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 - exception raised

setCurrentGraphic

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

Set the current managed graphic.

Parameters:

objId - May either be a full or a simple objID

Returns:

Description of the Returned Value

Throws:

StandardException - exception raised

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

Returns:

Description of the Returned Value

Throws:

StandardException - exception raised

removeNonNeededImagesFiles

void removeNonNeededImagesFiles(java.io.File dataFilePath)

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

Parameters:

dataFilePath - either a directory or a file in the directory where all images are stored

getCurrentGraphic

org.w3c.dom.Element getCurrentGraphic()

Returns:

Description of the Returned Value

loadData

void loadData()
              throws SDExcept

Throws:

SDExcept - Description of Exception

debugDumpStructure

void debugDumpStructure()
                        throws SDExcept

Used for debug purpose in order o understand the managed structure.

Throws:

SDExcept - exception raised