net.sourceforge.plantuml.activitydiagram3.ftile.vcompact.FtileWithNotes Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 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 GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.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 GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 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.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.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
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.image.Opale;
import net.sourceforge.plantuml.utils.MathUtils;
public class FtileWithNotes extends AbstractFtile {
private final Ftile tile;
private TextBlock left;
private TextBlock right;
private final VerticalAlignment verticalAlignment;
private final double suppSpace = 20;
public StyleSignatureBasic getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.activityDiagram, SName.note);
}
public Set getSwimlanes() {
return tile.getSwimlanes();
}
public Swimlane getSwimlaneIn() {
return tile.getSwimlaneIn();
}
public Swimlane getSwimlaneOut() {
return tile.getSwimlaneOut();
}
public FtileWithNotes(Ftile tile, Collection notes, VerticalAlignment verticalAlignment) {
super(tile.skinParam());
this.verticalAlignment = verticalAlignment;
this.tile = tile;
for (PositionedNote note : notes) {
ISkinParam skinParam2 = skinParam();
if (note.getColors() != null)
skinParam2 = note.getColors().mute(skinParam2);
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 Sheet sheet = skinParam()
.sheet(fc, skinParam().getDefaultTextAlignment(HorizontalAlignment.LEFT), CreoleMode.FULL)
.createSheet(note.getDisplay());
final SheetBlock1 sheet1 = new SheetBlock1(sheet, wrapWidth, skinParam().getPadding());
final SheetBlock2 sheet2 = new SheetBlock2(sheet1, new Stencil() {
// -6 and 15 value comes from Opale: this is very ugly!
public double getStartingX(StringBounder stringBounder, double y) {
return -6;
}
public double getEndingX(StringBounder stringBounder, double y) {
return sheet1.getEndingX(stringBounder, y) + 15;
}
}, UStroke.simple());
final Opale opale = new Opale(shadowing, borderColor, noteBackgroundColor, sheet2, false, stroke);
final TextBlock opaleMarged = TextBlockUtils.withMargin(opale, 10, 10);
if (note.getNotePosition() == NotePosition.LEFT) {
if (left == null) {
left = opaleMarged;
} else {
left = TextBlockUtils.mergeTB(left, opaleMarged, HorizontalAlignment.CENTER);
}
} else {
if (right == null) {
right = opaleMarged;
} else {
right = TextBlockUtils.mergeTB(right, opaleMarged, HorizontalAlignment.CENTER);
}
}
}
if (left == null)
left = TextBlockUtils.empty(0, 0);
if (right == null)
right = TextBlockUtils.empty(0, 0);
}
private UTranslate getTranslate(StringBounder stringBounder) {
final XDimension2D dimTotal = calculateDimensionInternal(stringBounder);
final XDimension2D dimTile = tile.calculateDimension(stringBounder);
final double xDelta = left.calculateDimension(stringBounder).getWidth();
final double yDelta;
if (verticalAlignment == VerticalAlignment.TOP)
yDelta = 0;
else
yDelta = (dimTotal.getHeight() - dimTile.getHeight()) / 2;
return new UTranslate(xDelta, yDelta);
}
private UTranslate getTranslateForLeft(StringBounder stringBounder) {
final XDimension2D dimTotal = calculateDimensionInternal(stringBounder);
final XDimension2D dimLeft = left.calculateDimension(stringBounder);
final double xDelta = 0;
final double yDelta;
if (verticalAlignment == VerticalAlignment.TOP)
yDelta = 0;
else
yDelta = (dimTotal.getHeight() - dimLeft.getHeight()) / 2;
return new UTranslate(xDelta, yDelta);
}
private UTranslate getTranslateForRight(StringBounder stringBounder) {
final XDimension2D dimTotal = calculateDimensionInternal(stringBounder);
final XDimension2D dimRight = right.calculateDimension(stringBounder);
final double xDelta = dimTotal.getWidth() - dimRight.getWidth();
final double yDelta;
if (verticalAlignment == VerticalAlignment.TOP)
yDelta = 0;
else
yDelta = (dimTotal.getHeight() - dimRight.getHeight()) / 2;
return new UTranslate(xDelta, yDelta);
}
public void drawU(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
left.drawU(ug.apply(getTranslateForLeft(stringBounder)));
right.drawU(ug.apply(getTranslateForRight(stringBounder)));
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 dimTile = tile.calculateDimension(stringBounder);
final XDimension2D dimLeft = left.calculateDimension(stringBounder);
final XDimension2D dimRight = right.calculateDimension(stringBounder);
final double height = MathUtils.max(dimLeft.getHeight(), dimRight.getHeight(), dimTile.getHeight());
return new XDimension2D(dimTile.getWidth() + dimLeft.getWidth() + dimRight.getWidth(), height);
}
@Override
final public LinkRendering getInLinkRendering() {
return tile.getInLinkRendering();
}
}