Package jline.io.tikz
Class SequenceDiagramExporter
java.lang.Object
jline.io.tikz.SequenceDiagramExporter
Exports a LayeredNetwork model as a UML sequence diagram using TikZ/pgf-umlsd.
Generates LaTeX code that can be compiled to PDF.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a sequence diagram exporter with default options.SequenceDiagramExporter(LayeredNetwork model, SequenceDiagramOptions options) Creates a sequence diagram exporter with custom options. -
Method Summary
Modifier and TypeMethodDescriptionvoiddisplay()Displays the sequence diagram in a PDF viewer.voidexportToFile(String filePath) Exports the sequence diagram to a .tex file.Compiles the sequence diagram to PDF using pdflatex.voidexportToPNG(String filePath) Exports the sequence diagram to a PNG file with default 150 DPI.voidexportToPNG(String filePath, int dpi) Exports the sequence diagram to a PNG file.Generates the complete LaTeX document with UML sequence diagram.Gets the options used by this exporter.
-
Constructor Details
-
SequenceDiagramExporter
Creates a sequence diagram exporter with default options. -
SequenceDiagramExporter
Creates a sequence diagram exporter with custom options.
-
-
Method Details
-
generateSequenceDiagram
Generates the complete LaTeX document with UML sequence diagram.- Returns:
- Complete LaTeX document as a string
-
exportToFile
Exports the sequence diagram to a .tex file.- Parameters:
filePath- Path to the output .tex file- Throws:
IOException
-
exportToPDF
Compiles the sequence diagram to PDF using pdflatex.- Returns:
- The generated PDF file
- Throws:
IOException- If file operations failRuntimeException- If pdflatex fails
-
exportToPNG
Exports the sequence diagram to a PNG file.- Parameters:
filePath- Path to the output .png filedpi- Resolution in dots per inch- Throws:
IOException
-
exportToPNG
Exports the sequence diagram to a PNG file with default 150 DPI.- Throws:
IOException
-
display
public void display()Displays the sequence diagram in a PDF viewer. -
getOptions
Gets the options used by this exporter.
-