Package net.sourceforge.plantuml.timingdiagram

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, WarningHandler, WithSprite

public class TimingDiagram
extends UmlDiagram
implements Clocks

Field Summary

Fields

Modifier and Type	Field	Description
static final double	marginX1

Fields inherited from class net.sourceforge.plantuml.TitledDiagram

FORCE_ELK, FORCE_SMETANA

Constructor Summary

Constructors

Constructor	Description
TimingDiagram(UmlSource source, PreprocessingArtifact preprocessing)

Method Summary

Modifier and Type	Method	Description
void	addTime(TimeTick time, String code)
PlayerAnalog	createAnalog(String code, String full, boolean compact, Stereotype stereotype)
CommandExecutionResult	createBinary(String code, String full, boolean compact, Stereotype stereotype)
CommandExecutionResult	createClock(String code, String full, int period, int pulse, int offset, boolean compact, Stereotype stereotype)
CommandExecutionResult	createRobustConcise(String code, String full, TimingStyle type, boolean compact, Stereotype stereotype, HColor backColor)
TimeMessage	createTimeMessage(Player player1, TimeTick time1, Player player2, TimeTick time2, String label)
protected ImageData	exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
TimeTick	getClockValue(String clockName, int nb)
TimeTick	getCodeValue(String code)
DiagramDescription	getDescription()
Player	getLastPlayer()
TimeTick	getNow()
Player	getPlayer(String code)
protected TextBlock	getTextMainBlock(FileFormatOption fileFormatOption)
TimingFormat	getTimingFormatDate()
void	goCompactMode()
CommandExecutionResult	highlight(TimeTick tickFrom, TimeTick tickTo, Display caption, Colors colors)
void	scaleInPixels(long tick, long pixel)
void	setLastPlayer(Player player)
CommandExecutionResult	setTimeAxisStategy(TimeAxisStategy newStrategy)
void	updateNow(TimeTick time)
CommandExecutionResult	useDateFormat(String dateFormat)

Methods inherited from class net.sourceforge.plantuml.UmlDiagram

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

Methods inherited from class net.sourceforge.plantuml.TitledDiagram

addSprite, addWarning, calculateBackColor, createImageBuilder, exportDiagramGraphic, getCaption, getCurrentStyleBuilder, getDefaultMargins, getFooter, getHeader, getLegend, getMainFrame, getPragma, getSkinParam, getTitle, getTitleDisplay, getUmlDiagramType, getWarnings, 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, getPreprocessingArtifact, getRequiredPass, getScale, getSource, getSplitPagesHorizontal, getSplitPagesVertical, hasUrl, isOk, makeDiagramReady, seed, setNamespaceSeparator, setScale, setSplitPagesHorizontal, setSplitPagesVertical, startingPass

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 Details

marginX1

public static final double marginX1

See Also:

• Constant Field Values

Constructor Details

TimingDiagram

public TimingDiagram(UmlSource source,
 PreprocessingArtifact preprocessing)

Method Details

getDescription

public DiagramDescription getDescription()

Specified by:

getDescription in interface Diagram

exportDiagramInternal

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

Specified by:

exportDiagramInternal in class UmlDiagram

Throws:

IOException

getTextMainBlock

protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption)

Specified by:

getTextMainBlock in class TitledDiagram

createRobustConcise

public CommandExecutionResult createRobustConcise(String code,
 String full,
 TimingStyle type,
 boolean compact,
 Stereotype stereotype,
 HColor backColor)

createClock

public CommandExecutionResult createClock(String code,
 String full,
 int period,
 int pulse,
 int offset,
 boolean compact,
 Stereotype stereotype)

createAnalog

public PlayerAnalog createAnalog(String code,
 String full,
 boolean compact,
 Stereotype stereotype)

createBinary

public CommandExecutionResult createBinary(String code,
 String full,
 boolean compact,
 Stereotype stereotype)

createTimeMessage

public TimeMessage createTimeMessage(Player player1,
 TimeTick time1,
 Player player2,
 TimeTick time2,
 String label)

addTime

public void addTime(TimeTick time,
 String code)

getCodeValue

public TimeTick getCodeValue(String code)

Specified by:

getCodeValue in interface Clocks

updateNow

public void updateNow(TimeTick time)

getPlayer

public Player getPlayer(String code)

getNow

public TimeTick getNow()

Specified by:

getNow in interface Clocks

getClockValue

public TimeTick getClockValue(String clockName,
 int nb)

Specified by:

getClockValue in interface Clocks

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(String dateFormat)

getTimingFormatDate

public TimingFormat getTimingFormatDate()

Specified by:

getTimingFormatDate in interface Clocks