net.sourceforge.plantuml.project.draw.TaskDrawSeparator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-epl Show documentation
Show all versions of plantuml-epl 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 Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.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 EPL license.
*
* The generated images can then be used without any reference to the EPL 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.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColorSet;
import net.sourceforge.plantuml.klimt.creole.Display;
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.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.klimt.sprite.SpriteContainerEmpty;
import net.sourceforge.plantuml.project.LabelStrategy;
import net.sourceforge.plantuml.project.core.Task;
import net.sourceforge.plantuml.project.core.TaskAttribute;
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.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 class TaskDrawSeparator implements TaskDraw {
private final TimeScale timeScale;
private Real y;
private final Day min;
private final Day max;
private final String name;
private final StyleBuilder styleBuilder;
private final HColorSet colorSet;
public TaskDrawSeparator(String name, TimeScale timeScale, Real y, Day min, Day max, StyleBuilder styleBuilder,
HColorSet colorSet) {
this.styleBuilder = styleBuilder;
this.colorSet = colorSet;
this.name = name;
this.y = y;
this.timeScale = timeScale;
this.min = min;
this.max = max;
}
@Override
public void drawTitle(UGraphic ug, LabelStrategy labelStrategy, double colTitles, double colBars) {
final ClockwiseTopRightBottomLeft padding = getStyle().getPadding();
final ClockwiseTopRightBottomLeft margin = getStyle().getMargin();
final double dx = margin.getLeft() + padding.getLeft();
final double dy = margin.getTop() + padding.getTop();
final double x;
if (labelStrategy.titleInFirstColumn()) {
x = colTitles;
} else {
x = 0;
}
getTitle().drawU(ug.apply(new UTranslate(x + dx, dy)));
}
@Override
public double getTitleWidth(StringBounder stringBounder) {
// Never used in first column
return 0;
}
private StyleSignatureBasic getStyleSignature() {
return StyleSignatureBasic.of(SName.root, SName.element, SName.ganttDiagram, SName.separator);
}
private Style getStyle() {
return getStyleSignature().getMergedStyle(styleBuilder);
}
private TextBlock getTitle() {
if (name == null) {
return TextBlockUtils.empty(0, 0);
}
return Display.getWithNewlines(this.name).create(getFontConfiguration(), HorizontalAlignment.LEFT,
new SpriteContainerEmpty());
}
private FontConfiguration getFontConfiguration() {
return getStyle().getFontConfiguration(colorSet);
}
@Override
public void drawU(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final double widthTitle = getTitle().calculateDimension(stringBounder).getWidth();
final double start = timeScale.getStartingPosition(min);
// final double start2 = start1 + widthTitle;
final double end = timeScale.getEndingPosition(max);
final ClockwiseTopRightBottomLeft padding = getStyle().getPadding();
final ClockwiseTopRightBottomLeft margin = getStyle().getMargin();
ug = ug.apply(new UTranslate(0, margin.getTop()));
final HColor backColor = getStyle().value(PName.BackGroundColor).asColor(colorSet);
if (backColor.isTransparent() == false) {
final double height = padding.getTop() + getTextHeight(stringBounder) + padding.getBottom();
if (height > 0) {
final URectangle rect = URectangle.build(end - start, height);
ug.apply(backColor.bg()).draw(rect);
}
}
final HColor lineColor = getStyle().value(PName.LineColor).asColor(colorSet);
ug = ug.apply(lineColor);
ug = ug.apply(UTranslate.dy(padding.getTop() + getTextHeight(stringBounder) / 2));
if (widthTitle == 0) {
final ULine line = ULine.hline(end - start);
ug.draw(line);
} else {
if (padding.getLeft() > 1) {
final ULine line1 = ULine.hline(padding.getLeft());
ug.draw(line1);
}
final double x1 = padding.getLeft() + margin.getLeft() + widthTitle + margin.getRight();
final double x2 = end - 1;
final ULine line2 = ULine.hline(x2 - x1);
ug.apply(UTranslate.dx(x1)).draw(line2);
}
}
@Override
public FingerPrint getFingerPrint(StringBounder stringBounder) {
final double h = getFullHeightTask(stringBounder);
final double end = timeScale.getEndingPosition(max);
return new FingerPrint(0, getY(stringBounder).getCurrentValue(), end,
getY(stringBounder).getCurrentValue() + h);
}
@Override
public FingerPrint getFingerPrintNote(StringBounder stringBounder) {
return null;
}
@Override
public double getFullHeightTask(StringBounder stringBounder) {
final ClockwiseTopRightBottomLeft padding = getStyle().getPadding();
final ClockwiseTopRightBottomLeft margin = getStyle().getMargin();
return margin.getTop() + padding.getTop() + getTextHeight(stringBounder) + padding.getBottom()
+ margin.getBottom();
}
private double getTextHeight(StringBounder stringBounder) {
return getTitle().calculateDimension(stringBounder).getHeight();
}
@Override
public Real getY(StringBounder stringBounder) {
return y;
}
@Override
public TaskDraw getTrueRow() {
return null;
}
@Override
public void setColorsAndCompletion(CenterBorderColor colors, int completion, Url url, Display note) {
}
@Override
public Task getTask() {
throw new UnsupportedOperationException();
}
@Override
public double getY(StringBounder stringBounder, Direction direction) {
throw new UnsupportedOperationException();
}
@Override
public double getHeightMax(StringBounder stringBounder) {
return getFullHeightTask(stringBounder);
}
@Override
public double getX1(TaskAttribute taskAttribute) {
throw new UnsupportedOperationException();
}
@Override
public double getX2(TaskAttribute taskAttribute) {
throw new UnsupportedOperationException();
}
}