net.sourceforge.plantuml.sequencediagram.graphic.Step1MessageExo 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.sequencediagram.graphic;
import java.util.ArrayList;
import java.util.List;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.sequencediagram.InGroupable;
import net.sourceforge.plantuml.sequencediagram.MessageExo;
import net.sourceforge.plantuml.sequencediagram.MessageExoType;
import net.sourceforge.plantuml.sequencediagram.Note;
import net.sourceforge.plantuml.skin.ArrowComponent;
import net.sourceforge.plantuml.skin.ArrowConfiguration;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.style.ISkinParam;
class Step1MessageExo extends Step1Abstract {
private final MessageExoArrow messageArrow;
Step1MessageExo(ParticipantRange range, StringBounder stringBounder, MessageExo message, DrawableSet drawingSet,
Frontier freeY) {
super(range, stringBounder, message, drawingSet, freeY);
setConfig(getArrowType(message));
final ArrowComponent comp = drawingSet.getSkin().createComponentArrow(message.getUsedStyles(), getConfig(),
drawingSet.getSkinParam(), message.getLabelNumbered());
this.messageArrow = new MessageExoArrow(freeY.getFreeY(range), drawingSet.getSkin(), comp,
getLivingParticipantBox(), message.getType(), message.getUrl(), message.isShortArrow(),
message.getArrowConfiguration());
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());
getMessage().setPosYstartLevel(arrowYStartLevel);
final double length = graphic.getArrowOnlyWidth(getStringBounder());
incFreeY(graphic.getPreferredHeight(getStringBounder()));
double marginActivateAndDeactive = 0;
if (getMessage().isActivateAndDeactive()) {
marginActivateAndDeactive = 30;
incFreeY(marginActivateAndDeactive);
}
getDrawingSet().addEvent(getMessage(), graphic);
final LivingParticipantBox livingParticipantBox = getLivingParticipantBox();
if (messageArrow.getType().isRightBorder()) {
constraintSet.getConstraint(livingParticipantBox.getParticipantBox(), constraintSet.getLastborder())
.ensureValue(length);
} else {
constraintSet.getConstraint(constraintSet.getFirstBorder(), livingParticipantBox.getParticipantBox())
.ensureValue(length);
}
final double posYendLevel = arrowYEndLevel + marginActivateAndDeactive;
getMessage().setPosYendLevel(posYendLevel);
assert graphic instanceof InGroupable;
if (graphic instanceof InGroupable) {
inGroupablesStack.addElement((InGroupable) graphic);
inGroupablesStack.addElement(livingParticipantBox);
}
return getFreeY();
}
private LivingParticipantBox getLivingParticipantBox() {
return getDrawingSet().getLivingParticipantBox(((MessageExo) getMessage()).getParticipant());
}
private Arrow createArrow() {
if (getMessage().getNoteOnMessages().size() == 0) {
return messageArrow;
}
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);
noteBoxes.add(createNoteBox(getStringBounder(), messageArrow, note, noteOnMessage));
}
return new ArrowAndNoteBox(getStringBounder(), messageArrow, noteBoxes);
}
private ArrowConfiguration getArrowType(MessageExo m) {
final MessageExoType type = m.getType();
ArrowConfiguration result = null;
if (type.getDirection() == 1)
result = m.getArrowConfiguration();
else
result = m.getArrowConfiguration().reverse();
// result = result.withDecoration1(m.getArrowConfiguration().getDecoration1());
// result = result.withDecoration2(m.getArrowConfiguration().getDecoration2());
return result;
// ArrowConfiguration result = null;
// if (type.getDirection() == 1) {
// result = ArrowConfiguration.withDirectionNormal();
// } else {
// result = ArrowConfiguration.withDirectionReverse();
// }
// if (m.getArrowConfiguration().isDotted()) {
// result = result.withDotted();
// }
// if (m.getArrowConfiguration().isAsync()) {
// result = result.withHead(ArrowHead.ASYNC);
// }
// result = result.withPart(m.getArrowConfiguration().getPart());
// return result;
}
}