net.sourceforge.plantuml.skin

Class SkinParam

java.lang.Object

net.sourceforge.plantuml.skin.SkinParam

All Implemented Interfaces:

SpriteContainer, ISkinParam, ISkinSimple, SvgCharSizeHack

public class SkinParam
extends java.lang.Object
implements ISkinParam

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PRESERVE_ASPECT_RATIO

Fields inherited from interface net.sourceforge.plantuml.style.ISkinParam

SWIMLANE_WIDTH_SAME

Fields inherited from interface net.sourceforge.plantuml.text.SvgCharSizeHack

NO_HACK

Method Summary

Modifier and Type	Method and Description
ActorStyle	actorStyle()
void	addSprite(java.lang.String name, Sprite sprite)
void	applyPendingStyleMigration()
Arrows	arrows()
int	classAttributeIconSize()
int	colorArrowSeparationSpace()
ComponentStyle	componentStyle()
void	copyAllFrom(java.util.Map<java.lang.String,java.lang.String> other)
static SkinParam	create(UmlDiagramType type)
boolean	displayGenericWithOldFashion()
boolean	fixCircleLabelOverlapping()
boolean	forceSequenceParticipantUnderlined()
java.util.Collection<java.lang.String>	getAllSpriteNames()
HColor	getBackgroundColor()
char	getCircledCharacter(Stereotype stereotype)
int	getCircledCharacterRadius()
Colors	getColors(ColorParam param, Stereotype stereotype)
ConditionEndStyle	getConditionEndStyle()
ConditionStyle	getConditionStyle()
StyleBuilder	getCurrentStyleBuilder()
StyleBuilder	getCurrentStyleBuilderInternal()
java.lang.String	getDefaultSkin()
HorizontalAlignment	getDefaultTextAlignment(HorizontalAlignment defaultValue)
double	getDiagonalCorner(CornerParam param, Stereotype stereotype)
DotSplines	getDotSplines()
int	getDpi()
UFont	getFont(Stereotype stereotype, boolean inPackageTitle, FontParam... fontParam)
HColor	getFontHtmlColor(Stereotype stereotype, FontParam... param)
HorizontalAlignment	getHorizontalAlignment(AlignmentParam param, ArrowDirection arrowDirection, boolean isReverseDefine, HorizontalAlignment overrideDefault)
HColor	getHtmlColor(ColorParam param, Stereotype stereotype, boolean clickable)
HColor	getHyperlinkColor()
HColorSet	getIHtmlColorSet()
LengthAdjust	getlengthAdjust()
java.lang.String	getMonospacedFamily()
double	getNodesep()
double	getPadding()
double	getPadding(PaddingParam param)
double	getParamSameClassWidth()
static java.util.Collection<java.lang.String>	getPossibleValues()
java.lang.String	getPreserveAspectRatio()
Rankdir	getRankdir()
double	getRanksep()
double	getRoundCorner(CornerParam param, Stereotype stereotype)
SplitParam	getSplitParam()
Sprite	getSprite(java.lang.String name)
HorizontalAlignment	getStereotypeAlignment()
java.lang.String	getSvgLinkTarget()
int	getTabSize()
UStroke	getThickness(LineParam param, Stereotype stereotype)
TikzFontDistortion	getTikzFontDistortion()
UmlDiagramType	getUmlDiagramType()
java.lang.String	getValue(java.lang.String key)
java.lang.String	getValue(java.lang.String key, java.lang.String defaultValue)
int	groupInheritance()
Guillemet	guillemet()
boolean	handwritten()
HColor	hoverPathColor()
boolean	isUseVizJs()
int	maxAsciiMessageLength()
LineBreakStrategy	maxMessageSize()
void	muteStyle(Style modifiedStyle)
static SkinParam	noShadowing(UmlDiagramType type)
PackageStyle	packageStyle()
boolean	responseMessageBelowArrow()
boolean	sameClassWidth()
Padder	sequenceDiagramPadder()
void	setDefaultSkin(java.lang.String newSkin)
void	setParam(java.lang.String key, java.lang.String value)
void	setParamSameClassWidth(double width)
void	setRankdir(Rankdir rankdir)
void	setSvgSize(java.lang.String origin, java.lang.String sizeToUse)
void	setUseVizJs(boolean useVizJs)
boolean	shadowing(Stereotype stereotype)
boolean	shadowingForNote(Stereotype stereotype)
SheetBuilder	sheet(FontConfiguration fontConfiguration, HorizontalAlignment horizontalAlignment, CreoleMode creoleMode)
SheetBuilder	sheet(FontConfiguration fontConfiguration, HorizontalAlignment horizontalAlignment, CreoleMode creoleMode, FontConfiguration stereo)
boolean	stereotypePositionTop()
boolean	strictUmlStyle()
boolean	svgDimensionStyle()
boolean	swimlanes()
int	swimlaneWidth()
LineBreakStrategy	swimlaneWrapTitleWidth()
java.lang.String	transformStringForSizeHack(java.lang.String s)
boolean	useOctagonForActivity(Stereotype stereotype)
boolean	useRankSame()
boolean	useSwimlanes(UmlDiagramType type)
UStroke	useUnderlineForHyperlink()
java.util.Map<java.lang.String,java.lang.String>	values()
static int	zeroMargin(int defaultValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PRESERVE_ASPECT_RATIO

public static final java.lang.String DEFAULT_PRESERVE_ASPECT_RATIO

See Also:

Constant Field Values

Method Detail

getCurrentStyleBuilder

public StyleBuilder getCurrentStyleBuilder()

Specified by:

getCurrentStyleBuilder in interface ISkinParam

muteStyle

public void muteStyle(Style modifiedStyle)

Specified by:

muteStyle in interface ISkinParam

getDefaultSkin

public java.lang.String getDefaultSkin()

Specified by:

getDefaultSkin in interface ISkinParam

setDefaultSkin

public void setDefaultSkin(java.lang.String newSkin)

Specified by:

setDefaultSkin in interface ISkinParam

getCurrentStyleBuilderInternal

public StyleBuilder getCurrentStyleBuilderInternal()
                                            throws java.io.IOException,
                                                   StyleParsingException

Throws:

java.io.IOException

StyleParsingException

zeroMargin

public static int zeroMargin(int defaultValue)

copyAllFrom

public void copyAllFrom(java.util.Map<java.lang.String,java.lang.String> other)

Specified by:

copyAllFrom in interface ISkinSimple

values

public java.util.Map<java.lang.String,java.lang.String> values()

Specified by:

values in interface ISkinSimple

setParam

public void setParam(java.lang.String key,
                     java.lang.String value)

applyPendingStyleMigration

public void applyPendingStyleMigration()

create

public static SkinParam create(UmlDiagramType type)

noShadowing

public static SkinParam noShadowing(UmlDiagramType type)

getHyperlinkColor

public HColor getHyperlinkColor()

Specified by:

getHyperlinkColor in interface ISkinParam

getBackgroundColor

public HColor getBackgroundColor()

Specified by:

getBackgroundColor in interface ISkinParam

getValue

public java.lang.String getValue(java.lang.String key)

Specified by:

getValue in interface ISkinSimple

getValue

public java.lang.String getValue(java.lang.String key,
                                 java.lang.String defaultValue)

getHtmlColor

public HColor getHtmlColor(ColorParam param,
                           Stereotype stereotype,
                           boolean clickable)

Specified by:

getHtmlColor in interface ISkinParam

getCircledCharacter

public char getCircledCharacter(Stereotype stereotype)

Specified by:

getCircledCharacter in interface ISkinParam

getColors

public Colors getColors(ColorParam param,
                        Stereotype stereotype)
                 throws NoSuchColorException

Specified by:

getColors in interface ISkinParam

Throws:

NoSuchColorException

getFontHtmlColor

public HColor getFontHtmlColor(Stereotype stereotype,
                               FontParam... param)

Specified by:

getFontHtmlColor in interface ISkinParam

getFont

public UFont getFont(Stereotype stereotype,
                     boolean inPackageTitle,
                     FontParam... fontParam)

Specified by:

getFont in interface ISkinParam

getCircledCharacterRadius

public int getCircledCharacterRadius()

Specified by:

getCircledCharacterRadius in interface ISkinParam

classAttributeIconSize

public int classAttributeIconSize()

Specified by:

classAttributeIconSize in interface ISkinParam

getPossibleValues

public static java.util.Collection<java.lang.String> getPossibleValues()

getDpi

public int getDpi()

Specified by:

getDpi in interface ISkinSimple

getDotSplines

public DotSplines getDotSplines()

Specified by:

getDotSplines in interface ISkinParam

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment(AlignmentParam param,
                                                  ArrowDirection arrowDirection,
                                                  boolean isReverseDefine,
                                                  HorizontalAlignment overrideDefault)

Specified by:

getHorizontalAlignment in interface ISkinParam

getDefaultTextAlignment

public HorizontalAlignment getDefaultTextAlignment(HorizontalAlignment defaultValue)

Specified by:

getDefaultTextAlignment in interface ISkinParam

getStereotypeAlignment

public HorizontalAlignment getStereotypeAlignment()

Specified by:

getStereotypeAlignment in interface ISkinParam

shadowing

public boolean shadowing(Stereotype stereotype)

Specified by:

shadowing in interface ISkinParam

shadowingForNote

public boolean shadowingForNote(Stereotype stereotype)

Specified by:

shadowingForNote in interface ISkinParam

getAllSpriteNames

public java.util.Collection<java.lang.String> getAllSpriteNames()

Specified by:

getAllSpriteNames in interface ISkinParam

addSprite

public void addSprite(java.lang.String name,
                      Sprite sprite)

getSprite

public Sprite getSprite(java.lang.String name)

Specified by:

getSprite in interface SpriteContainer

packageStyle

public PackageStyle packageStyle()

Specified by:

packageStyle in interface ISkinParam

componentStyle

public ComponentStyle componentStyle()

Specified by:

componentStyle in interface ISkinParam

stereotypePositionTop

public boolean stereotypePositionTop()

Specified by:

stereotypePositionTop in interface ISkinParam

useSwimlanes

public boolean useSwimlanes(UmlDiagramType type)

Specified by:

useSwimlanes in interface ISkinParam

swimlanes

public boolean swimlanes()

getNodesep

public double getNodesep()

Specified by:

getNodesep in interface ISkinParam

getRanksep

public double getRanksep()

Specified by:

getRanksep in interface ISkinParam

getDiagonalCorner

public double getDiagonalCorner(CornerParam param,
                                Stereotype stereotype)

Specified by:

getDiagonalCorner in interface ISkinParam

getRoundCorner

public double getRoundCorner(CornerParam param,
                             Stereotype stereotype)

Specified by:

getRoundCorner in interface ISkinParam

getThickness

public UStroke getThickness(LineParam param,
                            Stereotype stereotype)

Specified by:

getThickness in interface ISkinParam

maxMessageSize

public LineBreakStrategy maxMessageSize()

Specified by:

maxMessageSize in interface ISkinParam

swimlaneWrapTitleWidth

public LineBreakStrategy swimlaneWrapTitleWidth()

Specified by:

swimlaneWrapTitleWidth in interface ISkinParam

strictUmlStyle

public boolean strictUmlStyle()

Specified by:

strictUmlStyle in interface ISkinParam

forceSequenceParticipantUnderlined

public boolean forceSequenceParticipantUnderlined()

Specified by:

forceSequenceParticipantUnderlined in interface ISkinParam

getConditionStyle

public ConditionStyle getConditionStyle()

Specified by:

getConditionStyle in interface ISkinParam

getConditionEndStyle

public ConditionEndStyle getConditionEndStyle()

Specified by:

getConditionEndStyle in interface ISkinParam

sameClassWidth

public boolean sameClassWidth()

Specified by:

sameClassWidth in interface ISkinParam

getRankdir

public final Rankdir getRankdir()

Specified by:

getRankdir in interface ISkinParam

setRankdir

public final void setRankdir(Rankdir rankdir)

useOctagonForActivity

public boolean useOctagonForActivity(Stereotype stereotype)

Specified by:

useOctagonForActivity in interface ISkinParam

getIHtmlColorSet

public HColorSet getIHtmlColorSet()

Specified by:

getIHtmlColorSet in interface ISkinSimple

useUnderlineForHyperlink

public UStroke useUnderlineForHyperlink()

Specified by:

useUnderlineForHyperlink in interface ISkinParam

groupInheritance

public int groupInheritance()

Specified by:

groupInheritance in interface ISkinParam

guillemet

public Guillemet guillemet()

Specified by:

guillemet in interface SpriteContainer

Specified by:

guillemet in interface ISkinParam

handwritten

public boolean handwritten()

Specified by:

handwritten in interface ISkinParam

getSvgLinkTarget

public java.lang.String getSvgLinkTarget()

Specified by:

getSvgLinkTarget in interface ISkinParam

getPreserveAspectRatio

public java.lang.String getPreserveAspectRatio()

Specified by:

getPreserveAspectRatio in interface ISkinParam

getMonospacedFamily

public java.lang.String getMonospacedFamily()

Specified by:

getMonospacedFamily in interface ISkinSimple

getTabSize

public int getTabSize()

Specified by:

getTabSize in interface ISkinParam

Specified by:

getTabSize in interface ISkinSimple

maxAsciiMessageLength

public int maxAsciiMessageLength()

Specified by:

maxAsciiMessageLength in interface ISkinParam

colorArrowSeparationSpace

public int colorArrowSeparationSpace()

Specified by:

colorArrowSeparationSpace in interface ISkinParam

getSplitParam

public SplitParam getSplitParam()

Specified by:

getSplitParam in interface ISkinParam

swimlaneWidth

public int swimlaneWidth()

Specified by:

swimlaneWidth in interface ISkinParam

getUmlDiagramType

public UmlDiagramType getUmlDiagramType()

Specified by:

getUmlDiagramType in interface ISkinParam

hoverPathColor

public HColor hoverPathColor()

Specified by:

hoverPathColor in interface ISkinParam

getPadding

public double getPadding()

Specified by:

getPadding in interface ISkinSimple

getPadding

public double getPadding(PaddingParam param)

Specified by:

getPadding in interface ISkinParam

useRankSame

public boolean useRankSame()

Specified by:

useRankSame in interface ISkinParam

displayGenericWithOldFashion

public boolean displayGenericWithOldFashion()

Specified by:

displayGenericWithOldFashion in interface ISkinParam

responseMessageBelowArrow

public boolean responseMessageBelowArrow()

Specified by:

responseMessageBelowArrow in interface ISkinParam

getTikzFontDistortion

public TikzFontDistortion getTikzFontDistortion()

Specified by:

getTikzFontDistortion in interface ISkinParam

svgDimensionStyle

public boolean svgDimensionStyle()

Specified by:

svgDimensionStyle in interface ISkinParam

fixCircleLabelOverlapping

public boolean fixCircleLabelOverlapping()

Specified by:

fixCircleLabelOverlapping in interface ISkinParam

setUseVizJs

public void setUseVizJs(boolean useVizJs)

Specified by:

setUseVizJs in interface ISkinParam

isUseVizJs

public boolean isUseVizJs()

Specified by:

isUseVizJs in interface ISkinParam

sequenceDiagramPadder

public Padder sequenceDiagramPadder()

Specified by:

sequenceDiagramPadder in interface ISkinParam

actorStyle

public ActorStyle actorStyle()

Specified by:

actorStyle in interface ISkinParam

setSvgSize

public void setSvgSize(java.lang.String origin,
                       java.lang.String sizeToUse)

Specified by:

setSvgSize in interface ISkinParam

transformStringForSizeHack

public java.lang.String transformStringForSizeHack(java.lang.String s)

Specified by:

transformStringForSizeHack in interface SvgCharSizeHack

getlengthAdjust

public LengthAdjust getlengthAdjust()

Specified by:

getlengthAdjust in interface ISkinParam

setParamSameClassWidth

public void setParamSameClassWidth(double width)

getParamSameClassWidth

public final double getParamSameClassWidth()

Specified by:

getParamSameClassWidth in interface ISkinParam

sheet

public SheetBuilder sheet(FontConfiguration fontConfiguration,
                          HorizontalAlignment horizontalAlignment,
                          CreoleMode creoleMode)

Specified by:

sheet in interface ISkinSimple

sheet

public SheetBuilder sheet(FontConfiguration fontConfiguration,
                          HorizontalAlignment horizontalAlignment,
                          CreoleMode creoleMode,
                          FontConfiguration stereo)

Specified by:

sheet in interface ISkinSimple

arrows

public Arrows arrows()

Specified by:

arrows in interface ISkinParam