net.sourceforge.plantuml.klimt.font.FontConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this MIT license.
*
* The generated images can then be used without any reference to the MIT license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.klimt.font;
import java.util.EnumSet;
import java.util.Map;
import java.util.Objects;
import net.sourceforge.plantuml.klimt.SvgAttributes;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.color.ColorType;
import net.sourceforge.plantuml.klimt.color.Colors;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.skin.SkinParamUtils;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.Style;
public class FontConfiguration {
public static FontConfiguration create(UFont font, HColor color, HColor hyperlinkColor,
UStroke hyperlinkUnderlineStroke, int tabSize) {
return new FontConfiguration(getStyles(font), font, color, font, color, null, FontPosition.NORMAL,
SvgAttributes.empty(), hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public static FontConfiguration blackBlueTrue(UFont font) {
return create(font, HColors.BLACK.withDark(HColors.WHITE), HColors.BLUE, UStroke.simple(), 8);
}
private static EnumSet getStyles(UFont font) {
final boolean bold = font.isBold();
final boolean italic = font.isItalic();
if (bold && italic)
return EnumSet.of(FontStyle.ITALIC, FontStyle.BOLD);
if (bold)
return EnumSet.of(FontStyle.BOLD);
if (italic)
return EnumSet.of(FontStyle.ITALIC);
return EnumSet.noneOf(FontStyle.class);
}
private FontConfiguration(EnumSet styles, UFont motherFont, HColor motherColor, UFont currentFont,
HColor currentColor, HColor extendedColor, FontPosition fontPosition, SvgAttributes svgAttributes,
HColor hyperlinkColor, UStroke hyperlinkUnderlineStroke, int tabSize) {
this.styles = styles;
this.currentFont = currentFont;
this.motherFont = motherFont;
this.currentColor = currentColor;
this.motherColor = motherColor;
this.extendedColor = extendedColor;
this.fontPosition = fontPosition;
this.svgAttributes = svgAttributes;
this.hyperlinkColor = hyperlinkColor;
this.hyperlinkUnderlineStroke = hyperlinkUnderlineStroke;
this.tabSize = tabSize;
}
public UFont getFont() {
UFont result = currentFont;
for (FontStyle style : styles)
result = style.mutateFont(result);
return fontPosition.mute(result);
}
private final EnumSet styles;
private final UFont currentFont;
private final UFont motherFont;
private final HColor motherColor;
private final HColor currentColor;
private final HColor extendedColor;
private final FontPosition fontPosition;
private final SvgAttributes svgAttributes;
private final UStroke hyperlinkUnderlineStroke;
private final HColor hyperlinkColor;
private final int tabSize;
// ::comment when __HAXE__
public String toStringDebug() {
return getFont().toStringDebug() + " " + styles.toString();
// return "" + currentFont + " " + styles.toString() + currentColor + extendedColor + hyperlinkColor
// + hyperlinkUnderlineStroke + fontPosition + tabSize;
}
@Override
public int hashCode() {
return currentFont.hashCode()//
+ styles.hashCode() //
+ currentColor.hashCode()//
+ hashCode(extendedColor)//
+ hyperlinkColor.hashCode()//
+ hashCode(hyperlinkUnderlineStroke)//
+ fontPosition.hashCode() //
+ tabSize;
}
private int hashCode(Object obj) {
if (obj == null)
return 43;
return obj.hashCode();
}
private boolean same(Object obj1, Object obj2) {
if (obj1 == null && obj2 == null)
return true;
if (obj1 != null && obj2 != null)
return obj1.equals(obj2);
return false;
}
@Override
public boolean equals(Object obj) {
final FontConfiguration other = (FontConfiguration) obj;
return currentFont.equals(other.currentFont) && styles.equals(other.styles)
&& currentColor.equals(other.currentColor) && same(extendedColor, other.extendedColor)
&& hyperlinkColor.equals(other.hyperlinkColor)
&& same(hyperlinkUnderlineStroke, other.hyperlinkUnderlineStroke)
&& fontPosition.equals(other.fontPosition) && tabSize == other.tabSize;
}
public FontConfiguration mute(Colors colors) {
final HColor color = Objects.requireNonNull(colors).getColor(ColorType.TEXT);
if (color == null)
return this;
return changeColor(color);
}
public static FontConfiguration create(ISkinParam skinParam, FontParam fontParam, Stereotype stereo) {
return create(SkinParamUtils.getFont(skinParam, fontParam, stereo),
SkinParamUtils.getFontColor(skinParam, fontParam, stereo), skinParam.getHyperlinkColor(),
skinParam.useUnderlineForHyperlink(), skinParam.getTabSize());
}
public static FontConfiguration create(ISkinParam skinParam, Style style) {
return create(skinParam, style, null);
}
public static FontConfiguration create(ISkinParam skinParam, Style style, Colors colors) {
final HColor hyperlinkColor = style.value(PName.HyperLinkColor).asColor(skinParam.getIHtmlColorSet());
final UStroke hyperlinkUnderlineStroke = skinParam.useUnderlineForHyperlink();
HColor color = colors == null ? null : colors.getColor(ColorType.TEXT);
if (color == null)
color = style.value(PName.FontColor).asColor(skinParam.getIHtmlColorSet());
return create(style.getUFont(), color, hyperlinkColor, hyperlinkUnderlineStroke, skinParam.getTabSize());
}
@Override
public String toString() {
return styles.toString() + " " + currentColor;
}
public static FontConfiguration create(UFont font, HColor color, HColor hyperlinkColor,
UStroke hyperlinkUnderlineStroke) {
return create(font, color, hyperlinkColor, hyperlinkUnderlineStroke, 8);
}
// ---
public FontConfiguration forceFont(UFont newFont, HColor htmlColorForStereotype) {
if (newFont == null)
return add(FontStyle.ITALIC);
FontConfiguration result = new FontConfiguration(styles, newFont, motherColor, newFont, currentColor,
extendedColor, fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
if (htmlColorForStereotype != null)
result = result.changeColor(htmlColorForStereotype);
return result;
}
public FontConfiguration changeAttributes(SvgAttributes toBeAdded) {
return new FontConfiguration(styles, motherFont, motherColor, currentFont, currentColor, extendedColor,
fontPosition, svgAttributes.add(toBeAdded), hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
private FontConfiguration withHyperlink() {
return new FontConfiguration(styles, motherFont, motherColor, currentFont, hyperlinkColor, extendedColor,
fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration changeColor(HColor newHtmlColor) {
return new FontConfiguration(styles, motherFont, motherColor, currentFont, newHtmlColor, extendedColor,
fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration changeExtendedColor(HColor newExtendedColor) {
return new FontConfiguration(styles, motherFont, motherColor, currentFont, currentColor, newExtendedColor,
fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration changeSize(float size) {
return new FontConfiguration(styles, motherFont, motherColor, currentFont.withSize(size), currentColor,
extendedColor, fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration bigger(double delta) {
return changeSize((float) (currentFont.getSize() + delta));
}
public FontConfiguration changeFontPosition(FontPosition fontPosition) {
return new FontConfiguration(styles, motherFont, motherColor, currentFont, currentColor, extendedColor,
fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration changeFamily(String family) {
return new FontConfiguration(styles, motherFont, motherColor,
UFont.build(family, currentFont.getStyle(), currentFont.getSize()), currentColor, extendedColor,
fontPosition, svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration resetFont() {
return new FontConfiguration(styles, motherFont, motherColor, motherFont, motherColor, null,
FontPosition.NORMAL, SvgAttributes.empty(), hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration add(FontStyle style) {
final EnumSet r = styles.clone();
if (style == FontStyle.PLAIN)
r.clear();
r.add(style);
return new FontConfiguration(r, motherFont, motherColor, currentFont, currentColor, extendedColor, fontPosition,
svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public FontConfiguration italic() {
return add(FontStyle.ITALIC);
}
public FontConfiguration bold() {
return add(FontStyle.BOLD);
}
public FontConfiguration unbold() {
return remove(FontStyle.BOLD);
}
public FontConfiguration unitalic() {
return remove(FontStyle.ITALIC);
}
public FontConfiguration underline() {
return add(FontStyle.UNDERLINE);
}
public FontConfiguration wave(HColor color) {
return add(FontStyle.WAVE).changeExtendedColor(color);
}
public FontConfiguration hyperlink() {
if (hyperlinkUnderlineStroke != null)
return add(FontStyle.UNDERLINE).withHyperlink();
return withHyperlink();
}
public FontConfiguration remove(FontStyle style) {
final EnumSet r = styles.clone();
r.remove(style);
return new FontConfiguration(r, motherFont, motherColor, currentFont, currentColor, extendedColor, fontPosition,
svgAttributes, hyperlinkColor, hyperlinkUnderlineStroke, tabSize);
}
public HColor getColor() {
return currentColor;
}
public HColor getExtendedColor() {
return extendedColor;
}
public boolean containsStyle(FontStyle style) {
return styles.contains(style);
}
public int getSpace() {
return fontPosition.getSpace();
}
public Map getAttributes() {
return svgAttributes.attributes();
}
public double getSize2D() {
return currentFont.getSize2D();
}
public int getTabSize() {
return tabSize;
}
public UStroke getUnderlineStroke() {
return hyperlinkUnderlineStroke;
// return UStroke.simple();
// return new UStroke(3, 5, 2);
}
}