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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionjava.lang.String
createImageBuilder
(FileFormatOption fileFormatOption) executeCommand
(Command cmd, BlocLines lines) final 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) final java.lang.String
int
Number of images in this diagram (usually, 1)final Scale
getScale()
final UmlSource
The original source of the diagramint
int
getTitle()
java.lang.String
boolean
hasUrl()
Check if the Diagram have some links.boolean
isOk()
void
final long
seed()
final void
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 Details
-
AbstractPSystem
-
-
Method Details
-
getMetadata
public final java.lang.String getMetadata()- Specified by:
getMetadata
in interfaceDiagram
-
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
-
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
-
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
-
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
-
getTitleDisplay
- Specified by:
getTitleDisplay
in interfaceDiagram
-