net.sourceforge.plantuml

Class UmlDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.UmlDiagram

All Implemented Interfaces:

Annotated, Diagram

Direct Known Subclasses:

ActivityDiagram3, CucaDiagram, FlowDiagram, PostItDiagram, SequenceDiagram

public abstract class UmlDiagram
extends AbstractPSystem
implements Diagram, Annotated

Constructor Summary

Constructors

Constructor and Description
UmlDiagram()

Method Summary

Modifier and Type	Method and Description
void	addSprite(String name, Sprite sprite)
protected void	exportCmap(File suggestedFile, ImageData cmapdata)
ImageData	exportDiagram(OutputStream os, int index, FileFormatOption fileFormatOption) Export the diagram as an image to some format.
void	exportDiagramError(OutputStream os, Throwable exception, FileFormatOption fileFormat, String graphvizVersion)
static void	exportDiagramError(OutputStream os, Throwable exception, FileFormatOption fileFormat, String metadata, String flash, List<String> strings)
protected abstract ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
Animation	getAnimation()
DisplayPositionned	getCaption()
int	getDpi(FileFormatOption fileFormatOption)
double	getDpiFactor(FileFormatOption fileFormatOption)
static List<String>	getFailureText2(Throwable exception)
String	getFlashData()
DisplayPositionned	getFooter()
DisplayPositionned	getFooterOrHeaderTeoz(FontParam param)
DisplayPositionned	getHeader()
DisplayPositionned	getLegend()
int	getMinwidth()
Pragma	getPragma()
Scale	getScale()
ISkinParam	getSkinParam()
DisplayPositionned	getTitle()
abstract UmlDiagramType	getUmlDiagramType()
String	getWarningOrError()
boolean	isHideUnlinkedData()
boolean	isRotation()
boolean	isUseJDot()
void	setAnimation(Iterable<CharSequence> animationData)
void	setCaption(DisplayPositionned caption)
void	setDotExecutable(String dotExecutable)
void	setFooter(DisplayPositionned footer)
void	setHeader(DisplayPositionned header)
void	setHideUnlinkedData(boolean hideUnlinkedData)
void	setLegend(DisplayPositionned legend)
void	setMinwidth(int minwidth)
void	setParam(String key, String value)
void	setRotation(boolean rotation)
void	setScale(Scale scale)
void	setTitle(DisplayPositionned title)
void	setUseJDot(boolean useJDot)

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, getMetadata, getNbImages, getSource, hasUrl, isOk, makeDiagramReady, setSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.plantuml.core.Diagram

getDescription, getMetadata, getNbImages, getSource, hasUrl

Constructor Detail

UmlDiagram

public UmlDiagram()

Method Detail

setTitle

public final void setTitle(DisplayPositionned title)

setCaption

public final void setCaption(DisplayPositionned caption)

getCaption

public final DisplayPositionned getCaption()

Specified by:

getCaption in interface Annotated

getTitle

public final DisplayPositionned getTitle()

Specified by:

getTitle in interface Annotated

Overrides:

getTitle in class AbstractPSystem

getMinwidth

public final int getMinwidth()

setMinwidth

public final void setMinwidth(int minwidth)

isRotation

public final boolean isRotation()

setRotation

public final void setRotation(boolean rotation)

getSkinParam

public final ISkinParam getSkinParam()

setParam

public void setParam(String key,
                     String value)

getHeader

public final DisplayPositionned getHeader()

Specified by:

getHeader in interface Annotated

setHeader

public final void setHeader(DisplayPositionned header)

getFooter

public final DisplayPositionned getFooter()

Specified by:

getFooter in interface Annotated

setFooter

public final void setFooter(DisplayPositionned footer)

getFooterOrHeaderTeoz

public final DisplayPositionned getFooterOrHeaderTeoz(FontParam param)

getUmlDiagramType

public abstract UmlDiagramType getUmlDiagramType()

getPragma

public Pragma getPragma()

setScale

public final void setScale(Scale scale)

getScale

public final Scale getScale()

setAnimation

public final void setAnimation(Iterable<CharSequence> animationData)

getAnimation

public final Animation getAnimation()

getDpiFactor

public final double getDpiFactor(FileFormatOption fileFormatOption)

getDpi

public final int getDpi(FileFormatOption fileFormatOption)

isHideUnlinkedData

public final boolean isHideUnlinkedData()

setHideUnlinkedData

public final void setHideUnlinkedData(boolean hideUnlinkedData)

exportDiagram

public final ImageData exportDiagram(OutputStream os,
                                     int index,
                                     FileFormatOption fileFormatOption)
                              throws IOException

Description copied from interface: Diagram

Export the diagram as an image to some format. Note that a diagram could be drawn as several images (think about new page for sequence diagram for example).

Specified by:

exportDiagram in interface Diagram

Parameters:

os - where to write the image

index - useually 0 (index of the image to be exported for this diagram).

fileFormatOption - file format to use

Returns:

a description of the generated image

Throws:

IOException

exportDiagramError

public void exportDiagramError(OutputStream os,
                               Throwable exception,
                               FileFormatOption fileFormat,
                               String graphvizVersion)
                        throws IOException

Throws:

IOException

exportDiagramError

public static void exportDiagramError(OutputStream os,
                                      Throwable exception,
                                      FileFormatOption fileFormat,
                                      String metadata,
                                      String flash,
                                      List<String> strings)
                               throws IOException

Throws:

IOException

getFlashData

public String getFlashData()

getFailureText2

public static List<String> getFailureText2(Throwable exception)

exportDiagramInternal

protected abstract ImageData exportDiagramInternal(OutputStream os,
                                                   int index,
                                                   FileFormatOption fileFormatOption)
                                            throws IOException

Throws:

IOException

exportCmap

protected final void exportCmap(File suggestedFile,
                                ImageData cmapdata)
                         throws FileNotFoundException

Throws:

FileNotFoundException

getWarningOrError

public String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

Overrides:

getWarningOrError in class AbstractPSystem

addSprite

public void addSprite(String name,
                      Sprite sprite)

getLegend

public final DisplayPositionned getLegend()

Specified by:

getLegend in interface Annotated

setLegend

public final void setLegend(DisplayPositionned legend)

setUseJDot

public void setUseJDot(boolean useJDot)

isUseJDot

public boolean isUseJDot()

setDotExecutable

public void setDotExecutable(String dotExecutable)