net.sourceforge.plantuml.sequencediagram.graphic.NoteBox 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.sequencediagram.graphic;
import java.util.Objects;
import net.sourceforge.plantuml.klimt.UTranslate;
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.sequencediagram.InGroupable;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
import net.sourceforge.plantuml.skin.Area;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.Context2D;
import net.sourceforge.plantuml.url.Url;
final class NoteBox extends GraphicalElement implements InGroupable {
private final NotePosition position;
private final Url url;
private final LivingParticipantBox p1;
private final LivingParticipantBox p2;
private final Component comp;
private double delta = 0;
public NoteBox(double startingY, Component comp, LivingParticipantBox p1, LivingParticipantBox p2,
NotePosition position, Url url) {
super(startingY);
if (p2 != null ^ position == NotePosition.OVER_SEVERAL) {
throw new IllegalArgumentException();
}
this.p1 = Objects.requireNonNull(p1);
this.p2 = p2;
this.position = position;
this.url = url;
this.comp = comp;
}
public double getRightShift(double y) {
if (p1 == null) {
return 0;
}
return p1.getLifeLine().getRightShift(y) + 5;
}
@Override
final public double getPreferredWidth(StringBounder stringBounder) {
final double preferredWidth = comp.getPreferredWidth(stringBounder);
if (position == NotePosition.OVER_SEVERAL) {
assert p1 != p2;
final double diff1 = p2.getParticipantBox().getMaxX(stringBounder) - p1.getParticipantBox().getMinX();
if (diff1 > preferredWidth) {
return diff1;
}
}
return preferredWidth;
}
@Override
final public double getPreferredHeight(StringBounder stringBounder) {
return comp.getPreferredHeight(stringBounder);
}
@Override
protected void drawInternalU(UGraphic ug, double maxX, Context2D context) {
final StringBounder stringBounder = ug.getStringBounder();
final double xStart = getStartingX(stringBounder);
ug = ug.apply(new UTranslate(xStart, getStartingY()));
final XDimension2D dimensionToUse = new XDimension2D(getPreferredWidth(stringBounder),
comp.getPreferredHeight(stringBounder));
if (url != null) {
ug.startUrl(url);
}
comp.drawU(ug, new Area(dimensionToUse), context);
if (url != null) {
ug.closeUrl();
}
}
@Override
public double getStartingX(StringBounder stringBounder) {
final SegmentColored segment = getSegment(stringBounder);
final int xStart;
if (position == NotePosition.LEFT) {
xStart = (int) (segment.getSegment().getPos1() - getPreferredWidth(stringBounder));
} else if (position == NotePosition.RIGHT) {
xStart = (int) (segment.getSegment().getPos2());
} else if (position == NotePosition.OVER) {
xStart = (int) (p1.getParticipantBox().getCenterX(stringBounder) - getPreferredWidth(stringBounder) / 2);
} else if (position == NotePosition.OVER_SEVERAL) {
final double centre = (p1.getParticipantBox().getCenterX(stringBounder)
+ p2.getParticipantBox().getCenterX(stringBounder)) / 2.0;
xStart = (int) (centre - getPreferredWidth(stringBounder) / 2.0);
} else {
throw new IllegalStateException();
}
return xStart + delta;
}
private SegmentColored getSegment(StringBounder stringBounder) {
final SegmentColored segment = p1.getLiveThicknessAt(stringBounder, getStartingY());
final SegmentColored segment2 = p1.getLiveThicknessAt(stringBounder,
getStartingY() + comp.getPreferredHeight(stringBounder));
return segment.merge(segment2);
}
public void pushToRight(double x) {
this.delta += x;
}
public double getMaxX(StringBounder stringBounder) {
return getStartingX(stringBounder) + getPreferredWidth(stringBounder);
}
public double getMinX(StringBounder stringBounder) {
return getStartingX(stringBounder);
}
public String toString(StringBounder stringBounder) {
return toString();
}
public final Url getUrl() {
return url;
}
public NotePosition getNotePosition() {
return position;
}
}