Package jline.io.tikz
Class SequenceDiagramExporter
-
- All Implemented Interfaces:
public class SequenceDiagramExporterExports a LayeredNetwork model as a UML sequence diagram using TikZ/pgf-umlsd. Generates LaTeX code that can be compiled to PDF.
-
-
Field Summary
Fields Modifier and Type Field Description public final SequenceDiagramOptionsoptions
-
Constructor Summary
Constructors Constructor Description SequenceDiagramExporter(LayeredNetwork model)Creates a sequence diagram exporter with default options. SequenceDiagramExporter(LayeredNetwork model, SequenceDiagramOptions options)Creates a sequence diagram exporter with custom options.
-
Method Summary
Modifier and Type Method Description SequenceDiagramOptionsgetOptions()Gets the options used by this exporter. StringgenerateSequenceDiagram()Generates the complete LaTeX document with UML sequence diagram. voidexportToFile(String filePath)Exports the sequence diagram to a .tex file. FileexportToPDF()Compiles the sequence diagram to PDF using pdflatex. voidexportToPNG(String filePath, int dpi)Exports the sequence diagram to a PNG file. voidexportToPNG(String filePath)Exports the sequence diagram to a PNG file with default 150 DPI. voiddisplay()Displays the sequence diagram in a PDF viewer. -
-
Constructor Detail
-
SequenceDiagramExporter
SequenceDiagramExporter(LayeredNetwork model)
Creates a sequence diagram exporter with default options.
-
SequenceDiagramExporter
SequenceDiagramExporter(LayeredNetwork model, SequenceDiagramOptions options)
Creates a sequence diagram exporter with custom options.
-
-
Method Detail
-
getOptions
SequenceDiagramOptions getOptions()
Gets the options used by this exporter.
-
generateSequenceDiagram
String generateSequenceDiagram()
Generates the complete LaTeX document with UML sequence diagram.
- Returns:
Complete LaTeX document as a string
-
exportToFile
void exportToFile(String filePath)
Exports the sequence diagram to a .tex file.
- Parameters:
filePath- Path to the output .
-
exportToPDF
File exportToPDF()
Compiles the sequence diagram to PDF using pdflatex.
- Returns:
The generated PDF file
-
exportToPNG
void exportToPNG(String filePath, int dpi)
Exports the sequence diagram to a PNG file.
- Parameters:
filePath- Path to the output .dpi- Resolution in dots per inch
-
exportToPNG
void exportToPNG(String filePath)
Exports the sequence diagram to a PNG file with default 150 DPI.
-
display
void display()
Displays the sequence diagram in a PDF viewer.
-
-
-
-