Package net.sourceforge.plantuml.timingdiagram

Class Player

java.lang.Object

net.sourceforge.plantuml.timingdiagram.Player

All Implemented Interfaces:

TimeProjected

Direct Known Subclasses:

PlayerAnalog, PlayerBinary, PlayerClock, PlayerRobustConcise

public abstract class Player
extends Object
implements TimeProjected

Field Summary

Fields

Modifier and Type	Field	Description
protected final TimingRuler	ruler
protected final ISkinParam	skinParam
protected final Stereotype	stereotype
protected int	suggestedHeight

Constructor Summary

Constructors

Constructor	Description
Player(String title, ISkinParam skinParam, TimingRuler ruler, boolean compact, Stereotype stereotype, HColor generalBackgroundColor)

Method Summary

Modifier and Type	Method	Description
abstract void	addNote(TimeTick now, Display note, Position position)
abstract void	createConstraint(TimeTick tick1, TimeTick tick2, String message, ArrowConfiguration config)
abstract void	defineState(String stateCode, String label)
protected final Fashion	getContext()
protected final FontConfiguration	getFontConfiguration()
abstract double	getFullHeight(StringBounder stringBounder)
HColor	getGeneralBackgroundColor()
abstract TextBlock	getPart1(double fullAvailableWidth, double specialVSpace)
abstract UDrawable	getPart2()
protected final UStroke	getStroke()
protected final Style	getStyle()
protected abstract StyleSignature	getStyleSignature()
protected final TextBlock	getTitle()
boolean	isCompact()
final void	setHeight(int height)
abstract void	setState(TimeTick now, String comment, Colors color, String... states)

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.timingdiagram.TimeProjected

getTimeProjection

Field Details

skinParam

protected final ISkinParam skinParam

ruler

protected final TimingRuler ruler

suggestedHeight

protected int suggestedHeight

stereotype

protected final Stereotype stereotype

Constructor Details

Player

public Player(String title,
 ISkinParam skinParam,
 TimingRuler ruler,
 boolean compact,
 Stereotype stereotype,
 HColor generalBackgroundColor)

Method Details

isCompact

public boolean isCompact()

getGeneralBackgroundColor

public HColor getGeneralBackgroundColor()

getStyleSignature

protected abstract StyleSignature getStyleSignature()

getStyle

protected final Style getStyle()

getFontConfiguration

protected final FontConfiguration getFontConfiguration()

getStroke

protected final UStroke getStroke()

getContext

protected final Fashion getContext()

getTitle

protected final TextBlock getTitle()

addNote

public abstract void addNote(TimeTick now,
 Display note,
 Position position)

defineState

public abstract void defineState(String stateCode,
 String label)

setState

public abstract void setState(TimeTick now,
 String comment,
 Colors color,
 String... states)

createConstraint

public abstract void createConstraint(TimeTick tick1,
 TimeTick tick2,
 String message,
 ArrowConfiguration config)

getPart1

public abstract TextBlock getPart1(double fullAvailableWidth,
 double specialVSpace)

getPart2

public abstract UDrawable getPart2()

getFullHeight

public abstract double getFullHeight(StringBounder stringBounder)

setHeight

public final void setHeight(int height)