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

Constructor Summary

Constructors

Constructor and Description
NewpagedDiagram(AbstractPSystem diag1, AbstractPSystem diag2)

Method Summary

Modifier and Type	Method and Description
CommandExecutionResult	executeCommand(Command cmd, BlocLines lines)
ImageData	exportDiagram(java.io.OutputStream os, int num, FileFormatOption fileFormat) Export the diagram as an image to some format.
DiagramDescription	getDescription()
int	getNbImages() Number of images in this diagram (usually, 1)
java.lang.String	getWarningOrError()
void	makeDiagramReady()
java.lang.String	toString()

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

getMetadata, getSource, getTitle, hasUrl, isOk, setSource

Methods inherited from class java.lang.Object

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

Constructor Detail

NewpagedDiagram

public NewpagedDiagram(AbstractPSystem diag1,
                       AbstractPSystem diag2)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

executeCommand

public CommandExecutionResult executeCommand(Command cmd,
                                             BlocLines lines)

Overrides:

executeCommand in class AbstractPSystem

exportDiagram

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

java.io.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 DiagramDescription getDescription()

getWarningOrError

public java.lang.String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

Overrides:

getWarningOrError in class AbstractPSystem

makeDiagramReady

public void makeDiagramReady()

Overrides:

makeDiagramReady in class AbstractPSystem