net.sourceforge.plantuml.sequencediagram.graphic.Step1Message 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.ArrayList;
import java.util.List;
import net.sourceforge.plantuml.OptionFlags;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.sequencediagram.InGroupable;
import net.sourceforge.plantuml.sequencediagram.Message;
import net.sourceforge.plantuml.sequencediagram.Note;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
import net.sourceforge.plantuml.skin.ArrowBody;
import net.sourceforge.plantuml.skin.ArrowComponent;
import net.sourceforge.plantuml.skin.ArrowConfiguration;
import net.sourceforge.plantuml.skin.ArrowHead;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.ComponentType;
import net.sourceforge.plantuml.skin.PaddingParam;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.Style;
class Step1Message extends Step1Abstract {
private final MessageArrow messageArrow;
Step1Message(ParticipantRange range, StringBounder stringBounder, Message message, DrawableSet drawingSet,
Frontier freeY) {
super(range, stringBounder, message, drawingSet, freeY);
final double x1 = getParticipantBox1().getCenterX(stringBounder);
final double x2 = getParticipantBox2().getCenterX(stringBounder);
this.setConfig(isSelfMessage() ? getSelfArrowType(message) : getArrowType(message, x1, x2));
if (isSelfMessage()) {
this.messageArrow = null;
} else {
final ArrowComponent comp = drawingSet.getSkin().createComponentArrow(message.getUsedStyles(), getConfig(),
drawingSet.getSkinParam(), message.getLabelNumbered());
final Component compAliveBox = drawingSet.getSkin().createComponent(
new Style[] { ComponentType.ALIVE_BOX_OPEN_OPEN.getStyleSignature()
.getMergedStyle(drawingSet.getSkinParam().getCurrentStyleBuilder()) },
ComponentType.ALIVE_BOX_OPEN_OPEN, null, drawingSet.getSkinParam(), null);
this.messageArrow = new MessageArrow(freeY.getFreeY(range), drawingSet.getSkin(), comp,
getLivingParticipantBox1(), getLivingParticipantBox2(), message.getUrl(), compAliveBox);
}
final List noteOnMessages = message.getNoteOnMessages();
for (Note noteOnMessage : noteOnMessages) {
final ISkinParam skinParam = noteOnMessage.getSkinParamBackcolored(drawingSet.getSkinParam());
final Component note = drawingSet.getSkin().createComponentNote(noteOnMessage.getUsedStyles(),
noteOnMessage.getNoteStyle().getNoteComponentType(), skinParam, noteOnMessage.getDisplay(),
noteOnMessage.getColors());
addNote(note);
}
}
Frontier prepareMessage(ConstraintSet constraintSet, InGroupablesStack inGroupablesStack) {
final Arrow graphic = createArrow();
final double arrowYStartLevel = graphic.getArrowYStartLevel(getStringBounder());
final double arrowYEndLevel = graphic.getArrowYEndLevel(getStringBounder());
// final double delta1 = isSelfMessage() ? 4 : 0;
final double delta1 = 0;
getMessage().setPosYstartLevel(arrowYStartLevel + delta1);
final double length;
if (isSelfMessage())
length = graphic.getArrowOnlyWidth(getStringBounder()) + getLivingParticipantBox1()
.getLiveThicknessAt(getStringBounder(), arrowYStartLevel).getSegment().getLength();
else
length = graphic.getArrowOnlyWidth(getStringBounder())
+ getLivingParticipantBox(NotePosition.LEFT).getLifeLine().getRightShift(arrowYStartLevel)
+ getLivingParticipantBox(NotePosition.RIGHT).getLifeLine().getLeftShift(arrowYStartLevel);
incFreeY(graphic.getPreferredHeight(getStringBounder()));
double marginActivateAndDeactive = 0;
if (getMessage().isActivateAndDeactive()) {
marginActivateAndDeactive = 30;
incFreeY(marginActivateAndDeactive);
}
getDrawingSet().addEvent(getMessage(), graphic);
if (isSelfMessage()) {
if (this.getConfig().isReverseDefine())
constraintSet.getConstraintBefore(getParticipantBox1()).ensureValue(length);
else
constraintSet.getConstraintAfter(getParticipantBox1()).ensureValue(length);
} else {
constraintSet.getConstraint(getParticipantBox1(), getParticipantBox2()).ensureValue(length);
}
final double posYendLevel = arrowYEndLevel + marginActivateAndDeactive - delta1;
getMessage().setPosYendLevel(posYendLevel);
assert graphic instanceof InGroupable;
if (graphic instanceof InGroupable) {
inGroupablesStack.addElement((InGroupable) graphic);
inGroupablesStack.addElement(getLivingParticipantBox1());
if (isSelfMessage() == false)
inGroupablesStack.addElement(getLivingParticipantBox2());
}
return getFreeY();
}
private boolean isSelfMessage() {
return getParticipantBox1().equals(getParticipantBox2());
}
private ParticipantBox getParticipantBox1() {
return getLivingParticipantBox1().getParticipantBox();
}
private ParticipantBox getParticipantBox2() {
return getLivingParticipantBox2().getParticipantBox();
}
private LivingParticipantBox getLivingParticipantBox1() {
return getDrawingSet().getLivingParticipantBox(((Message) getMessage()).getParticipant1());
}
private LivingParticipantBox getLivingParticipantBox2() {
return getDrawingSet().getLivingParticipantBox(((Message) getMessage()).getParticipant2());
}
private LivingParticipantBox getLivingParticipantBox(NotePosition position) {
if (isSelfMessage())
throw new IllegalStateException();
return messageArrow.getParticipantAt(getStringBounder(), position);
}
private Arrow createArrow() {
if (getMessage().isCreate())
return createArrowCreate();
if (getMessage().getNoteOnMessages().size() > 0 && isSelfMessage()) {
final MessageSelfArrow messageSelfArrow = createMessageSelfArrow();
final List noteBoxes = new ArrayList<>();
for (int i = 0; i < getNotes().size(); i++) {
final Component note = getNotes().get(i);
final Note noteOnMessage = getMessage().getNoteOnMessages().get(i);
noteOnMessage.temporaryProtectedUntilTeozIsStandard();
noteBoxes.add(createNoteBox(getStringBounder(), messageSelfArrow, note, noteOnMessage));
}
return new ArrowAndNoteBox(getStringBounder(), messageSelfArrow, noteBoxes);
} else if (getMessage().getNoteOnMessages().size() > 0) {
final List noteBoxes = new ArrayList<>();
for (int i = 0; i < getNotes().size(); i++) {
final Component note = getNotes().get(i);
final Note noteOnMessage = getMessage().getNoteOnMessages().get(i);
noteOnMessage.temporaryProtectedUntilTeozIsStandard();
noteBoxes.add(createNoteBox(getStringBounder(), messageArrow, note, noteOnMessage));
}
return new ArrowAndNoteBox(getStringBounder(), messageArrow, noteBoxes);
} else if (isSelfMessage()) {
return createMessageSelfArrow();
} else {
return messageArrow;
}
}
private MessageSelfArrow createMessageSelfArrow() {
final double posY = getFreeY().getFreeY(getParticipantRange());
double deltaY = 0;
double deltaX = 0;
if (getMessage().isActivate()) {
deltaY -= getHalfLifeWidth();
if (OptionFlags.STRICT_SELFMESSAGE_POSITION)
deltaX += 5;
}
if (getMessage().isDeactivate())
deltaY += getHalfLifeWidth();
final Style[] styles = getMessage().getUsedStyles();
final ArrowComponent comp = getDrawingSet().getSkin().createComponentArrow(styles, getConfig(),
getDrawingSet().getSkinParam(), getMessage().getLabelNumbered());
return new MessageSelfArrow(posY, getDrawingSet().getSkin(), comp, getLivingParticipantBox1(), deltaY,
getMessage().getUrl(), deltaX);
}
private double getHalfLifeWidth() {
return getDrawingSet().getSkin()
.createComponent(
new Style[] { ComponentType.ALIVE_BOX_OPEN_OPEN.getStyleSignature()
.getMergedStyle(getDrawingSet().getSkinParam().getCurrentStyleBuilder()) },
ComponentType.ALIVE_BOX_OPEN_OPEN, null, getDrawingSet().getSkinParam(), Display.create(""))
.getPreferredWidth(null) / 2;
}
private Arrow createArrowCreate() {
if (messageArrow == null)
throw new IllegalStateException();
Arrow result = new ArrowAndParticipant(getStringBounder(), messageArrow, getParticipantBox2(),
getDrawingSet().getSkinParam().getPadding(PaddingParam.PARTICIPANT));
if (getMessage().getNoteOnMessages().size() > 0) {
final List noteBoxes = new ArrayList<>();
for (int i = 0; i < getNotes().size(); i++) {
final Component note = getNotes().get(i);
final Note noteOnMessage = getMessage().getNoteOnMessages().get(i);
final NoteBox noteBox = createNoteBox(getStringBounder(), result, note, noteOnMessage);
if (noteOnMessage.getPosition() == NotePosition.RIGHT)
noteBox.pushToRight(getParticipantBox2().getPreferredWidth(getStringBounder()) / 2);
noteBoxes.add(noteBox);
}
result = new ArrowAndNoteBox(getStringBounder(), result, noteBoxes);
}
getLivingParticipantBox2()
.create(getFreeY().getFreeY(getParticipantRange()) + result.getPreferredHeight(getStringBounder()) / 2);
return result;
}
private ArrowConfiguration getSelfArrowType(Message m) {
ArrowConfiguration result = ArrowConfiguration.withDirectionSelf(m.getArrowConfiguration().isReverseDefine());
if (m.getArrowConfiguration().isDotted())
result = result.withBody(ArrowBody.DOTTED);
if (m.getArrowConfiguration().isHidden())
result = result.withBody(ArrowBody.HIDDEN);
if (m.getArrowConfiguration().isAsync())
result = result.withHead(ArrowHead.ASYNC);
result = result.withHead1(m.getArrowConfiguration().getDressing1().getHead());
result = result.withHead2(m.getArrowConfiguration().getDressing2().getHead());
result = result.withPart(m.getArrowConfiguration().getPart());
result = result.withColor(m.getArrowConfiguration().getColor());
result = result.withDecoration1(m.getArrowConfiguration().getDecoration1());
result = result.withDecoration2(m.getArrowConfiguration().getDecoration2());
return result;
}
private ArrowConfiguration getArrowType(Message m, final double x1, final double x2) {
if (x2 > x1)
return m.getArrowConfiguration();
return m.getArrowConfiguration().reverse();
}
}