net.sourceforge.plantuml.wire.Block 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.wire;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
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.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.FontParam;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.MinMax;
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.UEllipse;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.utils.Position;
public class Block extends AbstractTextBlock {
// ::remove folder when __CORE__
static class Pos {
final double x;
final double y;
public Pos(double x, double y) {
this.x = x;
this.y = y;
}
UGraphic move(UGraphic ug) {
return ug.apply(new UTranslate(x, y));
}
}
private final Map children = new LinkedHashMap();
private final Display display;
private final XDimension2D fixedDim;
private final ISkinParam skinParam;
private final List left = new ArrayList<>();
private final List right = new ArrayList<>();
private final List top = new ArrayList<>();
private final List bottom = new ArrayList<>();
private double x = 10;
private double y = 10;
private MinMax minMax = MinMax.getEmpty(true);
private Block parent;
public Block(ISkinParam skinParam) {
this(skinParam, Display.empty(), null);
}
private Block(ISkinParam skinParam, Display display, XDimension2D fixedDim) {
this.skinParam = skinParam;
this.display = display;
this.fixedDim = fixedDim;
}
private List getPins(Position position) {
switch (position) {
case LEFT:
return left;
case RIGHT:
return right;
case TOP:
return top;
case BOTTOM:
return bottom;
}
throw new IllegalArgumentException();
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
if (fixedDim == null)
return minMax.getDimension();
return fixedDim;
}
public void drawU(UGraphic ug) {
ug = ug.apply(getBlack());
if (children.size() == 0) {
final TextBlock label = display.create(FontConfiguration.create(skinParam, FontParam.COMPONENT, null),
HorizontalAlignment.CENTER, skinParam);
label.drawU(ug.apply(new UTranslate(10, 10)));
} else {
for (Entry ent : children.entrySet()) {
ent.getKey().drawU(ent.getValue().move(ug));
}
}
ug.draw(URectangle.build(calculateDimension(ug.getStringBounder())));
drawPins(Position.BOTTOM, ug);
drawPins(Position.TOP, ug);
drawPins(Position.LEFT, ug);
drawPins(Position.RIGHT, ug);
}
private HColor getBlack() {
return HColors.BLACK.withDark(HColors.WHITE);
}
private void drawPins(Position pos, UGraphic ug) {
double px = -2;
double py = 10;
if (pos == Position.RIGHT) {
px = calculateDimension(ug.getStringBounder()).getWidth() - 2;
}
if (pos == Position.TOP) {
px = 10;
py = -2;
}
if (pos == Position.BOTTOM) {
px = 10;
py = calculateDimension(ug.getStringBounder()).getHeight() - 2;
}
for (String pin : getPins(pos)) {
ug.apply(new UTranslate(px, py)).draw(UEllipse.build(4, 4));
if (pos == Position.LEFT || pos == Position.RIGHT) {
py += 15;
} else {
px += 15;
}
}
}
public Block componentEnd() {
parent.minMax = parent.minMax.addPoint(parent.x + this.minMax.getMaxX() + 10,
parent.y + this.minMax.getMaxY() + 10);
parent.x += this.minMax.getMaxX() + 10;
return parent;
}
public Block addNewBlock(String name, int width, int height) {
final XDimension2D dim = new XDimension2D(width, height);
final Block child = new Block(skinParam, Display.create(name), dim);
children.put(child, new Pos(x, y));
y += dim.getHeight() + 10;
minMax = minMax.addPoint(x + dim.getWidth() + 10, y);
return child;
}
public Block createContainer(String name) {
final Block result = new Block(skinParam);
result.parent = this;
children.put(result, new Pos(x, y));
return result;
}
public void vspace(int vspace) {
y += vspace - 10;
minMax = minMax.addPoint(x, y);
}
public void newColumn() {
this.x = minMax.getMaxX();
this.y = 10;
}
public void addPin(Position position, String pin) {
getPins(position).add(pin);
}
}