Package net.sourceforge.plantuml
Class AbstractPSystem
- java.lang.Object
-
- net.sourceforge.plantuml.AbstractPSystem
-
- All Implemented Interfaces:
Diagram
- Direct Known Subclasses:
NewpagedDiagram
,PlainDiagram
,PSystemDitaa
,PSystemDot
,PSystemLatex
,PSystemMath
,PSystemPath
,TitledDiagram
public abstract class AbstractPSystem extends java.lang.Object implements Diagram
-
-
Constructor Summary
Constructors Constructor Description AbstractPSystem(UmlSource source)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.String
checkFinalError()
ImageBuilder
createImageBuilder(FileFormatOption fileFormatOption)
CommandExecutionResult
executeCommand(Command cmd, BlocLines lines)
ImageData
exportDiagram(java.io.OutputStream os, int index, FileFormatOption fileFormatOption)
Export the diagram as an image to some format.protected abstract ImageData
exportDiagramNow(java.io.OutputStream os, int index, FileFormatOption fileFormatOption)
ClockwiseTopRightBottomLeft
getDefaultMargins()
java.lang.String
getMetadata()
int
getNbImages()
Number of images in this diagram (usually, 1)Scale
getScale()
UmlSource
getSource()
The original source of the diagramint
getSplitPagesHorizontal()
int
getSplitPagesVertical()
DisplayPositionned
getTitle()
Display
getTitleDisplay()
java.lang.String
getWarningOrError()
boolean
hasUrl()
Check if the Diagram have some links.boolean
isOk()
void
makeDiagramReady()
long
seed()
void
setScale(Scale scale)
void
setSplitPagesHorizontal(int splitPagesHorizontal)
void
setSplitPagesVertical(int splitPagesVertical)
-
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
-
-
-
-
Constructor Detail
-
AbstractPSystem
public AbstractPSystem(UmlSource source)
-
-
Method Detail
-
getMetadata
public final java.lang.String getMetadata()
- Specified by:
getMetadata
in interfaceDiagram
-
getSource
public final UmlSource getSource()
Description copied from interface:Diagram
The original source of the diagram
-
seed
public final long seed()
-
getNbImages
public int getNbImages()
Description copied from interface:Diagram
Number of images in this diagram (usually, 1)- Specified by:
getNbImages
in interfaceDiagram
- Returns:
- usually 1
-
getSplitPagesHorizontal
public int getSplitPagesHorizontal()
- Specified by:
getSplitPagesHorizontal
in interfaceDiagram
-
setSplitPagesHorizontal
public void setSplitPagesHorizontal(int splitPagesHorizontal)
-
getSplitPagesVertical
public int getSplitPagesVertical()
- Specified by:
getSplitPagesVertical
in interfaceDiagram
-
setSplitPagesVertical
public void setSplitPagesVertical(int splitPagesVertical)
-
getTitle
public DisplayPositionned getTitle()
-
getWarningOrError
public java.lang.String getWarningOrError()
- Specified by:
getWarningOrError
in interfaceDiagram
-
checkFinalError
public java.lang.String checkFinalError()
-
makeDiagramReady
public void makeDiagramReady()
-
isOk
public boolean isOk()
-
executeCommand
public CommandExecutionResult executeCommand(Command cmd, BlocLines lines)
-
hasUrl
public boolean hasUrl()
Description copied from interface:Diagram
Check if the Diagram have some links.
-
exportDiagram
public final ImageData exportDiagram(java.io.OutputStream os, int index, FileFormatOption fileFormatOption) throws java.io.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 aboutnew page
for sequence diagram for example).- Specified by:
exportDiagram
in interfaceDiagram
- Parameters:
os
- where to write the imageindex
- usually 0 (index of the image to be exported for this diagram).fileFormatOption
- file format to use- Returns:
- a description of the generated image
- Throws:
java.io.IOException
-
setScale
public final void setScale(Scale scale)
-
getScale
public final Scale getScale()
-
createImageBuilder
public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption) throws java.io.IOException
- Throws:
java.io.IOException
-
exportDiagramNow
protected abstract ImageData exportDiagramNow(java.io.OutputStream os, int index, FileFormatOption fileFormatOption) throws java.io.IOException
- Throws:
java.io.IOException
-
getDefaultMargins
public ClockwiseTopRightBottomLeft getDefaultMargins()
-
getTitleDisplay
public Display getTitleDisplay()
- Specified by:
getTitleDisplay
in interfaceDiagram
-
-