net.sourceforge.plantuml.project.draw.TaskDrawRegular 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.project.draw;
import java.util.ArrayList;
import java.util.Collection;
import java.util.TreeSet;
import net.sourceforge.plantuml.klimt.LineBreakStrategy;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.CreoleMode;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.creole.Sheet;
import net.sourceforge.plantuml.klimt.creole.SheetBlock1;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.sprite.SpriteContainerEmpty;
import net.sourceforge.plantuml.project.GanttConstraint;
import net.sourceforge.plantuml.project.LabelStrategy;
import net.sourceforge.plantuml.project.ToTaskDraw;
import net.sourceforge.plantuml.project.core.Task;
import net.sourceforge.plantuml.project.core.TaskAttribute;
import net.sourceforge.plantuml.project.core.TaskImpl;
import net.sourceforge.plantuml.project.lang.CenterBorderColor;
import net.sourceforge.plantuml.project.time.Day;
import net.sourceforge.plantuml.project.timescale.TimeScale;
import net.sourceforge.plantuml.real.Real;
import net.sourceforge.plantuml.sequencediagram.graphic.Segment;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
import net.sourceforge.plantuml.style.ISkinSimple;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignature;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.svek.image.Opale;
public class TaskDrawRegular extends AbstractTaskDraw {
private final Day end;
private final boolean oddStart;
private final boolean oddEnd;
private final Collection paused;
private final Collection constraints;
private final ISkinSimple skinSimple;
public TaskDrawRegular(TimeScale timeScale, Real y, String prettyDisplay, Day start, Day end, boolean oddStart,
boolean oddEnd, ISkinSimple skinSimple, Task task, ToTaskDraw toTaskDraw,
Collection constraints, StyleBuilder styleBuilder) {
super(timeScale, y, prettyDisplay, start, task, toTaskDraw, styleBuilder);
this.skinSimple = skinSimple;
this.constraints = constraints;
this.end = end;
this.oddStart = oddStart;
this.oddEnd = oddEnd;
this.paused = new TreeSet<>(((TaskImpl) task).getAllPaused());
for (Day tmp = start; tmp.compareTo(end) <= 0; tmp = tmp.increment()) {
final int load = ((TaskImpl) task).getDefaultPlan().getLoadAt(tmp);
if (load == 0)
this.paused.add(tmp);
}
}
@Override
public double getShapeHeight(StringBounder stringBounder) {
final Style style = getStyle();
final ClockwiseTopRightBottomLeft padding = style.getPadding();
return padding.getTop() + getTitle().calculateDimension(stringBounder).getHeight() + padding.getBottom();
}
@Override
public void drawTitle(UGraphic ug, LabelStrategy labelStrategy, double colTitles, double colBars) {
final TextBlock title = getTitle();
final StringBounder stringBounder = ug.getStringBounder();
final XDimension2D dim = title.calculateDimension(stringBounder);
final Style style = getStyleSignature().getMergedStyle(getStyleBuilder());
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final ClockwiseTopRightBottomLeft padding = style.getPadding();
ug = ug.apply(UTranslate.dy(margin.getTop() + padding.getTop()));
if (labelStrategy.titleInFirstColumn()) {
if (labelStrategy.rightAligned())
title.drawU(ug.apply(UTranslate.dx(colTitles - dim.getWidth() - margin.getRight())));
else
title.drawU(ug.apply(UTranslate.dx(margin.getLeft())));
return;
} else if (labelStrategy.titleInLastColumn()) {
title.drawU(ug.apply(UTranslate.dx(colBars + margin.getLeft())));
return;
}
final double pos1 = timeScale.getStartingPosition(start) + 6;
final double pos2 = timeScale.getEndingPosition(end) - 6;
final double pos;
if (pos2 - pos1 > dim.getWidth())
pos = pos1;
else
pos = getOutPosition(pos2);
title.drawU(ug.apply(UTranslate.dx(pos)));
}
@Override
protected TextBlock getTitle() {
return Display.getWithNewlines(prettyDisplay).create(getFontConfiguration(), HorizontalAlignment.LEFT,
new SpriteContainerEmpty());
}
private double getOutPosition(double pos2) {
if (isThereRightArrow())
return pos2 + 18;
return pos2 + 8;
}
private boolean isThereRightArrow() {
for (GanttConstraint constraint : constraints)
if (constraint.isThereRightArrow(getTask()))
return true;
return false;
}
@Override
StyleSignature getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.task)
.withTOBECHANGED(getTask().getStereotype());
}
public void drawU(UGraphic ug) {
final double startPos = timeScale.getStartingPosition(start);
drawNote(ug.apply((new UTranslate(startPos, getYNotePosition(ug.getStringBounder())))));
drawShape(ug);
}
private double getYNotePosition(StringBounder stringBounder) {
final Style style = getStyle();
final ClockwiseTopRightBottomLeft margin = style.getMargin();
return margin.getTop() + getShapeHeight(stringBounder) + margin.getBottom();
}
private void drawNote(UGraphic ug) {
if (note == null)
return;
getOpaleNote().drawU(ug);
}
@Override
public double getHeightMax(StringBounder stringBounder) {
if (note == null)
return getFullHeightTask(stringBounder);
return getYNotePosition(stringBounder) + getOpaleNote().calculateDimension(stringBounder).getHeight();
}
private Opale getOpaleNote() {
final Style style = StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.note)
.getMergedStyle(getStyleBuilder());
final FontConfiguration fc = style.getFontConfiguration(getColorSet());
final HorizontalAlignment horizontalAlignment = style.value(PName.HorizontalAlignment).asHorizontalAlignment();
final Sheet sheet = skinSimple.sheet(fc, horizontalAlignment, CreoleMode.FULL).createSheet(note);
final double padding = style.value(PName.Padding).asDouble();
final SheetBlock1 sheet1 = new SheetBlock1(sheet, LineBreakStrategy.NONE, padding);
final HColor noteBackgroundColor = style.value(PName.BackGroundColor).asColor(getColorSet());
final HColor borderColor = style.value(PName.LineColor).asColor(getColorSet());
final double shadowing = style.value(PName.Shadowing).asDouble();
return new Opale(shadowing, borderColor, noteBackgroundColor, sheet1, false, style.getStroke());
}
public FingerPrint getFingerPrint(StringBounder stringBounder) {
final double h = getFullHeightTask(stringBounder);
final double startPos = timeScale.getStartingPosition(start);
final double endPos = timeScale.getEndingPosition(end);
return new FingerPrint(startPos, getY(stringBounder).getCurrentValue(), endPos - startPos, h);
}
public FingerPrint getFingerPrintNote(StringBounder stringBounder) {
if (note == null)
return null;
final XDimension2D dim = getOpaleNote().calculateDimension(stringBounder);
final double startPos = timeScale.getStartingPosition(start);
// final double endPos = timeScale.getEndingPosition(end);
return new FingerPrint(startPos, getY(stringBounder).getCurrentValue() + getYNotePosition(stringBounder),
dim.getWidth(), dim.getHeight());
}
private UGraphic applyColors(UGraphic ug) {
final CenterBorderColor col = this.getColors();
if (col != null && col.isOk())
return col.apply(ug);
return ug.apply(getLineColor()).apply(getBackgroundColor().bg());
}
public double getX1(TaskAttribute taskAttribute) {
final Style style = getStyleSignature().getMergedStyle(getStyleBuilder());
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final double startPos = taskAttribute == TaskAttribute.START ? timeScale.getStartingPosition(start)
: timeScale.getStartingPosition(end) + margin.getLeft();
return startPos;
}
public double getX2(TaskAttribute taskAttribute) {
final Style style = getStyleSignature().getMergedStyle(getStyleBuilder());
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final double endPos = taskAttribute == TaskAttribute.START ? timeScale.getEndingPosition(start)
: timeScale.getEndingPosition(end) - margin.getLeft();
return endPos;
}
public void drawShape(UGraphic ug) {
ug = applyColors(ug);
final Style style = getStyleSignature().getMergedStyle(getStyleBuilder());
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final double startPos = timeScale.getStartingPosition(start) + margin.getLeft();
final double endPos = timeScale.getEndingPosition(end) - margin.getRight();
if (url != null)
ug.startUrl(url);
ug = ug.apply(UTranslate.dy(margin.getTop()));
final StringBounder stringBounder = ug.getStringBounder();
final double round = style.value(PName.RoundCorner).asDouble();
final Collection off = new ArrayList<>();
for (Day pause : paused) {
final double x1 = timeScale.getStartingPosition(pause);
final double x2 = timeScale.getEndingPosition(pause);
off.add(new Segment(x1, x2));
}
final HColor backUndone = StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.undone)
.getMergedStyle(getStyleBuilder()).value(PName.BackGroundColor).asColor(getColorSet());
final RectangleTask rectangleTask = new RectangleTask(startPos, endPos, round, getCompletion(), off);
rectangleTask.draw(ug, getShapeHeight(stringBounder), backUndone, oddStart, oddEnd);
if (url != null)
ug.closeUrl();
}
}