net.sourceforge.plantuml.project.draw.AbstractTaskDraw Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 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 GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* 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 GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 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 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.Display;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.project.ToTaskDraw;
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.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.StyleSignatureBasic;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.utils.Direction;
public abstract class AbstractTaskDraw implements TaskDraw {
private CenterBorderColor colors;
private int completion = 100;
protected Url url;
protected Display note;
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;
@Override
final public String toString() {
return super.toString() + " " + task;
}
final public void setColorsAndCompletion(CenterBorderColor colors, int completion, Url url, Display note) {
this.colors = colors;
this.completion = completion;
this.url = url;
this.note = note;
}
public AbstractTaskDraw(TimeScale timeScale, Real y, String prettyDisplay, Day start, ISkinParam skinParam,
Task task, ToTaskDraw toTaskDraw, StyleBuilder styleBuilder) {
this.y = y;
this.styleBuilder = styleBuilder;
this.toTaskDraw = toTaskDraw;
this.start = start;
this.prettyDisplay = prettyDisplay;
this.timeScale = timeScale;
this.task = task;
}
abstract StyleSignatureBasic 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 final double getY(StringBounder stringBounder, Direction direction) {
final Style style = getStyle();
final ClockwiseTopRightBottomLeft margin = style.getMargin();
final ClockwiseTopRightBottomLeft padding = style.getPadding();
final double y1 = margin.getTop() + getY(stringBounder).getCurrentValue();
final double y2 = y1 + getShapeHeight(stringBounder);
if (direction == Direction.UP)
return y1;
if (direction == Direction.DOWN)
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;
}
}