net.sourceforge.plantuml.sequencediagram

Class SequenceDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.UmlDiagram

net.sourceforge.plantuml.sequencediagram.SequenceDiagram

All Implemented Interfaces:

Annotated, Diagram

public class SequenceDiagram
extends UmlDiagram

Constructor Summary

Constructors

Constructor and Description
SequenceDiagram()

Method Summary

Modifier and Type	Method and Description
String	activate(Participant p, LifeEventType lifeEventType, HtmlColor backcolor)
String	activate(Participant p, LifeEventType lifeEventType, HtmlColor backcolor, HtmlColor linecolor)
String	addMessage(AbstractMessage m)
void	addNote(Note n, boolean tryMerge)
void	addReference(Reference ref)
void	autonumberGo(int startingNumber, int increment, DecimalFormat decimalFormat)
void	autonumberResume(DecimalFormat decimalFormat)
void	autonumberResume(int increment, DecimalFormat decimalFormat)
void	autonumberStop()
void	boxStart(Display comment, HtmlColor color)
boolean	changeSkin(String className)
String	checkFinalError()
Participant	createNewParticipant(ParticipantType type, String code, Display display)
void	delay(Display strings)
void	divider(Display strings)
void	endBox()
List<Event>	events()
protected ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormat)
Message	getActivatingMessage()
int	getAutonewpage()
DiagramDescription	getDescription()
double	getDpiFactor(FileFormatOption fileFormatOption, Dimension2D dim)
ParticipantEnglober	getEnglober(Participant p)
EventWithDeactivate	getLastEventWithDeactivate()
int	getNbImages() Number of images in this diagram (usually, 1)
String	getNextMessageNumber()
Participant	getOrCreateParticipant(String code) Deprecated.
Participant	getOrCreateParticipant(String code, Display display)
UmlDiagramType	getUmlDiagramType()
boolean	grouping(String title, String comment, GroupingType type, HtmlColor backColorGeneral, HtmlColor backColorElement)
boolean	hasUrl() Check if the Diagram have some links.
void	hspace()
void	hspace(int pixel)
void	ignoreNewpage()
boolean	isAutoactivate()
boolean	isBoxPending()
boolean	isOk()
boolean	isShowFootbox()
void	newpage(Display strings)
Map<String,Participant>	participants()
void	putParticipantInLast(String code)
void	removeHiddenParticipants()
void	setAutoactivate(boolean autoactivate)
void	setAutonewpage(int autonewpage)
void	setShowFootbox(boolean footbox)

Methods inherited from class net.sourceforge.plantuml.UmlDiagram

addSprite, exportCmap, exportDiagram, exportDiagramError, exportDiagramError, getAnimation, getCaption, getDpi, getDpiFactor, getFailureText2, getFlashData, getFooter, getFooterOrHeaderTeoz, getHeader, getLegend, getMinwidth, getPragma, getScale, getSkinParam, getTitle, getWarningOrError, isHideUnlinkedData, isRotation, isUseJDot, setAnimation, setCaption, setDotExecutable, setFooter, setHeader, setHideUnlinkedData, setLegend, setMinwidth, setParam, setRotation, setScale, setTitle, setUseJDot

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

executeCommand, getMetadata, getSource, makeDiagramReady, setSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.plantuml.core.Diagram

getMetadata, getSource

Constructor Detail

SequenceDiagram

public SequenceDiagram()

Method Detail

getOrCreateParticipant

@Deprecated
public Participant getOrCreateParticipant(String code)

Deprecated.

getOrCreateParticipant

public Participant getOrCreateParticipant(String code,
                                          Display display)

getLastEventWithDeactivate

public EventWithDeactivate getLastEventWithDeactivate()

createNewParticipant

public Participant createNewParticipant(ParticipantType type,
                                        String code,
                                        Display display)

participants

public Map<String,Participant> participants()

addMessage

public String addMessage(AbstractMessage m)

addNote

public void addNote(Note n,
                    boolean tryMerge)

newpage

public void newpage(Display strings)

ignoreNewpage

public void ignoreNewpage()

getAutonewpage

public final int getAutonewpage()

setAutonewpage

public void setAutonewpage(int autonewpage)

divider

public void divider(Display strings)

hspace

public void hspace()

hspace

public void hspace(int pixel)

delay

public void delay(Display strings)

events

public List<Event> events()

exportDiagramInternal

protected ImageData exportDiagramInternal(OutputStream os,
                                          int index,
                                          FileFormatOption fileFormat)
                                   throws IOException

Specified by:

exportDiagramInternal in class UmlDiagram

Throws:

IOException

getActivatingMessage

public Message getActivatingMessage()

activate

public String activate(Participant p,
                       LifeEventType lifeEventType,
                       HtmlColor backcolor)

activate

public String activate(Participant p,
                       LifeEventType lifeEventType,
                       HtmlColor backcolor,
                       HtmlColor linecolor)

grouping

public boolean grouping(String title,
                        String comment,
                        GroupingType type,
                        HtmlColor backColorGeneral,
                        HtmlColor backColorElement)

getDescription

public DiagramDescription getDescription()

changeSkin

public boolean changeSkin(String className)

autonumberGo

public final void autonumberGo(int startingNumber,
                               int increment,
                               DecimalFormat decimalFormat)

autonumberStop

public final void autonumberStop()

autonumberResume

public final void autonumberResume(DecimalFormat decimalFormat)

autonumberResume

public final void autonumberResume(int increment,
                                   DecimalFormat decimalFormat)

getNextMessageNumber

public String getNextMessageNumber()

isShowFootbox

public boolean isShowFootbox()

setShowFootbox

public void setShowFootbox(boolean footbox)

getUmlDiagramType

public UmlDiagramType getUmlDiagramType()

Specified by:

getUmlDiagramType in class UmlDiagram

boxStart

public void boxStart(Display comment,
                     HtmlColor color)

endBox

public void endBox()

isBoxPending

public boolean isBoxPending()

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

removeHiddenParticipants

public void removeHiddenParticipants()

putParticipantInLast

public void putParticipantInLast(String code)

getEnglober

public ParticipantEnglober getEnglober(Participant p)

setAutoactivate

public final void setAutoactivate(boolean autoactivate)

isAutoactivate

public final boolean isAutoactivate()

hasUrl

public boolean hasUrl()

Description copied from interface: Diagram

Check if the Diagram have some links.

Specified by:

hasUrl in interface Diagram

Overrides:

hasUrl in class AbstractPSystem

Returns:

addReference

public void addReference(Reference ref)

isOk

public boolean isOk()

Overrides:

isOk in class AbstractPSystem

getDpiFactor

public double getDpiFactor(FileFormatOption fileFormatOption,
                           Dimension2D dim)

checkFinalError

public String checkFinalError()

Overrides:

checkFinalError in class AbstractPSystem