net.sourceforge.plantuml.EmptyImageBuilder 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;
import java.awt.Color;
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Graphics2D;
import java.awt.geom.AffineTransform;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.util.ArrayList;
import java.util.List;
import net.sourceforge.plantuml.dot.GraphvizUtils;
import net.sourceforge.plantuml.klimt.UAntiAliasing;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.utils.Log;
public class EmptyImageBuilder {
// ::remove file when __HAXE__
private final BufferedImage im;
private final Graphics2D g2d;
private final Color background;
private final StringBounder stringBounder;
private static EmptyImageBuilder create(String watermark, int width, int height, Color background,
StringBounder stringBounder, double dpiFactor) {
EmptyImageBuilder result = new EmptyImageBuilder(watermark, (int) (width * dpiFactor),
(int) (height * dpiFactor), background, stringBounder);
if (dpiFactor != 1.0)
result.g2d.setTransform(AffineTransform.getScaleInstance(dpiFactor, dpiFactor));
return result;
}
public EmptyImageBuilder(String watermark, int width, int height, Color background, StringBounder stringBounder) {
if (width <= 0 || height <= 0)
throw new IllegalArgumentException("width and height must be positive");
// ::comment when __CORE__
if (width > GraphvizUtils.getenvImageLimit()) {
Log.info("Width too large " + width + ". You should set PLANTUML_LIMIT_SIZE");
width = GraphvizUtils.getenvImageLimit();
}
if (height > GraphvizUtils.getenvImageLimit()) {
Log.info("Height too large " + height + ". You should set PLANTUML_LIMIT_SIZE");
height = GraphvizUtils.getenvImageLimit();
}
this.background = background;
this.stringBounder = stringBounder;
Log.info("Creating image " + width + "x" + height);
im = new BufferedImage(width, height, getType(background));
g2d = im.createGraphics();
UAntiAliasing.ANTI_ALIASING_ON.apply(g2d);
if (background != null) {
g2d.setColor(background);
g2d.fillRect(0, 0, width, height);
}
if (watermark != null) {
final int gray = 200;
g2d.setColor(new Color(gray, gray, gray));
printWatermark(watermark, width, height);
}
}
private int getType(Color background) {
if (background == null) {
return BufferedImage.TYPE_INT_ARGB;
}
if (background.getAlpha() != 255) {
return BufferedImage.TYPE_INT_ARGB;
}
return BufferedImage.TYPE_INT_RGB;
}
private void printWatermark(String watermark, int maxWidth, int maxHeight) {
final Font javaFont = g2d.getFont();
final FontMetrics fm = g2d.getFontMetrics(javaFont);
final Rectangle2D rect = fm.getStringBounds(watermark, g2d);
final int height = (int) rect.getHeight();
final int width = (int) rect.getWidth();
if (height < 2 || width < 2) {
return;
}
if (width <= maxWidth)
for (int y = height; y < maxHeight; y += height + 1) {
for (int x = 0; x < maxWidth; x += width + 10) {
g2d.drawString(watermark, x, y);
}
}
else {
final List withBreaks = withBreaks(watermark, javaFont, fm, maxWidth);
int y = 0;
while (y < maxHeight) {
for (String s : withBreaks) {
g2d.drawString(s, 0, y);
y += (int) fm.getStringBounds(s, g2d).getHeight();
}
y += 10;
}
}
}
private int getWidth(String line, Font javaFont, FontMetrics fm) {
final Rectangle2D rect = fm.getStringBounds(line, g2d);
return (int) rect.getWidth();
}
private List withBreaks(String watermark, Font javaFont, FontMetrics fm, int maxWidth) {
final String[] words = watermark.split("\\s+");
final List result = new ArrayList<>();
String pending = "";
for (String word : words) {
final String candidate = pending.length() == 0 ? word : pending + " " + word;
if (getWidth(candidate, javaFont, fm) < maxWidth) {
pending = candidate;
} else {
result.add(pending);
pending = word;
}
}
if (pending.length() > 0) {
result.add(pending);
}
return result;
}
public BufferedImage getBufferedImage() {
return im;
}
public Graphics2D getGraphics2D() {
return g2d;
}
// public UGraphicG2d getUGraphicG2d(FileFormat format) {
// final HColor back = HColors.simple(background);
// final UGraphicG2d result = new UGraphicG2d(back, ColorMapper.IDENTITY, stringBounder, g2d, 1.0, format);
// result.setBufferedImage(im);
// return result;
// }
}