Class TimingDiagram
- java.lang.Object
-
- net.sourceforge.plantuml.AbstractPSystem
-
- net.sourceforge.plantuml.TitledDiagram
-
- net.sourceforge.plantuml.UmlDiagram
-
- net.sourceforge.plantuml.timingdiagram.TimingDiagram
-
- All Implemented Interfaces:
Annotated,Diagram,Clocks,WithSprite
public class TimingDiagram extends UmlDiagram implements Clocks
-
-
Field Summary
Fields Modifier and Type Field Description static doublemarginX1-
Fields inherited from class net.sourceforge.plantuml.TitledDiagram
FORCE_ELK, FORCE_SMETANA
-
-
Constructor Summary
Constructors Constructor Description TimingDiagram(UmlSource source)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddTime(TimeTick time, java.lang.String code)PlayerAnalogcreateAnalog(java.lang.String code, java.lang.String full, boolean compact, Stereotype stereotype)CommandExecutionResultcreateBinary(java.lang.String code, java.lang.String full, boolean compact, Stereotype stereotype)CommandExecutionResultcreateClock(java.lang.String code, java.lang.String full, int period, int pulse, int offset, boolean compact)CommandExecutionResultcreateRobustConcise(java.lang.String code, java.lang.String full, TimingStyle type, boolean compact, Stereotype stereotype, HColor backColor)TimeMessagecreateTimeMessage(Player player1, TimeTick time1, Player player2, TimeTick time2, java.lang.String label)protected ImageDataexportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormatOption)TimeTickgetClockValue(java.lang.String clockName, int nb)TimeTickgetCodeValue(java.lang.String code)DiagramDescriptiongetDescription()PlayergetLastPlayer()TimeTickgetNow()PlayergetPlayer(java.lang.String code)protected TextBlockgetTextMainBlock(FileFormatOption fileFormatOption)TimingFormatgetTimingFormatDate()voidgoCompactMode()CommandExecutionResulthighlight(TimeTick tickFrom, TimeTick tickTo, Display caption, Colors colors)voidscaleInPixels(long tick, long pixel)voidsetLastPlayer(Player player)CommandExecutionResultsetTimeAxisStategy(TimeAxisStategy newStrategy)voidupdateNow(TimeTick time)CommandExecutionResultuseDateFormat(java.lang.String dateFormat)-
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, createImageBuilder, exportDiagramGraphic, getCaption, getCurrentStyleBuilder, getDefaultMargins, 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
checkFinalError, executeCommand, exportDiagram, getMetadata, getNamespaceSeparator, getNbImages, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, hasUrl, isOk, 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, exportDiagramGraphic, getMetadata, getNbImages, getSource, getSplitPagesHorizontal, getSplitPagesVertical, getTitleDisplay, hasUrl
-
Methods inherited from interface net.sourceforge.plantuml.WithSprite
addSprite
-
-
-
-
Field Detail
-
marginX1
public static final double marginX1
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TimingDiagram
public TimingDiagram(UmlSource source)
-
-
Method Detail
-
getDescription
public DiagramDescription getDescription()
- Specified by:
getDescriptionin interfaceDiagram
-
exportDiagramInternal
protected ImageData exportDiagramInternal(java.io.OutputStream os, int index, FileFormatOption fileFormatOption) throws java.io.IOException
- Specified by:
exportDiagramInternalin classUmlDiagram- Throws:
java.io.IOException
-
getTextMainBlock
protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption)
- Specified by:
getTextMainBlockin classTitledDiagram
-
createRobustConcise
public CommandExecutionResult createRobustConcise(java.lang.String code, java.lang.String full, TimingStyle type, boolean compact, Stereotype stereotype, HColor backColor)
-
createClock
public CommandExecutionResult createClock(java.lang.String code, java.lang.String full, int period, int pulse, int offset, boolean compact)
-
createAnalog
public PlayerAnalog createAnalog(java.lang.String code, java.lang.String full, boolean compact, Stereotype stereotype)
-
createBinary
public CommandExecutionResult createBinary(java.lang.String code, java.lang.String full, boolean compact, Stereotype stereotype)
-
createTimeMessage
public TimeMessage createTimeMessage(Player player1, TimeTick time1, Player player2, TimeTick time2, java.lang.String label)
-
addTime
public void addTime(TimeTick time, java.lang.String code)
-
getCodeValue
public TimeTick getCodeValue(java.lang.String code)
- Specified by:
getCodeValuein interfaceClocks
-
updateNow
public void updateNow(TimeTick time)
-
getPlayer
public Player getPlayer(java.lang.String code)
-
getClockValue
public TimeTick getClockValue(java.lang.String clockName, int nb)
- Specified by:
getClockValuein interfaceClocks
-
setLastPlayer
public void setLastPlayer(Player player)
-
getLastPlayer
public Player getLastPlayer()
-
scaleInPixels
public void scaleInPixels(long tick, long pixel)
-
setTimeAxisStategy
public CommandExecutionResult setTimeAxisStategy(TimeAxisStategy newStrategy)
-
highlight
public CommandExecutionResult highlight(TimeTick tickFrom, TimeTick tickTo, Display caption, Colors colors)
-
goCompactMode
public void goCompactMode()
-
useDateFormat
public CommandExecutionResult useDateFormat(java.lang.String dateFormat)
-
getTimingFormatDate
public TimingFormat getTimingFormatDate()
- Specified by:
getTimingFormatDatein interfaceClocks
-
-