SequenceDiagramFileMakerPuma2.java
/* ========================================================================
* 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/paypal
*
* 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.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import net.sourceforge.plantuml.AnnotatedBuilder;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.abel.DisplayPositioned;
import net.sourceforge.plantuml.klimt.LineBreakStrategy;
import net.sourceforge.plantuml.klimt.PngTitler;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontParam;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.VerticalAlignment;
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.UDrawable;
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.rose.Rose;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
public class SequenceDiagramFileMakerPuma2 implements FileMaker {
private final SequenceDiagram diagram;
private final DrawableSet drawableSet;
private final XDimension2D fullDimension;
private final List<Page> pages;
private final FileFormatOption fileFormatOption;
private final StringBounder stringBounder;
public SequenceDiagramFileMakerPuma2(SequenceDiagram diagram, Rose skin, FileFormatOption fileFormatOption) {
this.diagram = diagram;
this.stringBounder = fileFormatOption.getDefaultStringBounder(diagram.getSkinParam());
this.fileFormatOption = fileFormatOption;
final DrawableSetInitializer initializer = new DrawableSetInitializer(skin, diagram.getSkinParam(),
diagram.isShowFootbox(), /* diagram.getAutonewpage(), */ diagram.getCounter());
for (Participant p : diagram.participants())
initializer.addParticipant(p, diagram.getEnglober(p));
for (Event ev : diagram.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);
// }
// }
// }
}
drawableSet = initializer.createDrawableSet(stringBounder);
final List<Newpage> newpages = new ArrayList<>();
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)
positions.put(n, initializer.getYposition(stringBounder, n));
pages = create(drawableSet, positions, diagram.isShowFootbox(), diagram.getTitle().getDisplay()).getPages();
}
public int getNbPages() {
return pages.size();
}
private PageSplitter create(DrawableSet drawableSet, Map<Newpage, Double> positions, boolean showFootbox,
Display title) {
final double headerHeight = drawableSet.getHeadHeight(stringBounder);
final double tailHeight = drawableSet.getTailHeight(stringBounder, showFootbox);
final double signatureHeight = 0;
final double newpageHeight = drawableSet.getSkin()
.createComponentNewPage(
new Style[] { ComponentType.NEWPAGE.getStyleSignature()
.getMergedStyle(drawableSet.getSkinParam().getCurrentStyleBuilder()) },
drawableSet.getSkinParam())
.getPreferredHeight(stringBounder);
return new PageSplitter(fullDimension.getHeight(), headerHeight, positions, tailHeight, signatureHeight,
newpageHeight, title);
}
// private UDrawable createUDrawable(final int index) {
// final Page page = pages.get(index);
// final AnnotatedBuilder builder = new AnnotatedBuilder(diagram, diagram.getSkinParam(), stringBounder);
// double pageHeight = page.getHeight();
// if (builder.hasMainFrame())
// pageHeight += builder.mainFrameSuppHeight();
//
// final SequenceDiagramArea area = new SequenceDiagramArea(fullDimension.getWidth(), pageHeight);
//
// final TextBlock compTitle;
// final TextBlock caption = builder.getCaption();
// area.setCaptionArea(caption.calculateDimension(stringBounder));
//
// if (Display.isNull(page.getTitle())) {
// compTitle = null;
// } else {
// final Style style = StyleSignatureBasic.of(SName.root, SName.document, SName.title)
// .getMergedStyle(diagram.getSkinParam().getCurrentStyleBuilder());
// compTitle = style.createTextBlockBordered(page.getTitle(), diagram.getSkinParam().getIHtmlColorSet(),
// diagram.getSkinParam(), Style.ID_TITLE, LineBreakStrategy.NONE);
// final XDimension2D dimTitle = compTitle.calculateDimension(stringBounder);
// area.setTitleArea(dimTitle.getWidth(), dimTitle.getHeight());
// }
// area.initFooter(getPngTitler(FontParam.FOOTER, index), stringBounder);
// area.initHeader(getPngTitler(FontParam.HEADER, index), stringBounder);
//
// final TextBlock legendBlock;
// if (diagram.getLegend().isNull()) {
// legendBlock = TextBlockUtils.empty(0, 0);
// } else {
// final Style style = StyleSignatureBasic.of(SName.root, SName.document, SName.legend)
// .getMergedStyle(diagram.getSkinParam().getCurrentStyleBuilder());
// legendBlock = style.createTextBlockBordered(diagram.getLegend().getDisplay(),
// diagram.getSkinParam().getIHtmlColorSet(), diagram.getSkinParam(), Style.ID_LEGEND,
// LineBreakStrategy.NONE);
// }
// final XDimension2D dimLegend = legendBlock.calculateDimension(stringBounder);
// area.setLegend(dimLegend, isLegendTop(), diagram.getLegend().getHorizontalAlignment());
//
// final UDrawable drawable = new UDrawable() {
// public void drawU(UGraphic ug) {
//
// double delta = 0;
// if (index > 0)
// delta = page.getNewpage1() - page.getHeaderHeight();
//
// if (delta < 0)
// delta = 0;
//
// if (compTitle != null) {
// final HColor back = diagram.calculateBackColor();
// compTitle.drawU(ug.apply(back.bg()).apply(new UTranslate(area.getTitleX(), area.getTitleY())));
// }
// caption.drawU(ug.apply(new UTranslate(area.getCaptionX(), area.getCaptionY())));
//
// final double delta1 = Math.max(0, area.getLegendWidth() - area.getWidth());
//
// final UTranslate forCore = new UTranslate(area.getSequenceAreaX() + delta1 / 2,
// area.getSequenceAreaY());
// TextBlock core = drawableSet.asTextBlock(delta, fullDimension.getWidth(), page,
// diagram.isShowFootbox());
// core = builder.decoreWithFrame(core);
// core.drawU(ug.apply(forCore));
//
// drawHeader(area, ug, index);
// drawFooter(area, ug, index);
//
// if (area.hasLegend())
// legendBlock.drawU(ug.apply(new UTranslate(area.getLegendX(), area.getLegendY())));
//
// }
//
// };
// return drawable;
// }
private void drawFooter(SequenceDiagramArea area, UGraphic ug, int page) {
final PngTitler pngTitler = getPngTitler(FontParam.FOOTER, page);
final TextBlock text = pngTitler.getRibbonBlock();
if (text == null)
return;
text.drawU(ug.apply(
new UTranslate(area.getFooterX(diagram.getFooter().getHorizontalAlignment()), area.getFooterY())));
}
private void drawHeader(SequenceDiagramArea area, UGraphic ug, int page) {
final PngTitler pngTitler = getPngTitler(FontParam.HEADER, page);
final TextBlock text = pngTitler.getRibbonBlock();
if (text == null)
return;
text.drawU(ug.apply(
new UTranslate(area.getHeaderX(diagram.getHeader().getHorizontalAlignment()), area.getHeaderY())));
}
private PngTitler getPngTitler(final FontParam fontParam, int page) {
final ISkinParam skinParam = diagram.getSkinParam();
final DisplayPositioned display = diagram.getFooterOrHeaderTeoz(fontParam).withPage(page + 1, pages.size());
final StyleSignatureBasic def = fontParam.getStyleDefinition(null);
final Style style = def.getMergedStyle(skinParam.getCurrentStyleBuilder());
return new PngTitler(display, style, skinParam.getIHtmlColorSet(), skinParam);
}
private boolean isLegendTop() {
return diagram.getLegend().isNull() == false
&& diagram.getLegend().getVerticalAlignment() == VerticalAlignment.TOP;
}
@Override
public TextBlock getTextBlock12026(int num, FileFormatOption fileFormat) {
final Page page = pages.get(num);
double delta = 0;
if (num > 0)
delta = page.getNewpage1() - page.getHeaderHeight();
if (delta < 0)
delta = 0;
return drawableSet.asTextBlock(delta, fullDimension.getWidth(), page, diagram.isShowFootbox());
}
}