Package net.sourceforge.plantuml

Class AbstractPSystem

java.lang.Object
net.sourceforge.plantuml.AbstractPSystem
All Implemented Interfaces:
Diagram
Direct Known Subclasses:
NewpagedDiagram, PlainDiagram, PSystemDitaa, PSystemDot, PSystemJcckit, PSystemLatex, PSystemMath, PSystemPath, PSystemSudoku, PSystemXearth, TitledDiagram
public abstract class AbstractPSystem extends Object implements Diagram
An abstract class for all diagram classes.

Short for "plasma system", although most newer diagram types do not use entities stored in a plasma.

See Also:

  • Constructor Details

    • AbstractPSystem

      public AbstractPSystem(UmlSource source)

  • Method Details

    • setNamespaceSeparator

      public void setNamespaceSeparator(String namespaceSeparator)

    • getNamespaceSeparator

      public final String getNamespaceSeparator()

    • getMetadata

      public final String getMetadata()
      Specified by:
      getMetadata in interface Diagram

    • getSource

      public final UmlSource getSource()
      Description copied from interface: Diagram
      The original source of the diagram
      Specified by:
      getSource in interface 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 interface Diagram
      Returns:
      usually 1

    • getSplitPagesHorizontal

      public int getSplitPagesHorizontal()
      Specified by:
      getSplitPagesHorizontal in interface Diagram

    • setSplitPagesHorizontal

      public void setSplitPagesHorizontal(int splitPagesHorizontal)

    • getSplitPagesVertical

      public int getSplitPagesVertical()
      Specified by:
      getSplitPagesVertical in interface Diagram

    • setSplitPagesVertical

      public void setSplitPagesVertical(int splitPagesVertical)

    • getTitle

      public DisplayPositionned getTitle()

    • getWarningOrError

      public String getWarningOrError()
      Specified by:
      getWarningOrError in interface Diagram

    • checkFinalError

      public 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.
      Specified by:
      hasUrl in interface Diagram

    • exportDiagram

      public final ImageData exportDiagram(OutputStream os, int index, FileFormatOption fileFormatOption) throws 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 about new page for sequence diagram for example).
      Specified by:
      exportDiagram in interface Diagram
      Parameters:
      os - where to write the image
      index - 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:
      IOException

    • setScale

      public final void setScale(Scale scale)

    • getScale

      public final Scale getScale()

    • createImageBuilder

      public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption) throws IOException
      Throws:
      IOException

    • muteColorMapper

      protected ColorMapper muteColorMapper(ColorMapper init)

    • exportDiagramNow

      protected abstract ImageData exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption) throws IOException
      Throws:
      IOException

    • getDefaultMargins

      public ClockwiseTopRightBottomLeft getDefaultMargins()

    • getTitleDisplay

      public Display getTitleDisplay()
      Specified by:
      getTitleDisplay in interface Diagram

    • exportDiagramGraphic

      public void exportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption)
      Specified by:
      exportDiagramGraphic in interface Diagram