net.sourceforge.plantuml.project.draw.TimeHeaderQuarterly 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.UTranslate;
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.TimeScaleCompressed;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
public class TimeHeaderQuarterly extends TimeHeaderCalendar {
@Override
public double getTimeHeaderHeight(StringBounder stringBounder) {
final double h1 = thParam.getStyle(SName.timeline, SName.year).value(PName.FontSize).asDouble();
final double h2 = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble();
return h1 + h2 + 5;
}
@Override
public double getTimeFooterHeight(StringBounder stringBounder) {
final double h1 = thParam.getStyle(SName.timeline, SName.year).value(PName.FontSize).asDouble();
final double h2 = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble();
return h1 + h2 + 5;
}
@Override
public double getFullHeaderHeight(StringBounder stringBounder) {
return getTimeHeaderHeight(stringBounder);
}
public TimeHeaderQuarterly(StringBounder stringBounder, TimeHeaderParameters thParam, Day printStart) {
super(thParam, new TimeScaleCompressed(thParam.getCellWidth(stringBounder), thParam.getStartingDay(),
thParam.getScale(), printStart));
}
@Override
public void drawTimeHeader(final UGraphic ug, double totalHeightWithoutFooter) {
drawTextsBackground(ug, totalHeightWithoutFooter);
drawYears(ug);
final double h1 = thParam.getStyle(SName.timeline, SName.year).value(PName.FontSize).asDouble();
final double h2 = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble();
drawQuarters(ug.apply(UTranslate.dy(h1 + 2)));
printVerticalSeparators(ug, totalHeightWithoutFooter);
drawHline(ug, 0);
drawHline(ug, h1 + 2);
drawHline(ug, h1 + 2 + h2 + 2);
// drawHline(ug, getFullHeaderHeight(ug.getStringBounder()));
}
@Override
public void drawTimeFooter(UGraphic ug) {
final double h1 = thParam.getStyle(SName.timeline, SName.year).value(PName.FontSize).asDouble();
final double h2 = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble();
// ug = ug.apply(UTranslate.dy(3));
drawQuarters(ug);
drawYears(ug.apply(UTranslate.dy(h2 + 2)));
drawHline(ug, 0);
drawHline(ug, h2 + 2);
drawHline(ug, h1 + 2 + h2 + 2);
// drawHline(ug, getTimeFooterHeight(ug.getStringBounder()));
}
private void drawYears(final UGraphic ug) {
final double h1 = thParam.getStyle(SName.timeline, SName.year).value(PName.FontSize).asDouble();
MonthYear last = null;
double lastChange = -1;
for (Day wink = getMin(); wink.compareTo(getMax()) < 0; wink = wink.increment()) {
final double x1 = getTimeScale().getStartingPosition(wink);
if (last == null || wink.monthYear().year() != last.year()) {
drawVline(ug.apply(getLineColor()), x1, 0, h1 + 2);
if (last != null)
printYear(ug, last, lastChange, x1);
lastChange = x1;
last = wink.monthYear();
}
}
final double x1 = getTimeScale().getStartingPosition(getMax().increment());
if (x1 > lastChange)
printYear(ug, last, lastChange, x1);
drawVline(ug.apply(getLineColor()), getTimeScale().getEndingPosition(getMax()), 0, h1 + 2);
}
private void drawQuarters(UGraphic ug) {
final double h2 = thParam.getStyle(SName.timeline, SName.month).value(PName.FontSize).asDouble();
String last = null;
double lastChange = -1;
for (Day wink = getMin(); wink.compareTo(getMax()) < 0; wink = wink.increment()) {
final double x1 = getTimeScale().getStartingPosition(wink);
if (quarter(wink).equals(last) == false) {
drawVline(ug.apply(getLineColor()), x1, 0, h2 + 2);
if (last != null)
printQuarter(ug, last, lastChange, x1);
lastChange = x1;
last = quarter(wink);
}
}
final double x1 = getTimeScale().getStartingPosition(getMax().increment());
if (x1 > lastChange)
printQuarter(ug, last, lastChange, x1);
drawVline(ug.apply(getLineColor()), getTimeScale().getEndingPosition(getMax()), 0, h2 + 2);
}
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(SName.month, "" + monthYear.year(), true, openFontColor());
printCentered(ug, false, start, end, small);
}
private void printQuarter(UGraphic ug, String quarter, double start, double end) {
final TextBlock small = getTextBlock(SName.day, quarter, false, openFontColor());
printCentered(ug, false, start, end, small);
}
private void printLeft(UGraphic ug, TextBlock text, double start) {
text.drawU(ug.apply(UTranslate.dx(start)));
}
}