net.sourceforge.plantuml.project.TimeHeaderParameters Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit 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 MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* 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 MIT license.
*
* The generated images can then be used without any reference to the MIT 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;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColorSet;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.project.time.Day;
import net.sourceforge.plantuml.project.time.DayOfWeek;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
public class TimeHeaderParameters implements GanttStyle {
private final Map colorDays;
private final double scale;
private final Day min;
private final Day max;
private final HColorSet colorSet;
private final GanttStyle ganttStyle;
private final Locale locale;
private final OpenClose openClose;
private final Map colorDaysOfWeek;
private final Set verticalSeparatorBefore;
public TimeHeaderParameters(Map colorDays, double scale, Day min, Day max, HColorSet colorSet,
Locale locale, OpenClose openClose, Map colorDaysOfWeek,
Set verticalSeparatorBefore, GanttStyle ganttStyle) {
this.colorDays = colorDays;
this.scale = scale;
this.min = min;
this.max = max;
this.colorSet = Objects.requireNonNull(colorSet);
this.ganttStyle = ganttStyle;
this.locale = locale;
this.openClose = openClose;
this.colorDaysOfWeek = colorDaysOfWeek;
this.verticalSeparatorBefore = verticalSeparatorBefore;
}
public HColor getColor(Day wink) {
return colorDays.get(wink);
}
public HColor getColor(DayOfWeek dayOfWeek) {
return colorDaysOfWeek.get(dayOfWeek);
}
public final double getScale() {
return scale;
}
public final Day getMin() {
return min;
}
public final Day getMax() {
return max;
}
public final HColorSet getColorSet() {
return colorSet;
}
public final Style getTimelineStyle() {
return getStyle(SName.timeline);
}
public final Style getClosedStyle() {
return getStyle(SName.closed);
}
public final Locale getLocale() {
return locale;
}
public final LoadPlanable getLoadPlanable() {
return openClose;
}
public Day getStartingDay() {
return openClose.getStartingDay();
}
public final Set getVerticalSeparatorBefore() {
return verticalSeparatorBefore;
}
public final UGraphic forVerticalSeparator(UGraphic ug) {
final Style style = getStyle(SName.verticalSeparator);
final HColor color = style.value(PName.LineColor).asColor(getColorSet());
final UStroke stroke = style.getStroke();
return ug.apply(color).apply(stroke);
}
@Override
public final Style getStyle(SName param1, SName param2) {
return ganttStyle.getStyle(param1, param2);
}
@Override
public Style getStyle(SName param) {
return ganttStyle.getStyle(param);
}
public double getCellWidth(StringBounder stringBounder) {
final double w = getStyle(SName.timeline, SName.day).value(PName.FontSize).asDouble();
return w * 1.6;
}
}