net.sourceforge.plantuml.activitydiagram3.ftile.vcompact.FtileWithNoteOpale Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.activitydiagram3.ftile.vcompact;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import net.sourceforge.plantuml.activitydiagram3.LinkRendering;
import net.sourceforge.plantuml.activitydiagram3.PositionedNote;
import net.sourceforge.plantuml.activitydiagram3.ftile.AbstractFtile;
import net.sourceforge.plantuml.activitydiagram3.ftile.Ftile;
import net.sourceforge.plantuml.activitydiagram3.ftile.FtileGeometry;
import net.sourceforge.plantuml.activitydiagram3.ftile.Swimlane;
import net.sourceforge.plantuml.klimt.LineBreakStrategy;
import net.sourceforge.plantuml.klimt.UStroke;
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.Sheet;
import net.sourceforge.plantuml.klimt.creole.SheetBlock1;
import net.sourceforge.plantuml.klimt.creole.SheetBlock2;
import net.sourceforge.plantuml.klimt.creole.Stencil;
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.VerticalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
import net.sourceforge.plantuml.sequencediagram.NoteType;
import net.sourceforge.plantuml.skin.AlignmentParam;
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.style.Styleable;
import net.sourceforge.plantuml.svek.image.Opale;
import net.sourceforge.plantuml.utils.Direction;
public class FtileWithNoteOpale extends AbstractFtile implements Stencil, Styleable {
private final Ftile tile;
private final Opale opale;
private final VerticalAlignment verticalAlignment;
private final NotePosition notePosition;
private final double suppSpace = 20;
private final Swimlane swimlaneNote;
public StyleSignatureBasic getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.activityDiagram, SName.note);
}
public Set getSwimlanes() {
if (swimlaneNote != null) {
final Set result = new HashSet<>(tile.getSwimlanes());
result.add(swimlaneNote);
return Collections.unmodifiableSet(result);
}
return tile.getSwimlanes();
}
public Swimlane getSwimlaneIn() {
return tile.getSwimlaneIn();
}
public Swimlane getSwimlaneOut() {
return tile.getSwimlaneOut();
}
@Override
public Collection getMyChildren() {
return Collections.singleton(tile);
}
public static Ftile create(Ftile tile, Collection notes, boolean withLink,
VerticalAlignment verticalAlignment) {
if (notes.size() > 1)
return new FtileWithNotes(tile, notes, verticalAlignment);
if (notes.size() == 0)
throw new IllegalArgumentException();
return new FtileWithNoteOpale(tile, notes.iterator().next(), withLink, verticalAlignment);
}
private FtileWithNoteOpale(Ftile tile, PositionedNote note, boolean withLink, VerticalAlignment verticalAlignment) {
super(note.getColors() == null ? tile.skinParam() : note.getColors().mute(tile.skinParam()));
this.verticalAlignment = verticalAlignment;
this.swimlaneNote = note.getSwimlaneNote();
this.tile = tile;
this.notePosition = note.getNotePosition();
if (note.getType() == NoteType.FLOATING_NOTE)
withLink = false;
final Style style = getStyleSignature().getMergedStyle(skinParam().getCurrentStyleBuilder())
.eventuallyOverride(note.getColors());
final HColor noteBackgroundColor = style.value(PName.BackGroundColor).asColor(getIHtmlColorSet());
final HColor borderColor = style.value(PName.LineColor).asColor(getIHtmlColorSet());
final FontConfiguration fc = style.getFontConfiguration(getIHtmlColorSet());
final double shadowing = style.value(PName.Shadowing).asDouble();
final LineBreakStrategy wrapWidth = style.wrapWidth();
final UStroke stroke = style.getStroke();
final HorizontalAlignment align = skinParam().getHorizontalAlignment(AlignmentParam.noteTextAlignment, null,
false, null);
final Sheet sheet = skinParam().sheet(fc, align, CreoleMode.FULL).createSheet(note.getDisplay());
final TextBlock text = new SheetBlock2(new SheetBlock1(sheet, wrapWidth, skinParam().getPadding()), this,
stroke);
opale = new Opale(shadowing, borderColor, noteBackgroundColor, text, withLink, stroke);
}
private UTranslate getTranslate(StringBounder stringBounder) {
final XDimension2D dimTotal = calculateDimensionInternal(stringBounder);
final XDimension2D dimNote = opale.calculateDimension(stringBounder);
final XDimension2D dimTile = tile.calculateDimension(stringBounder);
final double yForFtile = (dimTotal.getHeight() - dimTile.getHeight()) / 2;
final double marge;
if (notePosition == NotePosition.LEFT)
marge = dimNote.getWidth() + suppSpace;
else
marge = 0;
return new UTranslate(marge, yForFtile);
}
@Override
public UTranslate getTranslateFor(Ftile child, StringBounder stringBounder) {
if (child == tile)
return UTranslate.none();
return super.getTranslateFor(child, stringBounder);
}
private UTranslate getTranslateForOpale(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D dimTotal = calculateDimension(stringBounder);
final XDimension2D dimNote = opale.calculateDimension(stringBounder);
final double yForNote;
if (verticalAlignment == VerticalAlignment.CENTER)
yForNote = (dimTotal.getHeight() - dimNote.getHeight()) / 2;
else
yForNote = 0;
if (notePosition == NotePosition.LEFT)
return UTranslate.dy(yForNote);
final double dx = dimTotal.getWidth() - dimNote.getWidth();
return new UTranslate(dx, yForNote);
}
public void drawU(UGraphic ug) {
final Swimlane intoSw;
if (ug instanceof UGraphicInterceptorOneSwimlane)
intoSw = ((UGraphicInterceptorOneSwimlane) ug).getSwimlane();
else
intoSw = null;
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D dimNote = opale.calculateDimension(stringBounder);
if (notePosition == NotePosition.LEFT) {
final Direction strategy = Direction.RIGHT;
final XPoint2D pp1 = new XPoint2D(dimNote.getWidth(), dimNote.getHeight() / 2);
final XPoint2D pp2 = new XPoint2D(dimNote.getWidth() + suppSpace, dimNote.getHeight() / 2);
opale.setOpale(strategy, pp1, pp2);
} else {
final Direction strategy = Direction.LEFT;
final XPoint2D pp1 = new XPoint2D(0, dimNote.getHeight() / 2);
final XPoint2D pp2 = new XPoint2D(-suppSpace, dimNote.getHeight() / 2);
opale.setOpale(strategy, pp1, pp2);
}
if (ug instanceof UGraphicInterceptorOneSwimlane == false || swimlaneNote == null || intoSw == swimlaneNote)
opale.drawU(ug.apply(getTranslateForOpale(ug)));
ug.apply(getTranslate(stringBounder)).draw(tile);
}
@Override
protected FtileGeometry calculateDimensionFtile(StringBounder stringBounder) {
final XDimension2D dimTotal = calculateDimensionInternal(stringBounder);
final FtileGeometry orig = tile.calculateDimension(stringBounder);
final UTranslate translate = getTranslate(stringBounder);
if (orig.hasPointOut())
return new FtileGeometry(dimTotal, orig.getLeft() + translate.getDx(), orig.getInY() + translate.getDy(),
orig.getOutY() + translate.getDy());
return new FtileGeometry(dimTotal, orig.getLeft() + translate.getDx(), orig.getInY() + translate.getDy());
}
private XDimension2D calculateDimensionInternal(StringBounder stringBounder) {
final XDimension2D dimNote = opale.calculateDimension(stringBounder);
final XDimension2D dimTile = tile.calculateDimension(stringBounder);
final double height = Math.max(dimNote.getHeight(), dimTile.getHeight());
return new XDimension2D(dimTile.getWidth() + 1 * dimNote.getWidth() + suppSpace, height);
}
public double getStartingX(StringBounder stringBounder, double y) {
return -opale.getMarginX1();
}
public double getEndingX(StringBounder stringBounder, double y) {
return opale.calculateDimension(stringBounder).getWidth() - opale.getMarginX1();
}
@Override
final public LinkRendering getInLinkRendering() {
return tile.getInLinkRendering();
}
}