Package net.sourceforge.plantuml
Class UmlDiagram
- java.lang.Object
-
- net.sourceforge.plantuml.AbstractPSystem
-
- net.sourceforge.plantuml.UmlDiagram
-
- All Implemented Interfaces:
Annotated
,Diagram
,WithSprite
- Direct Known Subclasses:
ActivityDiagram3
,BpmDiagram
,CucaDiagram
,FlowDiagram
,NwDiagram
,PostItDiagram
,SequenceDiagram
,TimingDiagram
public abstract class UmlDiagram extends AbstractPSystem implements Diagram, Annotated, WithSprite
-
-
Field Summary
Fields Modifier and Type Field Description static boolean
FORCE_JDOT
-
Constructor Summary
Constructors Constructor Description UmlDiagram()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addSprite(java.lang.String name, Sprite sprite)
protected void
exportCmap(SuggestedFile suggestedFile, int index, ImageData cmapdata)
static void
exportDiagramError(java.io.OutputStream os, java.lang.Throwable exception, FileFormatOption fileFormat, long seed, java.lang.String metadata, java.lang.String flash, java.util.List<java.lang.String> strings)
protected abstract ImageData
exportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormatOption)
protected ImageData
exportDiagramNow(java.io.OutputStream os, int index, FileFormatOption fileFormatOption, long seed)
Animation
getAnimation()
DisplayPositionned
getCaption()
int
getDpi(FileFormatOption fileFormatOption)
double
getDpiFactor(FileFormatOption fileFormatOption)
static java.util.List<java.lang.String>
getFailureText2(java.lang.Throwable exception, java.lang.String textDiagram)
java.lang.String
getFlashData()
DisplaySection
getFooter()
DisplaySection
getFooterOrHeaderTeoz(FontParam param)
DisplaySection
getHeader()
DisplayPositionned
getLegend()
Display
getMainFrame()
int
getMinwidth()
Pragma
getPragma()
ISkinParam
getSkinParam()
DisplayPositionned
getTitle()
abstract UmlDiagramType
getUmlDiagramType()
java.lang.String
getWarningOrError()
boolean
isHideUnlinkedData()
boolean
isRotation()
boolean
isUseJDot()
CommandExecutionResult
loadSkin(java.lang.String filename)
void
setAnimation(java.lang.Iterable<java.lang.CharSequence> animationData)
void
setCaption(DisplayPositionned caption)
void
setHideUnlinkedData(boolean hideUnlinkedData)
void
setLegend(DisplayPositionned legend)
void
setMainFrame(Display mainFrame)
void
setMinwidth(int minwidth)
void
setParam(java.lang.String key, java.lang.String value)
void
setRotation(boolean rotation)
void
setTitle(DisplayPositionned title)
void
setUseJDot(boolean useJDot)
-
Methods inherited from class net.sourceforge.plantuml.AbstractPSystem
checkFinalError, executeCommand, exportDiagram, getMetadata, getNbImages, getScale, getSource, hasUrl, isOk, makeDiagramReady, seed, setScale, 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
exportDiagram, getDescription, getMetadata, getNbImages, getSource, hasUrl
-
-
-
-
Field Detail
-
FORCE_JDOT
public static final boolean FORCE_JDOT
- See Also:
- Constant Field Values
-
-
Method Detail
-
setTitle
public final void setTitle(DisplayPositionned title)
-
setMainFrame
public final void setMainFrame(Display mainFrame)
-
setCaption
public final void setCaption(DisplayPositionned caption)
-
getCaption
public final DisplayPositionned getCaption()
- Specified by:
getCaption
in interfaceAnnotated
-
getTitle
public final DisplayPositionned getTitle()
- Specified by:
getTitle
in interfaceAnnotated
- Overrides:
getTitle
in classAbstractPSystem
-
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(java.lang.String key, java.lang.String value)
-
getHeader
public final DisplaySection getHeader()
-
getFooter
public final DisplaySection getFooter()
-
getFooterOrHeaderTeoz
public final DisplaySection getFooterOrHeaderTeoz(FontParam param)
-
getUmlDiagramType
public abstract UmlDiagramType getUmlDiagramType()
-
getPragma
public Pragma getPragma()
-
setAnimation
public final void setAnimation(java.lang.Iterable<java.lang.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)
-
exportDiagramNow
protected final ImageData exportDiagramNow(java.io.OutputStream os, int index, FileFormatOption fileFormatOption, long seed) throws java.io.IOException
- Specified by:
exportDiagramNow
in classAbstractPSystem
- Throws:
java.io.IOException
-
exportDiagramError
public static void exportDiagramError(java.io.OutputStream os, java.lang.Throwable exception, FileFormatOption fileFormat, long seed, java.lang.String metadata, java.lang.String flash, java.util.List<java.lang.String> strings) throws java.io.IOException
- Throws:
java.io.IOException
-
getFlashData
public java.lang.String getFlashData()
-
getFailureText2
public static java.util.List<java.lang.String> getFailureText2(java.lang.Throwable exception, java.lang.String textDiagram)
-
exportDiagramInternal
protected abstract ImageData exportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormatOption) throws java.io.IOException
- Throws:
java.io.IOException
-
exportCmap
protected final void exportCmap(SuggestedFile suggestedFile, int index, ImageData cmapdata) throws java.io.FileNotFoundException
- Throws:
java.io.FileNotFoundException
-
getWarningOrError
public java.lang.String getWarningOrError()
- Specified by:
getWarningOrError
in interfaceDiagram
- Overrides:
getWarningOrError
in classAbstractPSystem
-
addSprite
public void addSprite(java.lang.String name, Sprite sprite)
- Specified by:
addSprite
in interfaceWithSprite
-
getLegend
public final DisplayPositionned getLegend()
-
setLegend
public void setLegend(DisplayPositionned legend)
-
setUseJDot
public void setUseJDot(boolean useJDot)
-
isUseJDot
public boolean isUseJDot()
-
getMainFrame
public final Display getMainFrame()
- Specified by:
getMainFrame
in interfaceAnnotated
-
loadSkin
public CommandExecutionResult loadSkin(java.lang.String filename) throws java.io.IOException
- Throws:
java.io.IOException
-
-