net.sourceforge.plantuml.sequencediagram

Class SequenceDiagram

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.TitledDiagram

net.sourceforge.plantuml.UmlDiagram

net.sourceforge.plantuml.sequencediagram.SequenceDiagram

All Implemented Interfaces:

Annotated, Diagram, WithSprite

public class SequenceDiagram
extends UmlDiagram

Field Summary

Fields inherited from class net.sourceforge.plantuml.TitledDiagram

FORCE_ELK, FORCE_SMETANA

Constructor Summary

Constructors

Constructor and Description
SequenceDiagram(UmlSource source, java.util.Map<java.lang.String,java.lang.String> skinParam)

Method Summary

Modifier and Type	Method and Description
java.lang.String	activate(Participant p, LifeEventType lifeEventType, HColor backcolor)
java.lang.String	activate(Participant p, LifeEventType lifeEventType, HColor backcolor, HColor linecolor)
CommandExecutionResult	addMessage(AbstractMessage m)
void	addNote(Note n, boolean tryMerge)
void	addReference(Reference ref)
void	autonumberGo(DottedNumber startingNumber, int increment, java.text.DecimalFormat decimalFormat)
void	autonumberStop()
void	boxStart(Display comment, HColor color, Stereotype stereotype)
java.lang.String	checkFinalError()
ImageBuilder	createImageBuilder(FileFormatOption fileFormatOption)
Participant	createNewParticipant(ParticipantType type, java.lang.String code, Display display, int order)
void	delay(Display strings)
void	divider(Display strings)
void	endBox()
java.util.List<Event>	events()
void	exportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption)
protected ImageData	exportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormat)
AbstractMessage	getActivatingMessage()
int	getAutonewpage()
AutoNumber	getAutoNumber()
ClockwiseTopRightBottomLeft	getDefaultMargins()
DiagramDescription	getDescription()
ParticipantEnglober	getEnglober(Participant p)
EventWithDeactivate	getLastEventWithDeactivate()
EventWithNote	getLastEventWithNote()
java.util.List<LinkAnchor>	getLinkAnchors()
int	getNbImages() Number of images in this diagram (usually, 1)
java.lang.String	getNextMessageNumber()
Participant	getOrCreateParticipant(java.lang.String code) Deprecated.
Participant	getOrCreateParticipant(java.lang.String code, Display display)
protected TextBlock	getTextMainBlock(FileFormatOption fileFormatOption)
boolean	grouping(java.lang.String title, java.lang.String comment, GroupingType type, HColor backColorGeneral, HColor backColorElement, boolean parallel)
boolean	hasUrl() Check if the Diagram have some links.
void	hideOrShow(java.util.Set<EntityPortion> portions, boolean show)
void	hspace()
void	hspace(int pixel)
void	ignoreNewpage()
boolean	isAutoactivate()
boolean	isBoxPending()
boolean	isHideUnlinkedData()
boolean	isOk()
boolean	isShowFootbox()
CommandExecutionResult	linkAnchor(java.lang.String anchor1, java.lang.String anchor2, java.lang.String message)
Display	manageVariable(Display labels)
void	newpage(Display strings)
java.util.Collection<Participant>	participants()
boolean	participantsContainsKey(java.lang.String code)
void	putParticipantInLast(java.lang.String code)
void	removeHiddenParticipants()
void	setAutoactivate(boolean autoactivate)
void	setAutonewpage(int autonewpage)
void	setHideUnlinkedData(boolean hideUnlinkedData)
void	setShowFootbox(boolean footbox)

Methods inherited from class net.sourceforge.plantuml.UmlDiagram

exportCmap, exportDiagramError, exportDiagramNow, getFailureText2, getFlashData, getFooterOrHeaderTeoz, getMinwidth, getWarningOrError, isRotation, setHideEmptyDescription, setMinwidth, setRotation

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addSprite, calculateBackColor, getCaption, getCurrentStyleBuilder, getFooter, getHeader, getLegend, getMainFrame, getPragma, getSkinParam, getTitle, getTitleDisplay, getUmlDiagramType, isUseElk, isUseSmetana, loadSkin, muteColorMapper, setCaption, setLegend, setMainFrame, setParam, setTitle, setUseElk, setUseSmetana

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

executeCommand, exportDiagram, getMetadata, getNamespaceSeparator, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, makeDiagramReady, seed, setNamespaceSeparator, setScale, setSplitPagesHorizontal, setSplitPagesVertical

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.Annotated

getCaption, getFooter, getHeader, getLegend, getMainFrame, getTitle

Methods inherited from interface net.sourceforge.plantuml.WithSprite

addSprite

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

exportDiagram, getMetadata, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay

Constructor Detail

SequenceDiagram

public SequenceDiagram(UmlSource source,
                       java.util.Map<java.lang.String,java.lang.String> skinParam)

Method Detail

isHideUnlinkedData

public final boolean isHideUnlinkedData()

setHideUnlinkedData

public final void setHideUnlinkedData(boolean hideUnlinkedData)

getOrCreateParticipant

@Deprecated
public Participant getOrCreateParticipant(java.lang.String code)

Deprecated.

getOrCreateParticipant

public Participant getOrCreateParticipant(java.lang.String code,
                                          Display display)

getLastEventWithDeactivate

public EventWithDeactivate getLastEventWithDeactivate()

getLastEventWithNote

public EventWithNote getLastEventWithNote()

createNewParticipant

public Participant createNewParticipant(ParticipantType type,
                                        java.lang.String code,
                                        Display display,
                                        int order)

participants

public java.util.Collection<Participant> participants()

participantsContainsKey

public boolean participantsContainsKey(java.lang.String code)

addMessage

public CommandExecutionResult 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 java.util.List<Event> events()

createImageBuilder

public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption)
                                throws java.io.IOException

Overrides:

createImageBuilder in class TitledDiagram

Throws:

java.io.IOException

exportDiagramInternal

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

Specified by:

exportDiagramInternal in class UmlDiagram

Throws:

java.io.IOException

exportDiagramGraphic

public final void exportDiagramGraphic(UGraphic ug,
                                       FileFormatOption fileFormatOption)

Specified by:

exportDiagramGraphic in interface Diagram

Overrides:

exportDiagramGraphic in class TitledDiagram

getTextMainBlock

protected final TextBlock getTextMainBlock(FileFormatOption fileFormatOption)

Specified by:

getTextMainBlock in class TitledDiagram

getActivatingMessage

public AbstractMessage getActivatingMessage()

activate

public java.lang.String activate(Participant p,
                                 LifeEventType lifeEventType,
                                 HColor backcolor)

activate

public java.lang.String activate(Participant p,
                                 LifeEventType lifeEventType,
                                 HColor backcolor,
                                 HColor linecolor)

grouping

public boolean grouping(java.lang.String title,
                        java.lang.String comment,
                        GroupingType type,
                        HColor backColorGeneral,
                        HColor backColorElement,
                        boolean parallel)

getDescription

public DiagramDescription getDescription()

autonumberGo

public final void autonumberGo(DottedNumber startingNumber,
                               int increment,
                               java.text.DecimalFormat decimalFormat)

autonumberStop

public final void autonumberStop()

getAutoNumber

public final AutoNumber getAutoNumber()

getNextMessageNumber

public java.lang.String getNextMessageNumber()

isShowFootbox

public boolean isShowFootbox()

setShowFootbox

public void setShowFootbox(boolean footbox)

boxStart

public void boxStart(Display comment,
                     HColor color,
                     Stereotype stereotype)

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(java.lang.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

addReference

public void addReference(Reference ref)

isOk

public boolean isOk()

Overrides:

isOk in class AbstractPSystem

checkFinalError

public java.lang.String checkFinalError()

Overrides:

checkFinalError in class AbstractPSystem

hideOrShow

public void hideOrShow(java.util.Set<EntityPortion> portions,
                       boolean show)

manageVariable

public Display manageVariable(Display labels)

linkAnchor

public CommandExecutionResult linkAnchor(java.lang.String anchor1,
                                         java.lang.String anchor2,
                                         java.lang.String message)

getLinkAnchors

public java.util.List<LinkAnchor> getLinkAnchors()

getDefaultMargins

public ClockwiseTopRightBottomLeft getDefaultMargins()

Overrides:

getDefaultMargins in class TitledDiagram