net.sourceforge.plantuml
Class NewpagedDiagram

java.lang.Object
  net.sourceforge.plantuml.AbstractPSystem
      net.sourceforge.plantuml.NewpagedDiagram

All Implemented Interfaces:

Diagram

public class NewpagedDiagram
extends AbstractPSystem

Method Summary

CommandExecutionResult	executeCommand(Command cmd, List<String> lines)
ImageData	exportDiagram(OutputStream os, int num, FileFormatOption fileFormat) Export the diagram as an image to some format.
String	getDescription()
int	getNbImages() Number of images in this diagram (usually, 1)
String	getWarningOrError()
static NewpagedDiagram	newpage(AbstractPSystem diagram, AbstractPSystem empty)

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

getMetadata, getSource, getTitle, isOk, makeDiagramReady, setSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newpage

public static NewpagedDiagram newpage(AbstractPSystem diagram,
                                      AbstractPSystem empty)

executeCommand

public CommandExecutionResult executeCommand(Command cmd,
                                             List<String> lines)

Overrides:

executeCommand in class AbstractPSystem

exportDiagram

public ImageData exportDiagram(OutputStream os,
                               int num,
                               FileFormatOption fileFormat)
                        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).

Parameters:

os - where to write the image

num - useually 0 (index of the image to be exported for this diagram).

fileFormat - file format to use

Returns:

a description of the generated image

Throws:

IOException

getNbImages

public int getNbImages()

Description copied from interface: Diagram

Number of images in this diagram (usually, 1)

Specified by:

getNbImages in interface Diagram

Overrides:

getNbImages in class AbstractPSystem

Returns:

usually 1

getDescription

public String getDescription()

getWarningOrError

public String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

Overrides:

getWarningOrError in class AbstractPSystem