net.sourceforge.plantuml

Class UmlDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.UmlDiagram

All Implemented Interfaces:

Diagram

Direct Known Subclasses:

ActivityDiagram3, CucaDiagram, FlowDiagram, PostItDiagram, SequenceDiagram

public abstract class UmlDiagram
extends AbstractPSystem
implements Diagram

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.
static void	exportDiagramError2(OutputStream os, Throwable exception, FileFormatOption fileFormat, String metadata, String flash, List<String> strings)
protected abstract ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
HorizontalAlignment	getAlignmentTeoz(FontParam param)
Animation	getAnimation()
int	getDpi(FileFormatOption fileFormatOption)
double	getDpiFactor(FileFormatOption fileFormatOption)
static List<String>	getFailureText2(Throwable exception)
Display	getFooter()
HorizontalAlignment	getFooterAlignment()
Display	getFooterOrHeaderTeoz(FontParam param)
Display	getHeader()
HorizontalAlignment	getHeaderAlignment()
Display	getLegend()
HorizontalAlignment	getLegendAlignment()
VerticalAlignment	getLegendVerticalAlignment()
int	getMinwidth()
Pragma	getPragma()
Scale	getScale()
ISkinParam	getSkinParam()
Display	getTitle()
abstract UmlDiagramType	getUmlDiagramType()
String	getWarningOrError()
boolean	isHideUnlinkedData()
boolean	isRotation()
void	setAnimation(Iterable<CharSequence> animationData)
void	setFooter(Display footer)
void	setFooterAlignment(HorizontalAlignment footerAlignment)
void	setHeader(Display header)
void	setHeaderAlignment(HorizontalAlignment headerAlignment)
void	setHideUnlinkedData(boolean hideUnlinkedData)
void	setLegend(Display legend, HorizontalAlignment horizontalAlignment, VerticalAlignment valignment)
void	setMinwidth(int minwidth)
void	setParam(String key, String value)
void	setRotation(boolean rotation)
void	setScale(Scale scale)
void	setTitle(Display strings)

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

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(Display strings)

getTitle

public final Display getTitle()

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 Display getHeader()

setHeader

public final void setHeader(Display header)

getFooter

public final Display getFooter()

setFooter

public final void setFooter(Display footer)

getHeaderAlignment

public final HorizontalAlignment getHeaderAlignment()

setHeaderAlignment

public final void setHeaderAlignment(HorizontalAlignment headerAlignment)

getFooterAlignment

public final HorizontalAlignment getFooterAlignment()

getAlignmentTeoz

public final HorizontalAlignment getAlignmentTeoz(FontParam param)

getFooterOrHeaderTeoz

public final Display getFooterOrHeaderTeoz(FontParam param)

setFooterAlignment

public final void setFooterAlignment(HorizontalAlignment footerAlignment)

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

exportDiagramError2

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

Throws:

IOException

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 Display getLegend()

getLegendAlignment

public final HorizontalAlignment getLegendAlignment()

getLegendVerticalAlignment

public final VerticalAlignment getLegendVerticalAlignment()

setLegend

public final void setLegend(Display legend,
                            HorizontalAlignment horizontalAlignment,
                            VerticalAlignment valignment)