net.sourceforge.plantuml.cucadiagram.TextBlockMap 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.cucadiagram;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import net.sourceforge.plantuml.klimt.LineBreakStrategy;
import net.sourceforge.plantuml.klimt.UShape;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
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.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.skin.VisibilityModifier;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.svek.Ports;
import net.sourceforge.plantuml.svek.WithPorts;
public class TextBlockMap extends AbstractTextBlock implements WithPorts {
// ::remove folder when __HAXE__
private final ISkinParam skinParam;
private final FontConfiguration fontConfiguration;
private final Map blocksMap = new LinkedHashMap<>();
private final List keys = new ArrayList<>();
private double totalWidth;
public TextBlockMap(FontConfiguration fontConfiguration, ISkinParam skinParam, Map map,
LineBreakStrategy wordWrap) {
this.skinParam = skinParam;
this.fontConfiguration = fontConfiguration;
for (Map.Entry ent : map.entrySet()) {
String key = ent.getKey();
if (VisibilityModifier.isVisibilityCharacter(key))
key = key.substring(1);
this.keys.add(key);
final String value = ent.getValue();
final TextBlock block1 = getTextBlock(key, wordWrap);
final TextBlock block2 = getTextBlock(value, wordWrap);
this.blocksMap.put(block1, block2);
}
}
@Override
public Ports getPorts(StringBounder stringBounder) {
final Ports ports = new Ports();
int i = 0;
double y = 0;
for (Map.Entry ent : blocksMap.entrySet()) {
final TextBlock key = ent.getKey();
final TextBlock value = ent.getValue();
final double height = getHeightOfRow(stringBounder, key, value);
ports.add(keys.get(i), 100, y, height);
y += height;
i++;
}
return ports;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new XDimension2D(getWidthColA(stringBounder) + getWidthColB(stringBounder),
getTotalHeight(stringBounder));
}
private double getWidthColA(StringBounder stringBounder) {
return getMaxWidth(stringBounder, blocksMap.keySet());
}
private double getWidthColB(StringBounder stringBounder) {
return getMaxWidth(stringBounder, blocksMap.values());
}
private double getMaxWidth(StringBounder stringBounder, Collection blocks) {
double width = 0;
for (TextBlock block : blocks)
width = Math.max(width, block.calculateDimension(stringBounder).getWidth());
return width;
}
public void drawU(final UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D fullDim = calculateDimension(stringBounder);
final double trueWidth = Math.max(fullDim.getWidth(), totalWidth);
final double widthColA = getWidthColA(stringBounder);
final double widthColB = getWidthColB(stringBounder);
double y = 0;
for (Map.Entry ent : blocksMap.entrySet()) {
final TextBlock key = ent.getKey();
final TextBlock value = ent.getValue();
final UGraphic ugline = ug.apply(UTranslate.dy(y));
ugline.draw(ULine.hline(trueWidth));
final double heightOfRow = getHeightOfRow(stringBounder, key, value);
if (value instanceof Point) {
final double posColA = (trueWidth - key.calculateDimension(stringBounder).getWidth()) / 2;
key.drawU(ugline.apply(UTranslate.dx(posColA)));
} else {
final double posColA = (widthColA - key.calculateDimension(stringBounder).getWidth()) / 2;
key.drawU(ugline.apply(UTranslate.dx(posColA)));
value.drawU(ugline.apply(UTranslate.dx(widthColA)));
ugline.apply(UTranslate.dx(widthColA)).draw(ULine.vline(heightOfRow));
}
y += heightOfRow;
}
}
private double getTotalHeight(StringBounder stringBounder) {
double height = 0;
for (Map.Entry ent : blocksMap.entrySet()) {
final TextBlock key = ent.getKey();
final TextBlock value = ent.getValue();
height += getHeightOfRow(stringBounder, key, value);
}
return height;
}
private double getHeightOfRow(StringBounder stringBounder, TextBlock key, TextBlock value) {
return Math.max(key.calculateDimension(stringBounder).getHeight(),
value.calculateDimension(stringBounder).getHeight());
}
private TextBlock getTextBlock(String key, LineBreakStrategy wordWrap) {
if (key.equals("\0"))
return new Point(fontConfiguration.getColor());
final Display display = Display.getWithNewlines(key);
TextBlock result = display.create0(fontConfiguration, HorizontalAlignment.LEFT, skinParam, wordWrap,
CreoleMode.FULL, null, null);
result = TextBlockUtils.withMargin(result, 5, 2);
return result;
}
static class Point extends AbstractTextBlock {
private final HColor color;
public Point(HColor color) {
this.color = color;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new XDimension2D(getDiameter(), getDiameter());
}
public void drawU(UGraphic ug) {
final UShape point = UEllipse.build(getDiameter(), getDiameter());
ug = ug.apply(color).apply(color.bg());
ug.draw(point);
}
private double getDiameter() {
return 7;
}
}
public void setTotalWidth(double totalWidth) {
this.totalWidth = totalWidth;
}
}