net.sourceforge.plantuml.svek.image.EntityImageObject Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-epl Show documentation
Show all versions of plantuml-epl 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 Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* 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 EPL license.
*
* The generated images can then be used without any reference to the EPL 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.svek.image;
import java.util.EnumMap;
import java.util.Map;
import net.atmp.InnerStrategy;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.EntityPortion;
import net.sourceforge.plantuml.abel.LineConfigurable;
import net.sourceforge.plantuml.cucadiagram.PortionShower;
import net.sourceforge.plantuml.klimt.Shadowable;
import net.sourceforge.plantuml.klimt.UGroupType;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.ColorType;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.creole.Stencil;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.drawing.UGraphicStencil;
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.PlacementStrategyY1Y2;
import net.sourceforge.plantuml.klimt.geom.ULayoutGroup;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XRectangle2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockEmpty;
import net.sourceforge.plantuml.klimt.shape.TextBlockLineBefore;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.skin.CornerParam;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.svek.AbstractEntityImage;
import net.sourceforge.plantuml.svek.Ports;
import net.sourceforge.plantuml.svek.ShapeType;
import net.sourceforge.plantuml.svek.WithPorts;
import net.sourceforge.plantuml.text.Guillemet;
import net.sourceforge.plantuml.url.Url;
public class EntityImageObject extends AbstractEntityImage implements Stencil, WithPorts {
final private TextBlock name;
final private TextBlock stereo;
final private TextBlock fields;
final private Url url;
final private double roundCorner;
private final boolean showFields;
final private LineConfigurable lineConfig;
public EntityImageObject(Entity entity, ISkinParam skinParam, PortionShower portionShower) {
super(entity, skinParam);
this.lineConfig = entity;
final Stereotype stereotype = entity.getStereotype();
this.roundCorner = skinParam.getRoundCorner(CornerParam.DEFAULT, null);
final FontConfiguration fcHeader = getStyleHeader().getFontConfiguration(getSkinParam().getIHtmlColorSet());
final TextBlock tmp = getUnderlinedName(entity).create(fcHeader, HorizontalAlignment.CENTER, skinParam);
this.name = TextBlockUtils.withMargin(tmp, 2, 2);
if (stereotype == null || stereotype.getLabel(Guillemet.DOUBLE_COMPARATOR) == null
|| portionShower.showPortion(EntityPortion.STEREOTYPE, entity) == false)
this.stereo = null;
else
this.stereo = Display.create(stereotype.getLabels(skinParam.guillemet())).create(
FontConfiguration.create(getSkinParam(), FontParam.OBJECT_STEREOTYPE, stereotype),
HorizontalAlignment.CENTER, skinParam);
showFields = portionShower.showPortion(EntityPortion.FIELD, entity);
if (entity.getBodier().getFieldsToDisplay().size() == 0 && showFields)
this.fields = new TextBlockLineBefore(getStyle().value(PName.LineThickness).asDouble(),
new TextBlockEmpty(10, 16));
else
this.fields = entity.getBodier().getBody(skinParam, false, showFields, entity.getStereotype(), getStyle(),
null);
this.url = entity.getUrl99();
}
private Style getStyle() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.objectDiagram, SName.object)
.withTOBECHANGED(getEntity().getStereotype()).getMergedStyle(getSkinParam().getCurrentStyleBuilder());
}
private Style getStyleHeader() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.objectDiagram, SName.object, SName.header)
.withTOBECHANGED(getEntity().getStereotype()).getMergedStyle(getSkinParam().getCurrentStyleBuilder());
}
private Display getUnderlinedName(Entity entity) {
if (getSkinParam().strictUmlStyle())
return entity.getDisplay().underlinedName();
return entity.getDisplay();
}
private int marginEmptyFieldsOrMethod = 13;
public XDimension2D calculateDimension(StringBounder stringBounder) {
final XDimension2D dimTitle = getTitleDimension(stringBounder);
final XDimension2D dimFields = fields.calculateDimension(stringBounder);
double width = Math.max(dimFields.getWidth(), dimTitle.getWidth() + 2 * xMarginCircle);
final double minClassWidth = getStyle().value(PName.MinimumWidth).asDouble();
if (width < minClassWidth)
width = minClassWidth;
final double height = getMethodOrFieldHeight(dimFields) + dimTitle.getHeight();
return new XDimension2D(width, height);
}
final public void drawU(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D dimTotal = calculateDimension(stringBounder);
final XDimension2D dimTitle = getTitleDimension(stringBounder);
final double widthTotal = dimTotal.getWidth();
final double heightTotal = dimTotal.getHeight();
final Shadowable rect = URectangle.build(widthTotal, heightTotal).rounded(roundCorner);
HColor backcolor = getEntity().getColors().getColor(ColorType.BACK);
HColor headerBackcolor = getEntity().getColors().getColor(ColorType.HEADER);
final Style style = getStyle();
final HColor borderColor = style.value(PName.LineColor).asColor(getSkinParam().getIHtmlColorSet());
if (headerBackcolor == null)
headerBackcolor = backcolor == null
? getStyleHeader().value(PName.BackGroundColor).asColor(getSkinParam().getIHtmlColorSet())
: backcolor;
if (backcolor == null)
backcolor = style.value(PName.BackGroundColor).asColor(getSkinParam().getIHtmlColorSet());
rect.setDeltaShadow(style.value(PName.Shadowing).asDouble());
final UStroke stroke = style.getStroke();
ug = ug.apply(borderColor).apply(backcolor.bg());
if (url != null)
ug.startUrl(url);
final Map typeIDent = new EnumMap<>(UGroupType.class);
typeIDent.put(UGroupType.CLASS, "elem " + getEntity().getName() + " selected");
typeIDent.put(UGroupType.ID, "elem_" + getEntity().getName());
ug.startGroup(typeIDent);
ug.apply(stroke).draw(rect);
if (roundCorner == 0 && headerBackcolor != null && backcolor.equals(headerBackcolor) == false) {
final Shadowable rect2 = URectangle.build(widthTotal, dimTitle.getHeight());
final UGraphic ugHeader = ug.apply(headerBackcolor.bg());
ugHeader.apply(stroke).draw(rect2);
}
final ULayoutGroup header = getLayout(stringBounder);
header.drawU(ug, dimTotal.getWidth(), dimTitle.getHeight());
final UGraphic ug2 = UGraphicStencil.create(ug, this, stroke);
fields.drawU(ug2.apply(UTranslate.dy(dimTitle.getHeight())));
if (url != null)
ug.closeUrl();
ug.closeGroup();
}
private ULayoutGroup getLayout(final StringBounder stringBounder) {
final ULayoutGroup header = new ULayoutGroup(new PlacementStrategyY1Y2(stringBounder));
if (stereo != null)
header.add(stereo);
header.add(name);
return header;
}
private double getMethodOrFieldHeight(final XDimension2D dim) {
final double fieldsHeight = dim.getHeight();
if (fieldsHeight == 0 && showFields)
return marginEmptyFieldsOrMethod;
return fieldsHeight;
}
private int xMarginCircle = 5;
private XDimension2D getTitleDimension(StringBounder stringBounder) {
return getNameAndSteretypeDimension(stringBounder);
}
private XDimension2D getNameAndSteretypeDimension(StringBounder stringBounder) {
final XDimension2D nameDim = name.calculateDimension(stringBounder);
final XDimension2D stereoDim = stereo == null ? new XDimension2D(0, 0)
: stereo.calculateDimension(stringBounder);
final XDimension2D nameAndStereo = new XDimension2D(Math.max(nameDim.getWidth(), stereoDim.getWidth()),
nameDim.getHeight() + stereoDim.getHeight());
return nameAndStereo;
}
public ShapeType getShapeType() {
if (getEntity().getPortShortNames().size() > 0)
return ShapeType.RECTANGLE_HTML_FOR_PORTS;
return ShapeType.RECTANGLE;
}
public double getStartingX(StringBounder stringBounder, double y) {
return 0;
}
public double getEndingX(StringBounder stringBounder, double y) {
return calculateDimension(stringBounder).getWidth();
}
@Override
public Ports getPorts(StringBounder stringBounder) {
final XDimension2D dimHeader = getNameAndSteretypeDimension(stringBounder);
if (fields instanceof WithPorts)
return ((WithPorts) fields).getPorts(stringBounder).translateY(dimHeader.getHeight());
return new Ports();
}
@Override
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
final XDimension2D dimTitle = getTitleDimension(stringBounder);
final UTranslate translate = UTranslate.dy(dimTitle.getHeight());
return translate.apply(fields.getInnerPosition(member, stringBounder, strategy));
}
}