From be69806a96bb045eea4d54b690064960e9ce5ab3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Loi=CC=88c=20PE=CC=81RON?= Date: Fri, 2 Apr 2021 16:12:41 +0200 Subject: [PATCH] Add quarterly and yearly print scale to gantt diagram --- .../plantuml/project/GanttDiagram.java | 6 + .../project/command/CommandPrintScale.java | 2 + .../plantuml/project/core/PrintScale.java | 8 +- .../project/draw/TimeHeaderQuarterly.java | 159 ++++++++++++++++++ .../project/draw/TimeHeaderYearly.java | 152 +++++++++++++++++ 5 files changed, 326 insertions(+), 1 deletion(-) create mode 100644 src/net/sourceforge/plantuml/project/draw/TimeHeaderQuarterly.java create mode 100644 src/net/sourceforge/plantuml/project/draw/TimeHeaderYearly.java diff --git a/src/net/sourceforge/plantuml/project/GanttDiagram.java b/src/net/sourceforge/plantuml/project/GanttDiagram.java index 831df891e..7e5a15b76 100644 --- a/src/net/sourceforge/plantuml/project/GanttDiagram.java +++ b/src/net/sourceforge/plantuml/project/GanttDiagram.java @@ -79,8 +79,10 @@ import net.sourceforge.plantuml.project.draw.TaskDrawSeparator; import net.sourceforge.plantuml.project.draw.TimeHeader; import net.sourceforge.plantuml.project.draw.TimeHeaderDaily; import net.sourceforge.plantuml.project.draw.TimeHeaderMonthly; +import net.sourceforge.plantuml.project.draw.TimeHeaderQuarterly; import net.sourceforge.plantuml.project.draw.TimeHeaderSimple; import net.sourceforge.plantuml.project.draw.TimeHeaderWeekly; +import net.sourceforge.plantuml.project.draw.TimeHeaderYearly; import net.sourceforge.plantuml.project.lang.CenterBorderColor; import net.sourceforge.plantuml.project.time.Day; import net.sourceforge.plantuml.project.time.DayOfWeek; @@ -236,6 +238,10 @@ public class GanttDiagram extends TitledDiagram implements ToTaskDraw, WithSprit return new TimeHeaderWeekly(openClose.getCalendar(), min, max, openClose, colorDays, colorDaysOfWeek); } else if (printScale == PrintScale.MONTHLY) { return new TimeHeaderMonthly(openClose.getCalendar(), min, max, openClose, colorDays, colorDaysOfWeek); + } else if (printScale == PrintScale.QUARTERLY) { + return new TimeHeaderQuarterly(openClose.getCalendar(), min, max, openClose, colorDays, colorDaysOfWeek); + } else if (printScale == PrintScale.YEARLY) { + return new TimeHeaderYearly(openClose.getCalendar(), min, max, openClose, colorDays, colorDaysOfWeek); } else { return new TimeHeaderDaily(openClose.getCalendar(), min, max, openClose, colorDays, colorDaysOfWeek, nameDays, printStart, printEnd); diff --git a/src/net/sourceforge/plantuml/project/command/CommandPrintScale.java b/src/net/sourceforge/plantuml/project/command/CommandPrintScale.java index 94f079916..1b7f14547 100644 --- a/src/net/sourceforge/plantuml/project/command/CommandPrintScale.java +++ b/src/net/sourceforge/plantuml/project/command/CommandPrintScale.java @@ -59,6 +59,8 @@ public class CommandPrintScale extends SingleLineCommand2 { new RegexLeaf("printscale")), // RegexLeaf.spaceOneOrMore(), // new RegexOr("SCALE", // + new RegexLeaf("yearly"), // + new RegexLeaf("quarterly"), // new RegexLeaf("monthly"), // new RegexLeaf("daily"), // new RegexLeaf("weekly")), // diff --git a/src/net/sourceforge/plantuml/project/core/PrintScale.java b/src/net/sourceforge/plantuml/project/core/PrintScale.java index 5dfe1b50b..e05aff1aa 100644 --- a/src/net/sourceforge/plantuml/project/core/PrintScale.java +++ b/src/net/sourceforge/plantuml/project/core/PrintScale.java @@ -36,7 +36,7 @@ package net.sourceforge.plantuml.project.core; public enum PrintScale { - DAILY(1), WEEKLY(4), MONTHLY(15); + DAILY(1), WEEKLY(4), MONTHLY(15), QUARTERLY(40), YEARLY(150); private final int compress; @@ -55,6 +55,12 @@ public enum PrintScale { if (value.startsWith("m")) { return MONTHLY; } + if (value.startsWith("q")) { + return QUARTERLY; + } + if (value.startsWith("y")) { + return YEARLY; + } return DAILY; } } diff --git a/src/net/sourceforge/plantuml/project/draw/TimeHeaderQuarterly.java b/src/net/sourceforge/plantuml/project/draw/TimeHeaderQuarterly.java new file mode 100644 index 000000000..ff3769638 --- /dev/null +++ b/src/net/sourceforge/plantuml/project/draw/TimeHeaderQuarterly.java @@ -0,0 +1,159 @@ +/* ======================================================================== + * PlantUML : a free UML diagram generator + * ======================================================================== + * + * (C) Copyright 2009-2020, Arnaud Roques + * + * Project Info: http://plantuml.com + * + * If you like this project or if you find it useful, you can support us at: + * + * http://plantuml.com/patreon (only 1$ per month!) + * http://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 java.util.Map; + +import net.sourceforge.plantuml.graphic.TextBlock; +import net.sourceforge.plantuml.project.LoadPlanable; +import net.sourceforge.plantuml.project.core.PrintScale; +import net.sourceforge.plantuml.project.time.Day; +import net.sourceforge.plantuml.project.time.DayOfWeek; +import net.sourceforge.plantuml.project.time.MonthYear; +import net.sourceforge.plantuml.project.timescale.TimeScaleCompressed; +import net.sourceforge.plantuml.ugraphic.UGraphic; +import net.sourceforge.plantuml.ugraphic.ULine; +import net.sourceforge.plantuml.ugraphic.UTranslate; +import net.sourceforge.plantuml.ugraphic.color.HColor; +import net.sourceforge.plantuml.ugraphic.color.HColorUtils; + +public class TimeHeaderQuarterly extends TimeHeaderCalendar { + + protected double getTimeHeaderHeight() { + return 16 + 13; + } + + public double getTimeFooterHeight() { + return 16 + 13 - 1; + } + + public TimeHeaderQuarterly(Day calendar, Day min, Day max, LoadPlanable defaultPlan, Map colorDays, + Map colorDaysOfWeek) { + super(calendar, min, max, defaultPlan, colorDays, colorDaysOfWeek, + new TimeScaleCompressed(calendar, PrintScale.MONTHLY.getCompress())); + } + + @Override + public void drawTimeHeader(final UGraphic ug, double totalHeightWithoutFooter) { + drawTextsBackground(ug, totalHeightWithoutFooter); + drawYears(ug); + drawQuarters(ug.apply(UTranslate.dy(16))); + drawHline(ug, 0); + drawHline(ug, 16); + drawHline(ug, getFullHeaderHeight()); + } + + @Override + public void drawTimeFooter(UGraphic ug) { + ug = ug.apply(UTranslate.dy(3)); + drawQuarters(ug); + drawYears(ug.apply(UTranslate.dy(13))); + drawHline(ug, 0); + drawHline(ug, 13); + drawHline(ug, getTimeFooterHeight()); + } + + private void drawYears(final UGraphic ug) { + MonthYear last = null; + double lastChange = -1; + for (Day wink = min; wink.compareTo(max) < 0; wink = wink.increment()) { + final double x1 = getTimeScale().getStartingPosition(wink); + if (last == null || wink.monthYear().year() != last.year()) { + drawVbar(ug, x1, 0, 15); + if (last != null) { + printYear(ug, last, lastChange, x1); + } + lastChange = x1; + last = wink.monthYear(); + } + } + final double x1 = getTimeScale().getStartingPosition(max.increment()); + if (x1 > lastChange) { + printYear(ug, last, lastChange, x1); + } + drawVbar(ug, getTimeScale().getEndingPosition(max), 0, 15); + } + + private void drawQuarters(UGraphic ug) { + String last = null; + double lastChange = -1; + for (Day wink = min; wink.compareTo(max) < 0; wink = wink.increment()) { + final double x1 = getTimeScale().getStartingPosition(wink); + if (quarter(wink).equals(last) == false) { + drawVbar(ug, x1, 0, 12); + if (last != null) { + printQuarter(ug, last, lastChange, x1); + } + lastChange = x1; + last = quarter(wink); + } + } + final double x1 = getTimeScale().getStartingPosition(max.increment()); + if (x1 > lastChange) { + printQuarter(ug, last, lastChange, x1); + } + drawVbar(ug, getTimeScale().getEndingPosition(max), 0, 12); + } + + private String quarter(Day day) { + return "Q" + (( day.month().ordinal() + 3 ) / 3); + } + + private void printYear(UGraphic ug, MonthYear monthYear, double start, double end) { + final TextBlock small = getTextBlock("" + monthYear.year(), 12, true, HColorUtils.BLACK); + printCentered(ug, start, end, small); + } + + private void printQuarter(UGraphic ug, String quarter, double start, double end) { + final TextBlock small = getTextBlock(quarter, 10, false, HColorUtils.BLACK); + printCentered(ug, start, end, small); + } + + private void drawVbar(UGraphic ug, double x, double y1, double y2) { + final ULine vbar = ULine.vline(y2 - y1); + ug.apply(HColorUtils.LIGHT_GRAY).apply(new UTranslate(x, y1)).draw(vbar); + } + + private void printLeft(UGraphic ug, TextBlock text, double start) { + text.drawU(ug.apply(UTranslate.dx(start))); + } + + @Override + public double getFullHeaderHeight() { + return getTimeHeaderHeight(); + } + +} diff --git a/src/net/sourceforge/plantuml/project/draw/TimeHeaderYearly.java b/src/net/sourceforge/plantuml/project/draw/TimeHeaderYearly.java new file mode 100644 index 000000000..138d643d9 --- /dev/null +++ b/src/net/sourceforge/plantuml/project/draw/TimeHeaderYearly.java @@ -0,0 +1,152 @@ +/* ======================================================================== + * PlantUML : a free UML diagram generator + * ======================================================================== + * + * (C) Copyright 2009-2020, Arnaud Roques + * + * Project Info: http://plantuml.com + * + * If you like this project or if you find it useful, you can support us at: + * + * http://plantuml.com/patreon (only 1$ per month!) + * http://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 java.util.Map; + +import net.sourceforge.plantuml.graphic.TextBlock; +import net.sourceforge.plantuml.project.LoadPlanable; +import net.sourceforge.plantuml.project.core.PrintScale; +import net.sourceforge.plantuml.project.time.Day; +import net.sourceforge.plantuml.project.time.DayOfWeek; +import net.sourceforge.plantuml.project.time.MonthYear; +import net.sourceforge.plantuml.project.timescale.TimeScaleCompressed; +import net.sourceforge.plantuml.ugraphic.UGraphic; +import net.sourceforge.plantuml.ugraphic.ULine; +import net.sourceforge.plantuml.ugraphic.UTranslate; +import net.sourceforge.plantuml.ugraphic.color.HColor; +import net.sourceforge.plantuml.ugraphic.color.HColorUtils; + +public class TimeHeaderYearly extends TimeHeaderCalendar { + + protected double getTimeHeaderHeight() { + return 16 + 13; + } + + public double getTimeFooterHeight() { + return 16 + 13 - 1; + } + + public TimeHeaderYearly(Day calendar, Day min, Day max, LoadPlanable defaultPlan, Map colorDays, + Map colorDaysOfWeek) { + super(calendar, min, max, defaultPlan, colorDays, colorDaysOfWeek, + new TimeScaleCompressed(calendar, PrintScale.MONTHLY.getCompress())); + } + + @Override + public void drawTimeHeader(final UGraphic ug, double totalHeightWithoutFooter) { + drawTextsBackground(ug, totalHeightWithoutFooter); + drawYears(ug); + drawHline(ug, 0); + drawHline(ug, getFullHeaderHeight()); + } + + @Override + public void drawTimeFooter(UGraphic ug) { + ug = ug.apply(UTranslate.dy(3)); + drawYears(ug); + drawHline(ug, 0); + drawHline(ug, getTimeFooterHeight()); + } + + private void drawYears(final UGraphic ug) { + MonthYear last = null; + double lastChange = -1; + for (Day wink = min; wink.compareTo(max) < 0; wink = wink.increment()) { + final double x1 = getTimeScale().getStartingPosition(wink); + if (last == null || wink.monthYear().year() != last.year()) { + drawVbar(ug, x1, 0, 15); + if (last != null) { + printYear(ug, last, lastChange, x1); + } + lastChange = x1; + last = wink.monthYear(); + } + } + final double x1 = getTimeScale().getStartingPosition(max.increment()); + if (x1 > lastChange) { + printYear(ug, last, lastChange, x1); + } + drawVbar(ug, getTimeScale().getEndingPosition(max), 0, 15); + } + + private void drawMonths(UGraphic ug) { + MonthYear last = null; + double lastChange = -1; + for (Day wink = min; wink.compareTo(max) < 0; wink = wink.increment()) { + final double x1 = getTimeScale().getStartingPosition(wink); + if (wink.monthYear().equals(last) == false) { + drawVbar(ug, x1, 0, 12); + if (last != null) { + printMonth(ug, last, lastChange, x1); + } + lastChange = x1; + last = wink.monthYear(); + } + } + final double x1 = getTimeScale().getStartingPosition(max.increment()); + if (x1 > lastChange) { + printMonth(ug, last, lastChange, x1); + } + drawVbar(ug, getTimeScale().getEndingPosition(max), 0, 12); + } + + private void printYear(UGraphic ug, MonthYear monthYear, double start, double end) { + final TextBlock small = getTextBlock("" + monthYear.year(), 12, true, HColorUtils.BLACK); + printCentered(ug, start, end, small); + } + + private void printMonth(UGraphic ug, MonthYear monthYear, double start, double end) { + final TextBlock small = getTextBlock(monthYear.shortName(), 10, false, HColorUtils.BLACK); + final TextBlock big = getTextBlock(monthYear.longName(), 10, false, HColorUtils.BLACK); + printCentered(ug, start, end, small, big); + } + + private void drawVbar(UGraphic ug, double x, double y1, double y2) { + final ULine vbar = ULine.vline(y2 - y1); + ug.apply(HColorUtils.LIGHT_GRAY).apply(new UTranslate(x, y1)).draw(vbar); + } + + private void printLeft(UGraphic ug, TextBlock text, double start) { + text.drawU(ug.apply(UTranslate.dx(start))); + } + + @Override + public double getFullHeaderHeight() { + return getTimeHeaderHeight(); + } + +}