net.sourceforge.plantuml.project.draw.TimeHeaderDaily 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 java.util.Map;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.project.TimeHeaderParameters;
import net.sourceforge.plantuml.project.time.Day;
import net.sourceforge.plantuml.project.time.MonthYear;
import net.sourceforge.plantuml.project.timescale.TimeScaleDaily;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
public class TimeHeaderDaily extends TimeHeaderCalendar {
private double getH1(StringBounder stringBounder) {
final double h = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble() + 2;
return h;
}
private double getH2(StringBounder stringBounder) {
final double h = thParam.getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble() + 2;
return getH1(stringBounder) + h;
}
private double getH3(StringBounder stringBounder) {
final double h = thParam.getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble() + 3;
return getH2(stringBounder) + h;
}
@Override
public double getTimeHeaderHeight(StringBounder stringBounder) {
return getH3(stringBounder);
}
@Override
public double getTimeFooterHeight(StringBounder stringBounder) {
final double h1 = thParam.getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble();
final double h2 = thParam.getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble();
final double h3 = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble();
return h1 + h2 + h3 + 8;
}
private double getHeaderNameDayHeight() {
if (nameDays.size() > 0) {
final double h = thParam.getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble() + 6;
return h;
}
return 0;
}
@Override
public double getFullHeaderHeight(StringBounder stringBounder) {
return getTimeHeaderHeight(stringBounder) + getHeaderNameDayHeight();
}
private final Map nameDays;
public TimeHeaderDaily(StringBounder stringBounder, TimeHeaderParameters thParam, Map nameDays,
Day printStart) {
super(thParam, new TimeScaleDaily(thParam.getCellWidth(stringBounder), thParam.getStartingDay(),
thParam.getScale(), printStart));
this.nameDays = nameDays;
}
@Override
public void drawTimeHeader(final UGraphic ug, double totalHeightWithoutFooter) {
drawTextsBackground(ug, totalHeightWithoutFooter);
drawTextsDayOfWeek(ug.apply(UTranslate.dy(getH1(ug.getStringBounder()))));
drawTextDayOfMonth(ug.apply(UTranslate.dy(getH2(ug.getStringBounder()))));
drawMonths(ug);
printVerticalSeparators(ug, totalHeightWithoutFooter);
printNamedDays(ug);
drawHline(ug, getFullHeaderHeight(ug.getStringBounder()));
drawHline(ug, totalHeightWithoutFooter);
}
@Override
protected void printVerticalSeparators(final UGraphic ug, double totalHeightWithoutFooter) {
final UGraphic ugVerticalSeparator = thParam.forVerticalSeparator(ug);
final UGraphic ugLineColor = ug.apply(getLineColor());
for (Day wink = getMin(); wink.compareTo(getMax()) <= 0; wink = wink.increment())
if (isBold2(wink))
drawVline(ugVerticalSeparator, getTimeScale().getStartingPosition(wink),
getFullHeaderHeight(ug.getStringBounder()), totalHeightWithoutFooter);
else
drawVline(ugLineColor, getTimeScale().getStartingPosition(wink),
getFullHeaderHeight(ug.getStringBounder()), totalHeightWithoutFooter);
drawVline(ugLineColor, getTimeScale().getEndingPosition(getMax()), getFullHeaderHeight(ug.getStringBounder()),
totalHeightWithoutFooter);
}
@Override
public void drawTimeFooter(UGraphic ug) {
final double h = thParam.getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble() + 2;
drawTextsDayOfWeek(ug);
drawTextDayOfMonth(ug.apply(UTranslate.dy(h + 2)));
drawMonths(ug.apply(UTranslate.dy(2 * h + 3)));
}
private void drawTextsDayOfWeek(UGraphic ug) {
for (Day wink = getMin(); wink.compareTo(getMax()) <= 0; wink = wink.increment()) {
final double x1 = getTimeScale().getStartingPosition(wink);
final double x2 = getTimeScale().getEndingPosition(wink);
final HColor textColor = getTextBackColor(wink);
printCentered(ug, getTextBlock(SName.day, wink.getDayOfWeek().shortName(locale()), false, textColor), x1,
x2);
}
}
private void drawTextDayOfMonth(UGraphic ug) {
for (Day wink = getMin(); wink.compareTo(getMax()) <= 0; wink = wink.increment()) {
final double x1 = getTimeScale().getStartingPosition(wink);
final double x2 = getTimeScale().getEndingPosition(wink);
final HColor textColor = getTextBackColor(wink);
printCentered(ug, getTextBlock(SName.day, "" + wink.getDayOfMonth(), false, textColor), x1, x2);
}
}
private HColor getTextBackColor(Day wink) {
if (getLoadAt(wink) <= 0)
return closedFontColor();
return openFontColor();
}
private void drawMonths(final UGraphic ug) {
MonthYear last = null;
double lastChangeMonth = -1;
for (Day wink = getMin(); wink.compareTo(getMax()) <= 0; wink = wink.increment()) {
final double x1 = getTimeScale().getStartingPosition(wink);
if (wink.monthYear().equals(last) == false) {
if (last != null)
printMonth(ug, last, lastChangeMonth, x1);
lastChangeMonth = x1;
last = wink.monthYear();
}
}
final double x1 = getTimeScale().getStartingPosition(getMax().increment());
if (x1 > lastChangeMonth)
printMonth(ug, last, lastChangeMonth, x1);
}
private void printMonth(UGraphic ug, MonthYear monthYear, double start, double end) {
final TextBlock tiny = getTextBlock(SName.month, monthYear.shortName(locale()), true, openFontColor());
final TextBlock small = getTextBlock(SName.month, monthYear.longName(locale()), true, openFontColor());
final TextBlock big = getTextBlock(SName.month, monthYear.longNameYYYY(locale()), true, openFontColor());
printCentered(ug, false, start, end, tiny, small, big);
}
private void printNamedDays(final UGraphic ug) {
if (nameDays.size() > 0) {
String last = null;
for (Day wink = getMin(); wink.compareTo(getMax().increment()) <= 0; wink = wink.increment()) {
final String name = nameDays.get(wink);
if (name != null && name.equals(last) == false) {
final double x1 = getTimeScale().getStartingPosition(wink);
final double x2 = getTimeScale().getEndingPosition(wink);
final TextBlock label = getTextBlock(SName.month, name, false, openFontColor());
final double h = label.calculateDimension(ug.getStringBounder()).getHeight();
double y1 = getTimeHeaderHeight(ug.getStringBounder());
double y2 = getFullHeaderHeight(ug.getStringBounder());
final double position = getH3(ug.getStringBounder());
label.drawU(ug.apply(new UTranslate(x1, position)));
}
last = name;
}
}
}
}