net.sourceforge.plantuml.klimt.drawing.svg.UGraphicSvg 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.klimt.drawing.svg;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Map;
import javax.xml.transform.TransformerException;
import net.sourceforge.plantuml.klimt.ClipContainer;
import net.sourceforge.plantuml.klimt.UGroupType;
import net.sourceforge.plantuml.klimt.UPath;
import net.sourceforge.plantuml.klimt.drawing.AbstractCommonUGraphic;
import net.sourceforge.plantuml.klimt.drawing.AbstractUGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.shape.DotPath;
import net.sourceforge.plantuml.klimt.shape.UCenteredCharacter;
import net.sourceforge.plantuml.klimt.shape.UComment;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.UImage;
import net.sourceforge.plantuml.klimt.shape.UImageSvg;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.klimt.shape.UPixel;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.klimt.shape.UText;
import net.sourceforge.plantuml.url.Url;
public class UGraphicSvg extends AbstractUGraphic implements ClipContainer {
// ::remove file when __HAXE__
private final boolean textAsPath;
private /* final */ SvgOption option;
public double dpiFactor() {
return 1;
}
@Override
protected AbstractCommonUGraphic copyUGraphic() {
final UGraphicSvg result = new UGraphicSvg(getStringBounder(), textAsPath);
result.copy(this);
result.option = this.option;
return result;
}
private UGraphicSvg(StringBounder stringBounder, boolean textAsPath) {
super(stringBounder);
this.textAsPath = textAsPath;
register();
}
public static UGraphicSvg build(SvgOption option, boolean textAsPath, long seed, StringBounder stringBounder) {
final UGraphicSvg result = new UGraphicSvg(stringBounder, textAsPath);
result.copy(option.getBackcolor(), option.getColorMapper(), new SvgGraphics(seed, option));
result.option = option;
return result;
}
@Override
protected boolean manageHiddenAutomatically() {
return false;
}
@Override
protected void beforeDraw() {
getGraphicObject().setHidden(getParam().isHidden());
}
@Override
protected void afterDraw() {
getGraphicObject().setHidden(false);
}
private void register() {
registerDriver(URectangle.class, new DriverRectangleSvg(this));
if (textAsPath)
registerDriver(UText.class, new DriverTextAsPathSvg(this));
else
registerDriver(UText.class, new DriverTextSvg(getStringBounder(), this));
registerDriver(ULine.class, new DriverLineSvg(this));
registerDriver(UPixel.class, new DriverPixelSvg());
registerDriver(UPolygon.class, new DriverPolygonSvg(this));
registerDriver(UEllipse.class, new DriverEllipseSvg(this));
registerDriver(UImage.class, new DriverImagePng(this));
registerDriver(UImageSvg.class, new DriverImageSvgSvg());
registerDriver(UPath.class, new DriverPathSvg(this));
registerDriver(DotPath.class, new DriverDotPathSvg());
registerDriver(UCenteredCharacter.class, new DriverCenteredCharacterSvg());
}
public SvgGraphics getSvgGraphics() {
return this.getGraphicObject();
}
@Override
public void writeToStream(OutputStream os, String metadata, int dpi) throws IOException {
try {
if (metadata != null)
getGraphicObject().addCommentMetadata(metadata);
if (option.isInteractive()) {
// For performance reasons and also because we want the entire graph DOM to be
// create so we can register
// the event handlers on them we will append to the end of the document
getGraphicObject().addStyle("onmouseinteractivefooter.css");
getGraphicObject().addScriptTag("https://cdn.jsdelivr.net/npm/@svgdotjs/[email protected]/dist/svg.min.js");
getGraphicObject().addScript("onmouseinteractivefooter.js");
}
getGraphicObject().createXml(os);
} catch (TransformerException e) {
throw new IOException(e.toString());
}
}
@Override
public void startGroup(Map typeIdents) {
getGraphicObject().startGroup(typeIdents);
}
@Override
public void closeGroup() {
getGraphicObject().closeGroup();
}
@Override
public void startUrl(Url url) {
getGraphicObject().openLink(url.getUrl(), url.getTooltip(), option.getLinkTarget());
}
@Override
public void closeUrl() {
getGraphicObject().closeLink();
}
@Override
protected void drawComment(UComment comment) {
getGraphicObject().addComment(comment.getComment());
}
@Override
public boolean matchesProperty(String propertyName) {
if (propertyName.equalsIgnoreCase("SVG"))
return true;
return super.matchesProperty(propertyName);
}
// @Override
// public String startHiddenGroup() {
// getGraphicObject().startHiddenGroup();
// return null;
// }
//
// @Override
// public String closeHiddenGroup() {
// getGraphicObject().closeHiddenGroup();
// return null;
// }
}