net.sourceforge.plantuml.api

Class ImageDataComplex

java.lang.Object

net.sourceforge.plantuml.api.ImageDataAbstract

net.sourceforge.plantuml.api.ImageDataComplex

All Implemented Interfaces:

ImageData

public class ImageDataComplex
extends ImageDataAbstract

Constructor Summary

Constructors

Constructor and Description
ImageDataComplex(XDimension2D info, CMapData cmap, java.lang.String warningOrError)
ImageDataComplex(XDimension2D info, CMapData cmap, java.lang.String warningOrError, int status)

Method Summary

Modifier and Type	Method and Description
boolean	containsCMapData() Indicates if the image has some position information.
java.lang.String	getCMapData(java.lang.String nameId) Return position information as a CMap formated string.
java.lang.Throwable	getRootCause()
java.lang.String	getWarningOrError()

Methods inherited from class net.sourceforge.plantuml.api.ImageDataAbstract

getHeight, getStatus, getWidth, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageDataComplex

public ImageDataComplex(XDimension2D info,
                        CMapData cmap,
                        java.lang.String warningOrError)

ImageDataComplex

public ImageDataComplex(XDimension2D info,
                        CMapData cmap,
                        java.lang.String warningOrError,
                        int status)

Method Detail

containsCMapData

public boolean containsCMapData()

Description copied from interface: ImageData

Indicates if the image has some position information.

Returns:

true if the image has position information.

getCMapData

public java.lang.String getCMapData(java.lang.String nameId)

Description copied from interface: ImageData

Return position information as a CMap formated string. For example, if you call this method with nameId set to "foo_map", you will get something like:

 <map id="foo_map" name="foo_map">
 <area shape="rect" id="..." href="..." title="..." alt="" coords="64,68,93,148"/>
 </map>
 

Parameters:

nameId - the id to be used in the cmap data string.

getWarningOrError

public java.lang.String getWarningOrError()

getRootCause

public java.lang.Throwable getRootCause()