net.sourceforge.plantuml.ebnf.ETileOptional 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.ebnf;
import net.sourceforge.plantuml.activitydiagram3.ftile.vcompact.FloatingNote;
import net.sourceforge.plantuml.klimt.UTranslate;
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.StringBounder;
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.klimt.shape.URectangle;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.SName;
public class ETileOptional extends ETile {
private final double deltax;
private final double deltay = 16;
private final ETile orig;
private final ISkinParam skinParam;
private String commentAbove;
private String commentBelow;
private final boolean specialForAlternate;
public ETileOptional(ETile orig, ISkinParam skinParam) {
this.skinParam = skinParam;
this.orig = orig;
this.specialForAlternate = orig instanceof ETileAlternation;
this.deltax = this.specialForAlternate ? 0 : 15;
}
@Override
public double getH1(StringBounder stringBounder) {
final TextBlock note = getNoteAbove(stringBounder);
return deltay + orig.getH1(stringBounder) + note.calculateDimension(stringBounder).getHeight();
}
private double getDeltaY(StringBounder stringBounder) {
final TextBlock note = getNoteAbove(stringBounder);
return deltay + note.calculateDimension(stringBounder).getHeight();
}
@Override
public double getH2(StringBounder stringBounder) {
final TextBlock note = getNoteBelow(stringBounder);
return orig.getH2(stringBounder) + note.calculateDimension(stringBounder).getHeight();
}
@Override
public double getWidth(StringBounder stringBounder) {
return orig.getWidth(stringBounder) + 2 * deltax;
}
@Override
public void drawU(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D dim = calculateDimension(stringBounder);
if (TRACE)
ug.apply(HColors.BLUE).draw(URectangle.build(dim));
final double linePos = getH1(stringBounder);
final double posA = specialForAlternate ? 12 : 8;
final double corner = specialForAlternate ? 12 : 8;
final double posB = dim.getWidth() - posA;
final double posYoptionalLine = getDeltaY(stringBounder) - 11;
CornerCurved.createSE(corner).drawU(ug.apply(new UTranslate(posA, linePos)));
drawVline(ug, posA, corner + posYoptionalLine, linePos - corner);
CornerCurved.createNW(corner).drawU(ug.apply(new UTranslate(posA, posYoptionalLine)));
drawHlineDirected(ug, posYoptionalLine, posA + corner, posB - corner, 0.4);
CornerCurved.createSW(corner).drawU(ug.apply(new UTranslate(posB, linePos)));
drawVline(ug, posB, corner + posYoptionalLine, linePos - corner);
CornerCurved.createNE(corner).drawU(ug.apply(new UTranslate(posB, posYoptionalLine)));
drawHline(ug, linePos, 0, deltax);
drawHline(ug, linePos, dim.getWidth() - deltax, dim.getWidth());
orig.drawU(ug.apply(new UTranslate(deltax, getDeltaY(stringBounder))));
final TextBlock noteAbove = getNoteAbove(stringBounder);
if (noteAbove != TextBlockUtils.EMPTY_TEXT_BLOCK) {
final double pos2 = (dim.getWidth() - noteAbove.calculateDimension(stringBounder).getWidth()) / 2;
noteAbove.drawU(ug.apply(UTranslate.dx(pos2)));
}
final TextBlock noteBelow = getNoteBelow(stringBounder);
if (noteBelow != TextBlockUtils.EMPTY_TEXT_BLOCK) {
final XDimension2D dimBelow = noteBelow.calculateDimension(stringBounder);
final double pos2 = (dim.getWidth() - dimBelow.getWidth()) / 2;
noteBelow.drawU(ug.apply(new UTranslate(pos2, dim.getHeight() - dimBelow.getHeight())));
}
}
@Override
public void push(ETile tile) {
throw new UnsupportedOperationException();
}
@Override
protected void addCommentAbove(String comment) {
this.commentAbove = comment;
}
@Override
protected void addCommentBelow(String comment) {
this.commentBelow = comment;
}
private TextBlock getNoteAbove(StringBounder stringBounder) {
if (commentAbove == null)
return TextBlockUtils.EMPTY_TEXT_BLOCK;
final FloatingNote note = FloatingNote.create(Display.getWithNewlines(commentAbove), skinParam, SName.ebnf);
return TextBlockUtils.withMargin(note, 0, 0, 0, 10);
}
private TextBlock getNoteBelow(StringBounder stringBounder) {
if (commentBelow == null)
return TextBlockUtils.EMPTY_TEXT_BLOCK;
final FloatingNote note = FloatingNote.create(Display.getWithNewlines(commentBelow), skinParam, SName.ebnf);
return TextBlockUtils.withMargin(note, 0, 0, 10, 0);
}
}