net.sourceforge.plantuml.svek.image.EntityImageClass 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.LeafType;
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.color.HColors;
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.StringBounder;
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.UComment;
import net.sourceforge.plantuml.klimt.shape.URectangle;
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.Kal;
import net.sourceforge.plantuml.svek.Margins;
import net.sourceforge.plantuml.svek.Ports;
import net.sourceforge.plantuml.svek.ShapeType;
import net.sourceforge.plantuml.svek.WithPorts;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.utils.Direction;
public class EntityImageClass extends AbstractEntityImage implements Stencil, WithPorts {
final private TextBlock body;
final private EntityImageClassHeader header;
final private Url url;
final private double roundCorner;
final private LeafType leafType;
final private LineConfigurable lineConfig;
public EntityImageClass(Entity entity, ISkinParam skinParam, PortionShower portionShower) {
super(entity, entity.getColors().mute(skinParam));
this.leafType = entity.getLeafType();
this.lineConfig = entity;
this.roundCorner = getStyle().value(PName.RoundCorner).asDouble();
final boolean showMethods = portionShower.showPortion(EntityPortion.METHOD, entity);
final boolean showFields = portionShower.showPortion(EntityPortion.FIELD, entity);
this.body = entity.getBodier().getBody(getSkinParam(), showMethods, showFields, entity.getStereotype(),
getStyle(), null);
this.header = new EntityImageClassHeader(entity, getSkinParam(), portionShower);
this.url = entity.getUrl99();
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
final XDimension2D dimHeader = header.calculateDimension(stringBounder);
final XDimension2D dimBody = body == null ? new XDimension2D(0, 0) : body.calculateDimension(stringBounder);
double width = Math.max(dimBody.getWidth(), dimHeader.getWidth());
final double minClassWidth = getStyle().value(PName.MinimumWidth).asDouble();
if (width < minClassWidth)
width = minClassWidth;
final double paramSameClassWidth = getSkinParam().getParamSameClassWidth();
if (width < paramSameClassWidth)
width = paramSameClassWidth;
final double height = dimBody.getHeight() + dimHeader.getHeight();
return new XDimension2D(Math.max(width, getKalWidth() * 1.3), height);
// return new Dimension2DDouble(width + getKalWidth(), height);
}
private double getKalWidth() {
double widthUp = 0;
double widthDown = 0;
for (Kal kal : ((Entity) getEntity()).getKals(Direction.UP))
widthUp += kal.getDimension().getWidth();
for (Kal kal : ((Entity) getEntity()).getKals(Direction.DOWN))
widthDown += kal.getDimension().getWidth();
return Math.max(widthUp, widthDown);
}
@Override
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
final XRectangle2D result = body.getInnerPosition(member, stringBounder, strategy);
if (result == null)
return result;
final XDimension2D dimHeader = header.calculateDimension(stringBounder);
final UTranslate translate = UTranslate.dy(dimHeader.getHeight());
return translate.apply(result);
}
final public void drawU(UGraphic ug) {
ug.draw(new UComment("class " + getEntity().getName()));
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);
drawInternal(ug);
ug.closeGroup();
if (url != null)
ug.closeUrl();
}
private Style getStyle() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.classDiagram, SName.class_) //
.withTOBECHANGED(getEntity().getStereotype()) //
.with(getEntity().getStereostyles()) //
.getMergedStyle(getSkinParam().getCurrentStyleBuilder());
}
private Style getStyleHeader() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.classDiagram, SName.class_, SName.header) //
.withTOBECHANGED(getEntity().getStereotype()) //
.with(getEntity().getStereostyles()) //
.getMergedStyle(getSkinParam().getCurrentStyleBuilder());
}
private void drawInternal(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D dimTotal = calculateDimension(stringBounder);
final XDimension2D dimHeader = header.calculateDimension(stringBounder);
final double widthTotal = dimTotal.getWidth();
final double heightTotal = dimTotal.getHeight();
final Shadowable rect = URectangle.build(widthTotal, heightTotal).rounded(roundCorner)
.withCommentAndCodeLine(getEntity().getName(), getEntity().getCodeLine());
double shadow = 0;
HColor borderColor = lineConfig.getColors().getColor(ColorType.LINE);
HColor headerBackcolor = getEntity().getColors().getColor(ColorType.HEADER);
HColor backcolor = getEntity().getColors().getColor(ColorType.BACK);
shadow = getStyle().value(PName.Shadowing).asDouble();
if (borderColor == null)
borderColor = getStyle().value(PName.LineColor).asColor(getSkinParam().getIHtmlColorSet());
if (headerBackcolor == null)
headerBackcolor = backcolor == null
? getStyleHeader().value(PName.BackGroundColor).asColor(getSkinParam().getIHtmlColorSet())
: backcolor;
if (backcolor == null)
backcolor = getStyle().value(PName.BackGroundColor).asColor(getSkinParam().getIHtmlColorSet());
rect.setDeltaShadow(shadow);
ug = ug.apply(borderColor);
ug = ug.apply(backcolor.bg());
final UStroke stroke = getStyle().getStroke(lineConfig.getColors());
UGraphic ugHeader = ug;
if (roundCorner == 0 && headerBackcolor != null && backcolor.equals(headerBackcolor) == false) {
ug.apply(stroke).draw(rect);
final Shadowable rect2 = URectangle.build(widthTotal, dimHeader.getHeight());
rect2.setDeltaShadow(0);
ugHeader = ugHeader.apply(headerBackcolor.bg());
ugHeader.apply(stroke).draw(rect2);
} else if (roundCorner != 0 && headerBackcolor != null && backcolor.equals(headerBackcolor) == false) {
ug.apply(stroke).draw(rect);
final Shadowable rect2 = URectangle.build(widthTotal, dimHeader.getHeight()).rounded(roundCorner);
final URectangle rect3 = URectangle.build(widthTotal, roundCorner / 2);
rect2.setDeltaShadow(0);
rect3.setDeltaShadow(0);
ugHeader = ugHeader.apply(headerBackcolor.bg()).apply(headerBackcolor);
ugHeader.apply(stroke).draw(rect2);
ugHeader.apply(stroke).apply(UTranslate.dy(dimHeader.getHeight() - rect3.getHeight())).draw(rect3);
rect.setDeltaShadow(0);
ug.apply(stroke).apply(HColors.none().bg()).draw(rect);
} else {
ug.apply(stroke).draw(rect);
}
header.drawU(ugHeader, dimTotal.getWidth(), dimHeader.getHeight());
if (body != null) {
final UGraphic ug2 = UGraphicStencil.create(ug, this, stroke);
final UTranslate translate = UTranslate.dy(dimHeader.getHeight());
body.drawU(ug2.apply(translate));
}
}
@Override
public Ports getPorts(StringBounder stringBounder) {
final XDimension2D dimHeader = header.calculateDimension(stringBounder);
if (body instanceof WithPorts)
return ((WithPorts) body).getPorts(stringBounder).translateY(dimHeader.getHeight());
return new Ports();
}
public ShapeType getShapeType() {
if (getEntity().getPortShortNames().size() > 0)
return ShapeType.RECTANGLE_HTML_FOR_PORTS;
return ShapeType.RECTANGLE;
}
@Override
public Margins getShield(StringBounder stringBounder) {
return getEntity().getMargins();
}
public double getStartingX(StringBounder stringBounder, double y) {
return 0;
}
public double getEndingX(StringBounder stringBounder, double y) {
return calculateDimension(stringBounder).getWidth();
}
}