net.sourceforge.plantuml.project.draw.TimeHeader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.HColors;
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.font.UFont;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
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.TimeHeaderParameters;
import net.sourceforge.plantuml.project.time.Day;
import net.sourceforge.plantuml.project.timescale.TimeScale;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
public abstract class TimeHeader {
// ::remove folder when __HAXE__
private final TimeScale timeScale;
protected final TimeHeaderParameters thParam;
public TimeHeader(TimeHeaderParameters thParam, TimeScale timeScale) {
this.thParam = thParam;
this.timeScale = timeScale;
}
protected final boolean isBold2(Day wink) {
return thParam.getVerticalSeparatorBefore().contains(wink);
}
protected final Day getMin() {
return thParam.getMin();
}
protected final Day getMax() {
return thParam.getMax();
}
protected final HColor closedBackgroundColor() {
return thParam.getClosedStyle().value(PName.BackGroundColor).asColor(thParam.getColorSet());
}
protected final HColor closedFontColor() {
return thParam.getClosedStyle().value(PName.FontColor).asColor(thParam.getColorSet());
}
protected final HColor openFontColor() {
return thParam.getTimelineStyle().value(PName.FontColor).asColor(thParam.getColorSet());
}
protected final HColor getLineColor() {
return thParam.getTimelineStyle().value(PName.LineColor).asColor(thParam.getColorSet());
}
public abstract double getTimeHeaderHeight(StringBounder stringBounder);
public abstract double getTimeFooterHeight(StringBounder stringBounder);
public abstract double getFullHeaderHeight(StringBounder stringBounder);
public abstract void drawTimeHeader(UGraphic ug, double totalHeightWithoutFooter);
public abstract void drawTimeFooter(UGraphic ug);
public final TimeScale getTimeScale() {
return timeScale;
}
protected final void drawHline(UGraphic ug, double y) {
final double xmin = getTimeScale().getStartingPosition(thParam.getMin());
final double xmax = getTimeScale().getEndingPosition(thParam.getMax());
final ULine hline = ULine.hline(xmax - xmin);
ug.apply(getLineColor()).apply(UTranslate.dy(y)).draw(hline);
}
protected final void drawVline(UGraphic ug, double x, double y1, double y2) {
final ULine vbar = ULine.vline(y2 - y1);
ug.apply(new UTranslate(x, y1)).draw(vbar);
}
final protected FontConfiguration getFontConfiguration(UFont font, boolean bold, HColor color) {
if (bold)
font = font.bold();
return FontConfiguration.create(font, color, color, null);
}
protected final TextBlock getTextBlock(SName param, String text, boolean bold, HColor color) {
final UFont font = thParam.getStyle(SName.timeline, param).getUFont();
final FontConfiguration fontConfiguration = getFontConfiguration(font, bold, color);
return Display.getWithNewlines(text).create(fontConfiguration, HorizontalAlignment.LEFT,
new SpriteContainerEmpty());
}
protected final void printCentered(UGraphic ug, TextBlock text, double start, double end) {
final double width = text.calculateDimension(ug.getStringBounder()).getWidth();
final double available = end - start;
final double diff = Math.max(0, available - width);
text.drawU(ug.apply(UTranslate.dx(start + diff / 2)));
}
protected final void printCentered(UGraphic ug, boolean hideIfTooBig, double start, double end,
TextBlock... texts) {
final double available = end - start;
for (int i = texts.length - 1; i >= 0; i--) {
final TextBlock text = texts[i];
final double width = text.calculateDimension(ug.getStringBounder()).getWidth();
if ((i == 0 && hideIfTooBig == false) || width <= available) {
final double diff = Math.max(0, available - width);
text.drawU(ug.apply(UTranslate.dx(start + diff / 2)));
return;
}
}
}
protected final void drawRectangle(UGraphic ug, double height, double x1, double x2) {
if (height == 0)
return;
ug = ug.apply(HColors.none());
ug = ug.apply(new UTranslate(x1, getFullHeaderHeight(ug.getStringBounder())));
ug.draw(URectangle.build(x2 - x1, height));
}
protected void printVerticalSeparators(UGraphic ug, double totalHeightWithoutFooter) {
ug = thParam.forVerticalSeparator(ug);
for (Day wink = getMin(); wink.compareTo(getMax()) <= 0; wink = wink.increment())
if (isBold2(wink))
drawVline(ug, getTimeScale().getStartingPosition(wink),
getFullHeaderHeight(ug.getStringBounder()), totalHeightWithoutFooter);
}
}