net.sourceforge.plantuml.klimt.drawing.svg.SvgOption 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.klimt.drawing.svg;
import net.sourceforge.plantuml.klimt.color.ColorMapper;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
public class SvgOption {
private final boolean interactive;
private final LengthAdjust lengthAdjust;
private final String preserveAspectRatio;
private final String hover;
private final boolean svgDimensionStyle;
private final XDimension2D minDim;
private final HColor backcolor;
private final double scale;
private final ColorMapper colorMapper;
private final String linkTarget;
private final String font;
public static SvgOption basic() {
return new SvgOption(false, LengthAdjust.defaultValue(), "none", null, true, new XDimension2D(0, 0), null, 1.0,
ColorMapper.IDENTITY, null, null);
}
private SvgOption(boolean interactive, LengthAdjust lengthAdjust, String preserveAspectRatio, String hover,
boolean svgDimensionStyle, XDimension2D minDim, HColor backcolor, double scale, ColorMapper colorMapper,
String linkTarget, String font) {
this.interactive = interactive;
this.lengthAdjust = lengthAdjust;
this.preserveAspectRatio = preserveAspectRatio;
this.hover = hover;
this.svgDimensionStyle = svgDimensionStyle;
this.minDim = minDim;
this.backcolor = backcolor;
this.scale = scale;
this.colorMapper = colorMapper;
this.linkTarget = linkTarget;
this.font = font;
}
public SvgOption withInteractive() {
return new SvgOption(true, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim, backcolor,
scale, colorMapper, linkTarget, font);
}
public SvgOption withLengthAdjust(LengthAdjust lengthAdjust) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withPreserveAspectRatio(String preserveAspectRatio) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withHoverPathColorRGB(String hover) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withSvgDimensionStyle(boolean svgDimensionStyle) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withMinDim(XDimension2D minDim) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withBackcolor(HColor backcolor) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withScale(double scale) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withColorMapper(ColorMapper colorMapper) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withLinkTarget(String linkTarget) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public SvgOption withFont(String font) {
return new SvgOption(interactive, lengthAdjust, preserveAspectRatio, hover, svgDimensionStyle, minDim,
backcolor, scale, colorMapper, linkTarget, font);
}
public String getPreserveAspectRatio() {
return preserveAspectRatio;
}
public boolean isInteractive() {
return interactive;
}
public LengthAdjust getLengthAdjust() {
return lengthAdjust;
}
public String getHover() {
return hover;
}
public boolean getSvgDimensionStyle() {
return svgDimensionStyle;
}
public XDimension2D getMinDim() {
return minDim;
}
public HColor getBackcolor() {
return backcolor;
}
public double getScale() {
return scale;
}
public ColorMapper getColorMapper() {
return colorMapper;
}
public final String getLinkTarget() {
return linkTarget;
}
public final String getFont() {
return font;
}
}