Package net.sourceforge.plantuml.klimt.font

Class FontConfiguration

java.lang.Object

net.sourceforge.plantuml.klimt.font.FontConfiguration

public class FontConfiguration
extends Object

Method Summary

Modifier and Type	Method	Description
FontConfiguration	add(FontStyle style)
FontConfiguration	adjustColorForBackground(UGraphic ug)
FontConfiguration	bigger(double delta)
static FontConfiguration	blackBlueTrue(UFont font)
FontConfiguration	bold()
FontConfiguration	changeAttributes(SvgAttributes toBeAdded)
FontConfiguration	changeColor(HColor newHtmlColor)
FontConfiguration	changeExtendedColor(HColor newExtendedColor)
FontConfiguration	changeFamily(String family)	Returns a new FontConfiguration identical to this one except that the font family (typeface name) has been replaced.
FontConfiguration	changeFontPosition(FontPosition fontPosition)
FontConfiguration	changeSize(float size)
boolean	containsStyle(FontStyle style)
static FontConfiguration	create(UFont font, HColor color, HColor hyperlinkColor, UStroke hyperlinkUnderlineStroke)
static FontConfiguration	create(UFont font, HColor color, HColor hyperlinkColor, UStroke hyperlinkUnderlineStroke, int tabSize)
static FontConfiguration	create(ISkinParam skinParam, FontParam fontParam, Stereotype stereo)
static FontConfiguration	create(ISkinParam skinParam, Style style)
static FontConfiguration	create(ISkinParam skinParam, Style style, Colors colors)
boolean	equals(Object obj)
FontConfiguration	forceFont(UFont newFont, HColor htmlColorForStereotype)
Map<String,String>	getAttributes()
HColor	getColor()
HColor	getExtendedColor()
UFont	getFont()
UFontFace	getFontFace()	Returns the UFontFace (weight + italic axis) carried by the current font of this configuration.
double	getSize2D()
int	getSpace()
int	getTabSize()
UStroke	getUnderlineStroke()
int	hashCode()
FontConfiguration	hyperlink()
FontConfiguration	italic()
FontConfiguration	mute(Colors colors)
FontConfiguration	remove(FontStyle style)
FontConfiguration	resetFont()
String	toString()
String	toStringDebug()
FontConfiguration	unbold()
FontConfiguration	underline()
FontConfiguration	unitalic()
FontConfiguration	wave(HColor color)
FontConfiguration	withFontFace(UFontFace face)	Returns a new FontConfiguration whose underlying font has been updated to reflect the supplied UFontFace (weight + italic axis).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

create

public static FontConfiguration create(UFont font,
 HColor color,
 HColor hyperlinkColor,
 UStroke hyperlinkUnderlineStroke,
 int tabSize)

blackBlueTrue

public static FontConfiguration blackBlueTrue(UFont font)

getFont

public UFont getFont()

getFontFace

public UFontFace getFontFace()

Returns the UFontFace (weight + italic axis) carried by the current font of this configuration. The face is always consistent with the underlying font: changing the font (e.g. via withFontFace(UFontFace) or changeFamily(String)) automatically updates the returned value.

Returns:

the font face; never null

withFontFace

public FontConfiguration withFontFace(UFontFace face)

Returns a new FontConfiguration whose underlying font has been updated to reflect the supplied UFontFace (weight + italic axis). All other configuration properties (colour, size, tab stop, etc.) are preserved unchanged.

This is the preferred way to change bold/italic/weight instead of the legacy bold() / italic() helpers, because it preserves CSS font-weight information beyond the binary bold/non-bold distinction.

Parameters:

face - the new face to apply; if null the current face is kept

Returns:

a new FontConfiguration with the updated face

toStringDebug

public String toStringDebug()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

mute

public FontConfiguration mute(Colors colors)

create

public static FontConfiguration create(ISkinParam skinParam,
 FontParam fontParam,
 Stereotype stereo)

create

public static FontConfiguration create(ISkinParam skinParam,
 Style style)

create

public static FontConfiguration create(ISkinParam skinParam,
 Style style,
 Colors colors)

toString

public String toString()

Overrides:

toString in class Object

create

public static FontConfiguration create(UFont font,
 HColor color,
 HColor hyperlinkColor,
 UStroke hyperlinkUnderlineStroke)

forceFont

public FontConfiguration forceFont(UFont newFont,
 HColor htmlColorForStereotype)

changeAttributes

public FontConfiguration changeAttributes(SvgAttributes toBeAdded)

changeColor

public FontConfiguration changeColor(HColor newHtmlColor)

changeExtendedColor

public FontConfiguration changeExtendedColor(HColor newExtendedColor)

changeSize

public FontConfiguration changeSize(float size)

bigger

public FontConfiguration bigger(double delta)

changeFontPosition

public FontConfiguration changeFontPosition(FontPosition fontPosition)

changeFamily

public FontConfiguration changeFamily(String family)

Returns a new FontConfiguration identical to this one except that the font family (typeface name) has been replaced. The current UFontFace (weight + italic axis) and point size are preserved.

Parameters:

family - the new font-family string (e.g. "Arial")

Returns:

a new FontConfiguration with the updated family

resetFont

public FontConfiguration resetFont()

add

public FontConfiguration add(FontStyle style)

italic

public FontConfiguration italic()

bold

public FontConfiguration bold()

unbold

public FontConfiguration unbold()

unitalic

public FontConfiguration unitalic()

underline

public FontConfiguration underline()

wave

public FontConfiguration wave(HColor color)

hyperlink

public FontConfiguration hyperlink()

remove

public FontConfiguration remove(FontStyle style)

adjustColorForBackground

public FontConfiguration adjustColorForBackground(UGraphic ug)

getColor

public HColor getColor()

getExtendedColor

public HColor getExtendedColor()

containsStyle

public boolean containsStyle(FontStyle style)

getSpace

public int getSpace()

getAttributes

public Map<String,String> getAttributes()

getSize2D

public double getSize2D()

getTabSize

public int getTabSize()

getUnderlineStroke

public UStroke getUnderlineStroke()