AbstractTaskDraw.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.project.draw;
import net.sourceforge.plantuml.klimt.LineBreakStrategy;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColorSet;
import net.sourceforge.plantuml.klimt.color.HColors;
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.shape.TextBlock;
import net.sourceforge.plantuml.project.ToTaskDraw;
import net.sourceforge.plantuml.project.core.GSide;
import net.sourceforge.plantuml.project.core.Task;
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.skin.Pragma;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
import net.sourceforge.plantuml.style.ISkinParam;
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;
import net.sourceforge.plantuml.url.Url;
public abstract class AbstractTaskDraw implements TaskDraw {
private CenterBorderColor colors;
private int completion = 100;
protected Url url;
protected Display note;
protected Stereotype noteStereotype;
protected final TimeScale timeScale;
private Real y;
protected final String prettyDisplay;
protected final Day start;
private final StyleBuilder styleBuilder;
private final Task task;
private final ToTaskDraw toTaskDraw;
private final ISkinParam skinParam;
@Override
final public String toString() {
return super.toString() + " " + task;
}
final public void setColorsAndCompletion(CenterBorderColor colors, int completion, Url url, Display note,
Stereotype noteStereotype) {
this.colors = colors;
this.completion = completion;
this.url = url;
this.note = note;
this.noteStereotype = noteStereotype;
}
public AbstractTaskDraw(TimeScale timeScale, Real y, String prettyDisplay, Day start, Task task,
ToTaskDraw toTaskDraw, StyleBuilder styleBuilder, ISkinParam skinParam) {
this.y = y;
this.skinParam = skinParam;
this.styleBuilder = styleBuilder;
this.toTaskDraw = toTaskDraw;
this.start = start;
this.prettyDisplay = prettyDisplay;
this.timeScale = timeScale;
this.task = task;
}
abstract StyleSignature getStyleSignature();
private StyleSignatureBasic getStyleSignatureUnstarted() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.task, SName.unstarted);
}
final protected HColor getLineColor() {
final HColor unstarted = getStyleSignatureUnstarted().getMergedStyle(styleBuilder).value(PName.LineColor)
.asColor(getColorSet());
final HColor regular = getStyle().value(PName.LineColor).asColor(getColorSet());
return HColors.unlinear(unstarted, regular, completion);
}
final protected HColor getBackgroundColor() {
final HColor unstarted = getStyleSignatureUnstarted().getMergedStyle(styleBuilder).value(PName.BackGroundColor)
.asColor(getColorSet());
final HColor regular = getStyle().value(PName.BackGroundColor).asColor(getColorSet());
return HColors.unlinear(unstarted, regular, completion);
}
final protected FontConfiguration getFontConfiguration() {
return getStyle().getFontConfiguration(getColorSet());
}
final protected Style getStyle() {
return getStyleSignature().getMergedStyle(styleBuilder);
}
final public double getTitleWidth(StringBounder stringBounder) {
final Style style = getStyleSignature().getMergedStyle(getStyleBuilder());
final ClockwiseTopRightBottomLeft margin = style.getMargin();
return margin.getLeft() + getTitle().calculateDimension(stringBounder).getWidth() + margin.getRight();
}
protected abstract TextBlock getTitle();
abstract protected double getShapeHeight(StringBounder stringBounder);
final public double getFullHeightTask(StringBounder stringBounder) {
final Style style = getStyle();
final ClockwiseTopRightBottomLeft margin = style.getMargin();
return margin.getTop() + getShapeHeight(stringBounder) + margin.getBottom();
}
final public TaskDraw getTrueRow() {
return toTaskDraw.getTaskDraw(task.getRow());
}
@Override
final public Real getY(StringBounder stringBounder) {
if (task.getRow() == null)
return y;
return getTrueRow().getY(stringBounder);
}
public final Task getTask() {
return task;
}
@Override
public double getY(StringBounder stringBounder, GSide side) {
final Style style = getStyle();
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final double y1 = margin.getTop() + getY(stringBounder).getCurrentValue();
final double y2 = y1 + getShapeHeight(stringBounder);
if (side.isTop())
return y1;
if (side.isBottom())
return y2;
return (y1 + y2) / 2;
}
protected final StyleBuilder getStyleBuilder() {
return styleBuilder;
}
protected final HColorSet getColorSet() {
return toTaskDraw.getIHtmlColorSet();
}
protected CenterBorderColor getColors() {
return colors;
}
protected int getCompletion() {
return completion;
}
protected Pragma getPragma() {
return skinParam.getPragma();
}
protected Opale getOpaleNote() {
final Style style = StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.note)
.withTOBECHANGED(noteStereotype).getMergedStyle(getStyleBuilder());
final FontConfiguration fc = style.getFontConfiguration(getColorSet());
final HorizontalAlignment horizontalAlignment = style.value(PName.HorizontalAlignment).asHorizontalAlignment();
final Sheet sheet = skinParam.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.getShadowing();
return new Opale(shadowing, borderColor, noteBackgroundColor, sheet1, false, style.getStroke());
}
protected void drawNote(UGraphic ug) {
if (note == null)
return;
getOpaleNote().drawU(ug);
}
// public ISkinParam getSkinParam() {
// return skinParam;
// }
}