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 Description SequenceDiagram(UmlSource source, java.util.Map<java.lang.String,java.lang.String> skinParam)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Stringactivate(Participant p, LifeEventType lifeEventType, HColor backcolor)java.lang.Stringactivate(Participant p, LifeEventType lifeEventType, HColor backcolor, HColor linecolor)CommandExecutionResultaddMessage(AbstractMessage m)voidaddNote(Note n, boolean tryMerge)voidaddReference(Reference ref)voidautonumberGo(DottedNumber startingNumber, int increment, java.text.DecimalFormat decimalFormat)voidautonumberStop()voidboxStart(Display comment, HColor color, Stereotype stereotype)java.lang.StringcheckFinalError()ImageBuildercreateImageBuilder(FileFormatOption fileFormatOption)ParticipantcreateNewParticipant(ParticipantType type, java.lang.String code, Display display, int order)voiddelay(Display strings)voiddivider(Display strings)voidendBox()java.util.List<Event>events()voidexportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption)protected ImageDataexportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormat)AbstractMessagegetActivatingMessage()intgetAutonewpage()AutoNumbergetAutoNumber()ClockwiseTopRightBottomLeftgetDefaultMargins()DiagramDescriptiongetDescription()ParticipantEnglobergetEnglober(Participant p)EventWithDeactivategetLastEventWithDeactivate()EventWithNotegetLastEventWithNote()java.util.List<LinkAnchor>getLinkAnchors()intgetNbImages()Number of images in this diagram (usually, 1)java.lang.StringgetNextMessageNumber()ParticipantgetOrCreateParticipant(java.lang.String code)Deprecated.ParticipantgetOrCreateParticipant(java.lang.String code, Display display)protected TextBlockgetTextMainBlock(FileFormatOption fileFormatOption)booleangrouping(java.lang.String title, java.lang.String comment, GroupingType type, HColor backColorGeneral, HColor backColorElement, boolean parallel)booleanhasUrl()Check if the Diagram have some links.voidhideOrShow(java.util.Set<EntityPortion> portions, boolean show)voidhspace()voidhspace(int pixel)voidignoreNewpage()booleanisAutoactivate()booleanisBoxPending()booleanisHideUnlinkedData()booleanisOk()booleanisShowFootbox()CommandExecutionResultlinkAnchor(java.lang.String anchor1, java.lang.String anchor2, java.lang.String message)DisplaymanageVariable(Display labels)voidnewpage(Display strings)java.util.Collection<Participant>participants()booleanparticipantsContainsKey(java.lang.String code)voidputParticipantInLast(java.lang.String code)voidremoveHiddenParticipants()voidsetAutoactivate(boolean autoactivate)voidsetAutonewpage(int autonewpage)voidsetHideUnlinkedData(boolean hideUnlinkedData)voidsetShowFootbox(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.core.Diagram
exportDiagram, getMetadata, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay
-
Methods inherited from interface net.sourceforge.plantuml.WithSprite
addSprite
-
-
-
-
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:
createImageBuilderin classTitledDiagram- Throws:
java.io.IOException
-
exportDiagramInternal
protected ImageData exportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormat) throws java.io.IOException
- Specified by:
exportDiagramInternalin classUmlDiagram- Throws:
java.io.IOException
-
exportDiagramGraphic
public final void exportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption)
- Specified by:
exportDiagramGraphicin interfaceDiagram- Overrides:
exportDiagramGraphicin classTitledDiagram
-
getTextMainBlock
protected final TextBlock getTextMainBlock(FileFormatOption fileFormatOption)
- Specified by:
getTextMainBlockin classTitledDiagram
-
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:DiagramNumber of images in this diagram (usually, 1)- Specified by:
getNbImagesin interfaceDiagram- Overrides:
getNbImagesin classAbstractPSystem- 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:DiagramCheck if the Diagram have some links.- Specified by:
hasUrlin interfaceDiagram- Overrides:
hasUrlin classAbstractPSystem
-
addReference
public void addReference(Reference ref)
-
isOk
public boolean isOk()
- Overrides:
isOkin classAbstractPSystem
-
checkFinalError
public java.lang.String checkFinalError()
- Overrides:
checkFinalErrorin classAbstractPSystem
-
hideOrShow
public void hideOrShow(java.util.Set<EntityPortion> portions, boolean show)
-
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:
getDefaultMarginsin classTitledDiagram
-
-