Package net.sourceforge.plantuml

Class UmlDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.UmlDiagram

All Implemented Interfaces:

Annotated, Diagram, WithSprite

Direct Known Subclasses:

ActivityDiagram3, BoardDiagram, BpmDiagram, CucaDiagram, FlowDiagram, GitDiagram, Help, ListSpriteDiagram, MindMapDiagram, NwDiagram, SequenceDiagram, StdlibDiagram, TimingDiagram, WBSDiagram, WireDiagram

public abstract class UmlDiagram
extends TitledDiagram
implements Diagram, Annotated, WithSprite

Field Summary

Fields inherited from class net.sourceforge.plantuml.TitledDiagram

FORCE_ELK, FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
UmlDiagram(UmlSource source, UmlDiagramType type)
UmlDiagram(UmlSource source, UmlDiagramType type, ISkinSimple orig)

Method Summary

Modifier and Type	Method	Description
protected void	exportCmap(SuggestedFile suggestedFile, int index, ImageData cmapdata)
static void	exportDiagramError(OutputStream os, Throwable exception, FileFormatOption fileFormat, long seed, String metadata, String flash, List<String> strings)
protected abstract ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
protected ImageData	exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption)
static List<String>	getFailureText2(Throwable exception, String textDiagram)
String	getFlashData()
DisplaySection	getFooterOrHeaderTeoz(FontParam param)
int	getMinwidth()
String	getWarningOrError()
boolean	isRotation()
void	setHideEmptyDescription(boolean hideEmptyDescription)
void	setMinwidth(int minwidth)
void	setRotation(boolean rotation)

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addSprite, calculateBackColor, createImageBuilder, getAnimation, getCaption, getCurrentStyleBuilder, getDefaultMargins, getFooter, getHeader, getLegend, getMainFrame, getPragma, getSkinParam, getTitle, getTitleDisplay, getUmlDiagramType, isUseElk, isUseSmetana, loadSkin, setAnimation, setCaption, setLegend, setMainFrame, setParam, setTitle, setUseElk, setUseSmetana

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

checkFinalError, executeCommand, exportDiagram, getMetadata, getNbImages, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, hasUrl, isOk, makeDiagramReady, seed, setScale, setSplitPagesHorizontal, setSplitPagesVertical

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.Annotated

getCaption, getFooter, getHeader, getLegend, getMainFrame, getTitle

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

exportDiagram, getDescription, getMetadata, getNbImages, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay, hasUrl

Methods inherited from interface net.sourceforge.plantuml.WithSprite

addSprite

Constructor Detail

UmlDiagram

public UmlDiagram(UmlSource source,
                  UmlDiagramType type)

UmlDiagram

public UmlDiagram(UmlSource source,
                  UmlDiagramType type,
                  ISkinSimple orig)

Method Detail

getMinwidth

public final int getMinwidth()

setMinwidth

public final void setMinwidth(int minwidth)

isRotation

public final boolean isRotation()

setRotation

public final void setRotation(boolean rotation)

getFooterOrHeaderTeoz

public final DisplaySection getFooterOrHeaderTeoz(FontParam param)

exportDiagramNow

protected final ImageData exportDiagramNow(OutputStream os,
                                           int index,
                                           FileFormatOption fileFormatOption)
                                    throws IOException

Specified by:

exportDiagramNow in class AbstractPSystem

Throws:

IOException

exportDiagramError

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

Throws:

IOException

getFlashData

public String getFlashData()

getFailureText2

public static List<String> getFailureText2(Throwable exception,
                                           String textDiagram)

exportDiagramInternal

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

Throws:

IOException

exportCmap

protected final void exportCmap(SuggestedFile suggestedFile,
                                int index,
                                ImageData cmapdata)
                         throws FileNotFoundException

Throws:

FileNotFoundException

getWarningOrError

public String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

Overrides:

getWarningOrError in class AbstractPSystem

setHideEmptyDescription

public void setHideEmptyDescription(boolean hideEmptyDescription)