2015-04-07 18:26:58 +00:00
|
|
|
/* ========================================================================
|
|
|
|
* PlantUML : a free UML diagram generator
|
|
|
|
* ========================================================================
|
|
|
|
*
|
2016-01-09 12:15:40 +00:00
|
|
|
* (C) Copyright 2009-2017, Arnaud Roques
|
2015-04-07 18:26:58 +00:00
|
|
|
*
|
2016-03-06 16:47:34 +00:00
|
|
|
* Project Info: http://plantuml.com
|
2015-04-07 18:26:58 +00:00
|
|
|
*
|
2017-03-15 19:13:31 +00:00
|
|
|
* If you like this project or if you find it useful, you can support us at:
|
|
|
|
*
|
|
|
|
* http://plantuml.com/patreon (only 1$ per month!)
|
|
|
|
* http://plantuml.com/paypal
|
|
|
|
*
|
2015-04-07 18:26:58 +00:00
|
|
|
* This file is part of PlantUML.
|
|
|
|
*
|
|
|
|
* PlantUML is free software; you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* PlantUML distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
|
|
|
|
* License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
|
|
* USA.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Original Author: Arnaud Roques
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
package net.sourceforge.plantuml.sequencediagram.graphic;
|
|
|
|
|
|
|
|
import java.awt.geom.Dimension2D;
|
|
|
|
import java.io.IOException;
|
|
|
|
import java.io.OutputStream;
|
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.LinkedHashMap;
|
|
|
|
import java.util.List;
|
|
|
|
import java.util.Map;
|
|
|
|
|
2016-01-30 12:20:07 +00:00
|
|
|
import net.sourceforge.plantuml.AnnotatedWorker;
|
2015-04-07 18:26:58 +00:00
|
|
|
import net.sourceforge.plantuml.FileFormatOption;
|
|
|
|
import net.sourceforge.plantuml.FontParam;
|
|
|
|
import net.sourceforge.plantuml.activitydiagram3.ftile.EntityImageLegend;
|
|
|
|
import net.sourceforge.plantuml.core.ImageData;
|
|
|
|
import net.sourceforge.plantuml.cucadiagram.Display;
|
2016-01-30 12:20:07 +00:00
|
|
|
import net.sourceforge.plantuml.cucadiagram.DisplayPositionned;
|
2016-11-04 21:39:29 +00:00
|
|
|
import net.sourceforge.plantuml.graphic.FontConfiguration;
|
2015-04-07 18:26:58 +00:00
|
|
|
import net.sourceforge.plantuml.graphic.HorizontalAlignment;
|
|
|
|
import net.sourceforge.plantuml.graphic.HtmlColor;
|
|
|
|
import net.sourceforge.plantuml.graphic.StringBounder;
|
|
|
|
import net.sourceforge.plantuml.graphic.TextBlock;
|
|
|
|
import net.sourceforge.plantuml.graphic.TextBlockUtils;
|
|
|
|
import net.sourceforge.plantuml.graphic.UDrawable;
|
|
|
|
import net.sourceforge.plantuml.graphic.VerticalAlignment;
|
|
|
|
import net.sourceforge.plantuml.png.PngTitler;
|
|
|
|
import net.sourceforge.plantuml.sequencediagram.Event;
|
|
|
|
import net.sourceforge.plantuml.sequencediagram.Newpage;
|
|
|
|
import net.sourceforge.plantuml.sequencediagram.Participant;
|
|
|
|
import net.sourceforge.plantuml.sequencediagram.SequenceDiagram;
|
|
|
|
import net.sourceforge.plantuml.skin.ComponentType;
|
|
|
|
import net.sourceforge.plantuml.skin.Skin;
|
|
|
|
import net.sourceforge.plantuml.ugraphic.ImageBuilder;
|
|
|
|
import net.sourceforge.plantuml.ugraphic.UGraphic;
|
|
|
|
import net.sourceforge.plantuml.ugraphic.UTranslate;
|
|
|
|
|
|
|
|
public class SequenceDiagramFileMakerPuma2 implements FileMaker {
|
|
|
|
|
|
|
|
private final SequenceDiagram diagram;
|
|
|
|
private final DrawableSet drawableSet;
|
|
|
|
private final Dimension2D fullDimension;
|
|
|
|
private final List<Page> pages;
|
|
|
|
private final FileFormatOption fileFormatOption;
|
2016-08-25 20:45:37 +00:00
|
|
|
private final StringBounder stringBounder;
|
2015-04-07 18:26:58 +00:00
|
|
|
|
|
|
|
private double scale;
|
|
|
|
|
|
|
|
public SequenceDiagramFileMakerPuma2(SequenceDiagram sequenceDiagram, Skin skin, FileFormatOption fileFormatOption) {
|
|
|
|
this.diagram = sequenceDiagram;
|
2016-08-25 20:45:37 +00:00
|
|
|
this.stringBounder = fileFormatOption.getDefaultStringBounder();
|
2015-04-07 18:26:58 +00:00
|
|
|
this.fileFormatOption = fileFormatOption;
|
|
|
|
final DrawableSetInitializer initializer = new DrawableSetInitializer(skin, sequenceDiagram.getSkinParam(),
|
|
|
|
sequenceDiagram.isShowFootbox(), sequenceDiagram.getAutonewpage());
|
|
|
|
|
|
|
|
for (Participant p : sequenceDiagram.participants().values()) {
|
|
|
|
initializer.addParticipant(p, sequenceDiagram.getEnglober(p));
|
|
|
|
}
|
|
|
|
|
|
|
|
for (Event ev : sequenceDiagram.events()) {
|
|
|
|
initializer.addEvent(ev);
|
|
|
|
// if (ev instanceof Message) {
|
|
|
|
// // TODO mieux faire
|
|
|
|
// final Message m = (Message) ev;
|
|
|
|
// for (LifeEvent lifeEvent : m.getLiveEvents()) {
|
|
|
|
// if (lifeEvent.getType() == LifeEventType.DESTROY
|
|
|
|
// /*
|
|
|
|
// * || lifeEvent.getType() == LifeEventType.CREATE
|
|
|
|
// */) {
|
|
|
|
// initializer.addEvent(lifeEvent);
|
|
|
|
// }
|
|
|
|
// }
|
|
|
|
// }
|
|
|
|
}
|
2016-08-25 20:45:37 +00:00
|
|
|
drawableSet = initializer.createDrawableSet(stringBounder);
|
2015-04-07 18:26:58 +00:00
|
|
|
final List<Newpage> newpages = new ArrayList<Newpage>();
|
|
|
|
for (Event ev : drawableSet.getAllEvents()) {
|
|
|
|
if (ev instanceof Newpage) {
|
|
|
|
newpages.add((Newpage) ev);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
fullDimension = drawableSet.getDimension();
|
|
|
|
final Map<Newpage, Double> positions = new LinkedHashMap<Newpage, Double>();
|
|
|
|
for (Newpage n : newpages) {
|
2016-08-25 20:45:37 +00:00
|
|
|
positions.put(n, initializer.getYposition(stringBounder, n));
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
2016-01-30 12:20:07 +00:00
|
|
|
pages = create(drawableSet, positions, sequenceDiagram.isShowFootbox(), sequenceDiagram.getTitle().getDisplay())
|
|
|
|
.getPages();
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public int getNbPages() {
|
|
|
|
return pages.size();
|
|
|
|
}
|
|
|
|
|
|
|
|
private PageSplitter create(DrawableSet drawableSet, Map<Newpage, Double> positions, boolean showFootbox,
|
|
|
|
Display title) {
|
|
|
|
|
2016-08-25 20:45:37 +00:00
|
|
|
final double headerHeight = drawableSet.getHeadHeight(stringBounder);
|
|
|
|
final double tailHeight = drawableSet.getTailHeight(stringBounder, showFootbox);
|
2015-04-07 18:26:58 +00:00
|
|
|
final double signatureHeight = 0;
|
|
|
|
final double newpageHeight = drawableSet.getSkin()
|
|
|
|
.createComponent(ComponentType.NEWPAGE, null, drawableSet.getSkinParam(), Display.create(""))
|
2016-08-25 20:45:37 +00:00
|
|
|
.getPreferredHeight(stringBounder);
|
2015-04-07 18:26:58 +00:00
|
|
|
|
|
|
|
return new PageSplitter(fullDimension.getHeight(), headerHeight, positions, tailHeight, signatureHeight,
|
|
|
|
newpageHeight, title);
|
|
|
|
}
|
|
|
|
|
|
|
|
public ImageData createOne(OutputStream os, final int index, boolean isWithMetadata) throws IOException {
|
|
|
|
|
|
|
|
final Page page = pages.get(index);
|
|
|
|
final SequenceDiagramArea area = new SequenceDiagramArea(fullDimension.getWidth(), page.getHeight());
|
|
|
|
|
2016-11-04 21:39:29 +00:00
|
|
|
final TextBlock compTitle;
|
2016-01-30 12:20:07 +00:00
|
|
|
final TextBlock caption = new AnnotatedWorker(diagram, diagram.getSkinParam()).getCaption();
|
2016-08-25 20:45:37 +00:00
|
|
|
area.setCaptionArea(caption.calculateDimension(stringBounder));
|
2016-01-30 12:20:07 +00:00
|
|
|
|
2015-07-11 09:32:49 +00:00
|
|
|
if (Display.isNull(page.getTitle())) {
|
2015-04-07 18:26:58 +00:00
|
|
|
compTitle = null;
|
|
|
|
} else {
|
2016-11-04 21:39:29 +00:00
|
|
|
compTitle = TextBlockUtils.withMargin(TextBlockUtils.title(new FontConfiguration(
|
|
|
|
drawableSet.getSkinParam(), FontParam.SEQUENCE_TITLE, null), page.getTitle(), drawableSet
|
|
|
|
.getSkinParam()), 7, 7);
|
|
|
|
final Dimension2D dimTitle = compTitle.calculateDimension(stringBounder);
|
|
|
|
area.setTitleArea(dimTitle.getWidth(), dimTitle.getHeight());
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
2017-11-20 16:10:36 +00:00
|
|
|
area.initFooter(getPngTitler(FontParam.FOOTER, index), stringBounder);
|
|
|
|
area.initHeader(getPngTitler(FontParam.HEADER, index), stringBounder);
|
2015-04-07 18:26:58 +00:00
|
|
|
|
2016-01-30 12:20:07 +00:00
|
|
|
final DisplayPositionned legend = diagram.getLegend();
|
2015-04-07 18:26:58 +00:00
|
|
|
final TextBlock legendBlock;
|
2016-01-30 12:20:07 +00:00
|
|
|
if (DisplayPositionned.isNull(legend)) {
|
2015-04-07 18:26:58 +00:00
|
|
|
legendBlock = TextBlockUtils.empty(0, 0);
|
|
|
|
} else {
|
2016-01-30 12:20:07 +00:00
|
|
|
legendBlock = EntityImageLegend.create(legend.getDisplay(), diagram.getSkinParam());
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
2016-08-25 20:45:37 +00:00
|
|
|
final Dimension2D dimLegend = legendBlock.calculateDimension(stringBounder);
|
2015-04-07 18:26:58 +00:00
|
|
|
|
|
|
|
scale = getScale(area.getWidth(), area.getHeight());
|
|
|
|
|
|
|
|
final double dpiFactor = diagram.getDpiFactor(fileFormatOption);
|
|
|
|
// System.err.println("dpiFactor=" + dpiFactor);
|
|
|
|
// System.err.println("scale=" + scale);
|
|
|
|
|
2015-07-11 09:32:49 +00:00
|
|
|
final String metadata = fileFormatOption.isWithMetadata() ? diagram.getMetadata() : null;
|
|
|
|
|
2017-11-20 16:10:36 +00:00
|
|
|
final ImageBuilder imageBuilder = new ImageBuilder(diagram.getSkinParam(), oneOf(scale, dpiFactor), metadata,
|
|
|
|
null, 3, 10, diagram.getAnimation());
|
2015-04-07 18:26:58 +00:00
|
|
|
|
2016-03-06 16:47:34 +00:00
|
|
|
imageBuilder.setUDrawable(new UDrawable() {
|
2015-04-07 18:26:58 +00:00
|
|
|
public void drawU(UGraphic ug) {
|
|
|
|
|
|
|
|
double delta = 0;
|
|
|
|
if (index > 0) {
|
|
|
|
delta = page.getNewpage1() - page.getHeaderHeight();
|
|
|
|
}
|
|
|
|
if (delta < 0) {
|
|
|
|
delta = 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
double legendYdelta = 0;
|
|
|
|
if (compTitle != null) {
|
|
|
|
final StringBounder stringBounder = ug.getStringBounder();
|
2016-11-04 21:39:29 +00:00
|
|
|
final double h = compTitle.calculateDimension(stringBounder).getHeight();
|
2015-04-07 18:26:58 +00:00
|
|
|
legendYdelta += h;
|
2016-11-04 21:39:29 +00:00
|
|
|
compTitle.drawU(ug.apply(new UTranslate(area.getTitleX(), area.getTitleY())));
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
2016-01-30 12:20:07 +00:00
|
|
|
caption.drawU(ug.apply(new UTranslate(area.getCaptionX(), area.getCaptionY())));
|
2015-04-07 18:26:58 +00:00
|
|
|
|
|
|
|
final double delta1 = Math.max(0, dimLegend.getWidth() - area.getWidth());
|
|
|
|
|
2016-01-30 12:20:07 +00:00
|
|
|
final boolean legendTop = DisplayPositionned.isNull(legend) == false
|
|
|
|
&& legend.getVerticalAlignment() == VerticalAlignment.TOP;
|
2015-04-07 18:26:58 +00:00
|
|
|
|
|
|
|
double sequenceAreaY = area.getSequenceAreaY();
|
|
|
|
if (legendTop) {
|
|
|
|
sequenceAreaY += legendBlock.calculateDimension(ug.getStringBounder()).getHeight();
|
|
|
|
}
|
|
|
|
drawableSet.drawU22(ug.apply(new UTranslate(area.getSequenceAreaX() + delta1 / 2, sequenceAreaY)),
|
|
|
|
delta, fullDimension.getWidth(), page, diagram.isShowFootbox());
|
|
|
|
|
2017-11-20 16:10:36 +00:00
|
|
|
drawHeader(area, ug, index);
|
|
|
|
drawFooter(area, ug, index);
|
2015-04-07 18:26:58 +00:00
|
|
|
|
2016-01-30 12:20:07 +00:00
|
|
|
if (DisplayPositionned.isNull(legend) == false) {
|
2015-04-07 18:26:58 +00:00
|
|
|
final double delta2;
|
2016-01-30 12:20:07 +00:00
|
|
|
if (legend.getHorizontalAlignment() == HorizontalAlignment.LEFT) {
|
2015-04-07 18:26:58 +00:00
|
|
|
delta2 = 0;
|
2016-01-30 12:20:07 +00:00
|
|
|
} else if (legend.getHorizontalAlignment() == HorizontalAlignment.RIGHT) {
|
2015-04-07 18:26:58 +00:00
|
|
|
delta2 = Math.max(0, area.getWidth() - dimLegend.getWidth());
|
|
|
|
} else {
|
|
|
|
delta2 = Math.max(0, area.getWidth() - dimLegend.getWidth()) / 2;
|
|
|
|
}
|
|
|
|
legendBlock.drawU(ug.apply(new UTranslate(delta2, legendTop ? legendYdelta : legendYdelta
|
|
|
|
+ area.getHeight())));
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
});
|
2017-04-19 18:30:16 +00:00
|
|
|
return imageBuilder.writeImageTOBEMOVED(fileFormatOption, diagram.seed(), os);
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
|
|
|
|
2017-11-20 16:10:36 +00:00
|
|
|
private void drawFooter(SequenceDiagramArea area, UGraphic ug, int page) {
|
|
|
|
final PngTitler pngTitler = getPngTitler(FontParam.FOOTER, page);
|
2016-01-30 12:20:07 +00:00
|
|
|
final TextBlock text = pngTitler.getTextBlock();
|
|
|
|
if (text == null) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
text.drawU(ug.apply(new UTranslate(area.getFooterX(diagram.getFooter().getHorizontalAlignment()), area
|
|
|
|
.getFooterY())));
|
|
|
|
}
|
|
|
|
|
2017-11-20 16:10:36 +00:00
|
|
|
private void drawHeader(SequenceDiagramArea area, UGraphic ug, int page) {
|
|
|
|
final PngTitler pngTitler = getPngTitler(FontParam.HEADER, page);
|
2016-01-30 12:20:07 +00:00
|
|
|
final TextBlock text = pngTitler.getTextBlock();
|
|
|
|
if (text == null) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
text.drawU(ug.apply(new UTranslate(area.getHeaderX(diagram.getHeader().getHorizontalAlignment()), area
|
|
|
|
.getHeaderY())));
|
|
|
|
}
|
|
|
|
|
2015-04-07 18:26:58 +00:00
|
|
|
private double oneOf(double a, double b) {
|
|
|
|
if (a == 1) {
|
|
|
|
return b;
|
|
|
|
}
|
|
|
|
return a;
|
|
|
|
}
|
|
|
|
|
|
|
|
private double getImageWidth(SequenceDiagramArea area, double dpiFactor, double legendWidth) {
|
|
|
|
final int minsize = diagram.getMinwidth();
|
|
|
|
final double w = Math.max(area.getWidth() * getScale(area.getWidth(), area.getHeight()) * dpiFactor,
|
|
|
|
legendWidth);
|
|
|
|
if (minsize == Integer.MAX_VALUE) {
|
|
|
|
return w;
|
|
|
|
}
|
|
|
|
if (w >= minsize) {
|
|
|
|
return w;
|
|
|
|
}
|
|
|
|
return minsize;
|
|
|
|
}
|
|
|
|
|
|
|
|
private double getScale(double width, double height) {
|
|
|
|
if (diagram.getScale() == null) {
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
return diagram.getScale().getScale(width, height);
|
|
|
|
}
|
|
|
|
|
2017-11-20 16:10:36 +00:00
|
|
|
private PngTitler getPngTitler(final FontParam fontParam, int page) {
|
2015-04-07 18:26:58 +00:00
|
|
|
final HtmlColor hyperlinkColor = diagram.getSkinParam().getHyperlinkColor();
|
2016-01-30 12:20:07 +00:00
|
|
|
final HtmlColor titleColor = diagram.getSkinParam().getFontHtmlColor(null, fontParam);
|
|
|
|
final String fontFamily = diagram.getSkinParam().getFont(null, false, fontParam).getFamily(null);
|
|
|
|
final int fontSize = diagram.getSkinParam().getFont(null, false, fontParam).getSize();
|
2017-11-20 16:10:36 +00:00
|
|
|
final Display display = diagram.getFooterOrHeaderTeoz(fontParam).getDisplay().withPage(page + 1, pages.size());
|
|
|
|
return new PngTitler(titleColor, display, fontSize, fontFamily, diagram.getFooterOrHeaderTeoz(fontParam)
|
|
|
|
.getHorizontalAlignment(), hyperlinkColor, diagram.getSkinParam().useUnderlineForHyperlink());
|
2015-04-07 18:26:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|