net.sourceforge.plantuml.klimt.shape.GraphicStrings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-lgpl Show documentation
Show all versions of plantuml-lgpl 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 GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*
* 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 LGPL license.
*
* The generated images can then be used without any reference to the LGPL 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.shape;
import java.awt.image.BufferedImage;
import java.util.List;
import net.atmp.PixelImage;
import net.sourceforge.plantuml.klimt.AffineTransformType;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.creole.CreoleMode;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.font.UFont;
import net.sourceforge.plantuml.klimt.geom.GraphicPosition;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.sprite.SpriteContainerEmpty;
import net.sourceforge.plantuml.svek.IEntityImage;
import net.sourceforge.plantuml.svek.Margins;
import net.sourceforge.plantuml.svek.ShapeType;
public class GraphicStrings extends AbstractTextBlock implements IEntityImage {
// ::remove file when __HAXE__
private final double margin = 5;
private final HColor background;
private final static HColor hyperlinkColor = HColors.BLUE;
private final static UStroke useUnderlineForHyperlink = UStroke.simple();
private final List strings;
private final BufferedImage image;
private final double imagePadding = 30;
private final GraphicPosition position;
private final FontConfiguration fontConfiguration;
public static IEntityImage createForError(List strings, boolean useRed) {
return new GraphicStrings(strings, sansSerif14(getForeColor(useRed)).bold(), getBackColor(useRed), null, null,
CreoleMode.NO_CREOLE);
}
private static HColor getForeColor(boolean useRed) {
if (useRed) {
return HColors.BLACK;
}
return HColors.MY_GREEN;
}
private static HColor getBackColor(boolean useRed) {
if (useRed) {
return HColors.RED_LIGHT;
}
return HColors.BLACK;
}
public static TextBlock createGreenOnBlackMonospaced(List strings) {
return new GraphicStrings(strings, monospaced14(HColors.GREEN), HColors.BLACK, null, null,
CreoleMode.SIMPLE_LINE);
}
public static TextBlock createBlackOnWhite(List strings) {
return new GraphicStrings(strings, sansSerif12(HColors.BLACK), HColors.WHITE, null, null, CreoleMode.FULL);
}
public static TextBlock createBlackOnWhiteMonospaced(List strings) {
return new GraphicStrings(strings, monospaced14(HColors.BLACK), HColors.WHITE, null, null, CreoleMode.FULL);
}
public static TextBlock createBlackOnWhite(List strings, BufferedImage image, GraphicPosition position) {
return new GraphicStrings(strings, sansSerif12(HColors.BLACK), HColors.WHITE, image, position,
CreoleMode.FULL_BUT_UNDERSCORE);
}
public static FontConfiguration sansSerif12(HColor color) {
return FontConfiguration.create(UFont.sansSerif(12), color, hyperlinkColor, useUnderlineForHyperlink);
}
public static FontConfiguration sansSerif14(HColor color) {
return FontConfiguration.create(UFont.sansSerif(14), color, hyperlinkColor, useUnderlineForHyperlink);
}
private static FontConfiguration monospaced14(HColor color) {
return FontConfiguration.create(UFont.monospaced(14), color, hyperlinkColor, useUnderlineForHyperlink);
}
private final CreoleMode mode;
private GraphicStrings(List strings, FontConfiguration fontConfiguration, HColor background,
BufferedImage image, GraphicPosition position, CreoleMode mode) {
this.strings = strings;
this.background = background;
this.image = image;
this.position = position;
this.mode = mode;
this.fontConfiguration = fontConfiguration;
}
private TextBlock getTextBlock() {
final Display display = Display.create(strings);
if (mode == CreoleMode.NO_CREOLE) {
return new TextBlockRaw(strings, fontConfiguration);
} else {
return display.create7(fontConfiguration, HorizontalAlignment.LEFT, new SpriteContainerEmpty(), mode);
}
}
public void drawU(UGraphic ug) {
ug = ug.apply(new UTranslate(margin, margin));
final XDimension2D size = calculateDimensionInternal(ug.getStringBounder());
getTextBlock().drawU(ug.apply(fontConfiguration.getColor()));
if (image != null) {
if (position == GraphicPosition.BOTTOM) {
ug.apply(new UTranslate((size.getWidth() - image.getWidth()) / 2, size.getHeight() - image.getHeight()))
.draw(new UImage(new PixelImage(image, AffineTransformType.TYPE_BILINEAR)));
} else if (position == GraphicPosition.BACKGROUND_CORNER_BOTTOM_RIGHT) {
ug.apply(new UTranslate(size.getWidth() - image.getWidth(), size.getHeight() - image.getHeight()))
.draw(new UImage(new PixelImage(image, AffineTransformType.TYPE_BILINEAR)));
} else if (position == GraphicPosition.BACKGROUND_CORNER_TOP_RIGHT) {
ug.apply(new UTranslate(size.getWidth() - image.getWidth() - 1, 1))
.draw(new UImage(new PixelImage(image, AffineTransformType.TYPE_BILINEAR)));
}
}
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return calculateDimensionInternal(stringBounder).delta(2 * margin);
}
private XDimension2D calculateDimensionInternal(StringBounder stringBounder) {
XDimension2D dim = getTextBlock().calculateDimension(stringBounder);
if (image != null) {
if (position == GraphicPosition.BOTTOM) {
dim = new XDimension2D(dim.getWidth(), dim.getHeight() + image.getHeight());
} else if (position == GraphicPosition.BACKGROUND_CORNER_BOTTOM_RIGHT) {
dim = new XDimension2D(dim.getWidth() + imagePadding + image.getWidth(), dim.getHeight());
} else if (position == GraphicPosition.BACKGROUND_CORNER_TOP_RIGHT) {
dim = new XDimension2D(dim.getWidth() + imagePadding + image.getWidth(), dim.getHeight());
}
}
return dim;
}
public ShapeType getShapeType() {
return ShapeType.RECTANGLE;
}
public HColor getBackcolor() {
return background;
}
public Margins getShield(StringBounder stringBounder) {
return Margins.NONE;
}
public boolean isHidden() {
return false;
}
public double getOverscanX(StringBounder stringBounder) {
return 0;
}
}