info.aduna.clustermap.export
Class HtmlImageMapExporter

java.lang.Object
  info.aduna.clustermap.export.HtmlImageMapExporter

public class HtmlImageMapExporter
extends Object

A HtmlImageMapExporter is capable of saving a HTML document containing an image map of the Graph to a Writer. In can be used in combination with an ImageExporter in order to create the complete map (i.e. an HTML document and image file).

HtmlImageMapExporter can also be instructed to create only the MAP element, e.g. if the image map is to be included in a HTML template.

Field Summary

static boolean	DEFAULT_FULL_HTML_DOCUMENT The default value of the "full HTML document" property.
static String	DEFAULT_IMAGE_FILE_NAME The default value of the image name property.
static String	DEFAULT_MAP_NAME The default value of the map name property.
static String	DEFAULT_TITLE The default title of the HTML document.

Constructor Summary

HtmlImageMapExporter(GraphRenderer renderer)
Create a new HtmlImageMapExporter that will use the specified GraphRenderer for retrieving information about clickable regions.

Method Summary

void	export() Exports the HTML document or the MAP element, depending on what was requested, to the installed Writer.
String	getImageFileName()
String	getMapName()
String	getTitle()
boolean	isFullHtmlDocument()
void	setFullHtmlDocument(boolean fullHtmlDocument)
void	setImageFileName(String name)
void	setMapName(String mapName) Set the name to be used to identify the MAP element.
void	setTitle(String title)
void	setWriter(Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FULL_HTML_DOCUMENT

public static final boolean DEFAULT_FULL_HTML_DOCUMENT

The default value of the "full HTML document" property.

See Also:

Constant Field Values

DEFAULT_MAP_NAME

public static final String DEFAULT_MAP_NAME

The default value of the map name property.

See Also:

Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE

The default title of the HTML document.

See Also:

Constant Field Values

DEFAULT_IMAGE_FILE_NAME

public static final String DEFAULT_IMAGE_FILE_NAME

The default value of the image name property.

See Also:

Constant Field Values

Constructor Detail

HtmlImageMapExporter

public HtmlImageMapExporter(GraphRenderer renderer)

Create a new HtmlImageMapExporter that will use the specified GraphRenderer for retrieving information about clickable regions.

Method Detail

setWriter

public void setWriter(Writer writer)

setMapName

public void setMapName(String mapName)
                throws IllegalArgumentException

Set the name to be used to identify the MAP element.

Throws:

IllegalArgumentException - when the specified String is null.

getMapName

public String getMapName()

setFullHtmlDocument

public void setFullHtmlDocument(boolean fullHtmlDocument)

isFullHtmlDocument

public boolean isFullHtmlDocument()

setTitle

public void setTitle(String title)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

getTitle

public String getTitle()

setImageFileName

public void setImageFileName(String name)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

getImageFileName

public String getImageFileName()

export

public void export()

Exports the HTML document or the MAP element, depending on what was requested, to the installed Writer. Note that this Writer is not closed by this method.