net.sourceforge.plantuml.swing.ImageWindow 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.swing;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Image;
import java.awt.RenderingHints;
import java.awt.Toolkit;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseMotionAdapter;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.prefs.Preferences;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JScrollBar;
import javax.swing.JScrollPane;
import javax.swing.ListModel;
import javax.swing.SwingUtilities;
import javax.swing.WindowConstants;
import net.atmp.ImageBuilder;
import net.sourceforge.plantuml.GeneratedImage;
import net.sourceforge.plantuml.klimt.shape.GraphicStrings;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SImageIO;
import net.sourceforge.plantuml.version.PSystemVersion;
class ImageWindow extends JFrame {
private final static Preferences prefs = Preferences.userNodeForPackage(ImageWindow.class);
private final static String KEY_ZOOM_FIT = "zoomfit";
private final static String KEY_WIDTH_FIT = "widthfit";
private SimpleLine simpleLine;
private final JScrollPane scrollPane;
private final JButton next = new JButton("Next");
private final JButton copy = new JButton("Copy");
private final JButton previous = new JButton("Previous");
private final JCheckBox zoomFitButt = new JCheckBox("Zoom fit");
private final JCheckBox widthFitButt = new JCheckBox("Width fit");
private final JButton zoomMore = new JButton("+");
private final JButton zoomLess = new JButton("-");
private final MainWindow main;
private final ListModel listModel;
private int index;
private int zoomFactor = 0;
private enum SizeMode {
FULL_SIZE, ZOOM_FIT, WIDTH_FIT
};
private SizeMode sizeMode = SizeMode.FULL_SIZE;
private int startX, startY;
public ImageWindow(SimpleLine simpleLine, final MainWindow main, ListModel listModel, int index) {
super(simpleLine.toString());
setIconImage(PSystemVersion.getPlantumlSmallIcon2());
this.simpleLine = simpleLine;
this.listModel = listModel;
this.index = index;
this.main = main;
final JPanel north = new JPanel();
north.add(previous);
north.add(copy);
north.add(next);
north.add(zoomFitButt);
north.add(widthFitButt);
north.add(zoomMore);
north.add(zoomLess);
copy.setFocusable(false);
copy.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
copy();
}
});
next.setFocusable(false);
next.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
next();
}
});
previous.setFocusable(false);
previous.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
previous();
}
});
zoomFitButt.setFocusable(false);
zoomFitButt.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
widthFitButt.setSelected(false);
zoomFit();
}
});
widthFitButt.setFocusable(false);
widthFitButt.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
zoomFitButt.setSelected(false);
zoomFit();
}
});
zoomMore.setFocusable(false);
zoomMore.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
zoomFactor++;
refreshImage(false);
}
});
zoomLess.setFocusable(false);
zoomLess.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
zoomFactor--;
refreshImage(false);
}
});
scrollPane = new JScrollPane(buildScrollablePicture());
getContentPane().add(north, BorderLayout.NORTH);
getContentPane().add(scrollPane, BorderLayout.CENTER);
setSize(640, 400);
this.setLocationRelativeTo(this.getParent());
setVisible(true);
setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
this.addWindowListener(new WindowAdapter() {
@Override
public void windowClosing(WindowEvent e) {
super.windowClosing(e);
main.closing(ImageWindow.this);
}
});
this.addComponentListener(new java.awt.event.ComponentAdapter() {
public void componentResized(java.awt.event.ComponentEvent e) {
super.componentResized(e);
refreshImage(false);
}
});
final boolean zoomChecked = prefs.getBoolean(KEY_ZOOM_FIT, false);
zoomFitButt.setSelected(zoomChecked);
if (zoomChecked) {
sizeMode = SizeMode.ZOOM_FIT;
}
final boolean widthZoomChecked = prefs.getBoolean(KEY_WIDTH_FIT, false);
widthFitButt.setSelected(widthZoomChecked);
if (widthZoomChecked) {
sizeMode = SizeMode.WIDTH_FIT;
}
this.setFocusable(true);
this.addKeyListener(new KeyAdapter() {
public void keyPressed(KeyEvent evt) {
if (evt.isControlDown()
&& (evt.getKeyCode() == KeyEvent.VK_PLUS || evt.getKeyCode() == KeyEvent.VK_ADD)) {
zoomFactor++;
refreshImage(false);
} else if (evt.isControlDown()
&& (evt.getKeyCode() == KeyEvent.VK_MINUS || evt.getKeyCode() == KeyEvent.VK_SUBTRACT)) {
zoomFactor--;
refreshImage(false);
} else if (evt.isControlDown()
&& (evt.getKeyCode() == KeyEvent.VK_0 || evt.getKeyCode() == KeyEvent.VK_NUMPAD0)) {
zoomFactor = 0;
refreshImage(false);
} else if (evt.isControlDown() && evt.getKeyCode() == KeyEvent.VK_RIGHT) {
next();
} else if (evt.isControlDown() && evt.getKeyCode() == KeyEvent.VK_LEFT) {
previous();
} else if (evt.isAltDown() && evt.getKeyCode() == KeyEvent.VK_RIGHT) {
next();
} else if (evt.isAltDown() && evt.getKeyCode() == KeyEvent.VK_LEFT) {
previous();
} else if (evt.getKeyCode() == KeyEvent.VK_RIGHT) {
imageRight();
} else if (evt.getKeyCode() == KeyEvent.VK_LEFT) {
imageLeft();
} else if (evt.getKeyCode() == KeyEvent.VK_DOWN) {
imageDown();
} else if (evt.getKeyCode() == KeyEvent.VK_UP) {
imageUp();
} else if (evt.getKeyCode() == KeyEvent.VK_C) {
copy();
} else if (evt.getKeyCode() == KeyEvent.VK_Z) {
zoomFitButt.setSelected(!zoomFitButt.isSelected());
zoomFit();
}
}
});
}
private void next() {
index++;
updateSimpleLine();
}
private void previous() {
index--;
updateSimpleLine();
}
private void imageDown() {
final JScrollBar bar = scrollPane.getVerticalScrollBar();
bar.setValue(bar.getValue() + bar.getBlockIncrement());
}
private void imageUp() {
final JScrollBar bar = scrollPane.getVerticalScrollBar();
bar.setValue(bar.getValue() - bar.getBlockIncrement());
}
private void imageLeft() {
final JScrollBar bar = scrollPane.getHorizontalScrollBar();
bar.setValue(bar.getValue() - bar.getBlockIncrement());
}
private void imageRight() {
final JScrollBar bar = scrollPane.getHorizontalScrollBar();
bar.setValue(bar.getValue() + bar.getBlockIncrement());
}
private void zoomFit() {
final boolean selectedZoom = zoomFitButt.isSelected();
final boolean selectedWidth = widthFitButt.isSelected();
prefs.putBoolean(KEY_ZOOM_FIT, selectedZoom);
prefs.putBoolean(KEY_WIDTH_FIT, selectedWidth);
zoomFactor = 0;
if (selectedZoom) {
sizeMode = SizeMode.ZOOM_FIT;
} else if (selectedWidth) {
sizeMode = SizeMode.WIDTH_FIT;
} else {
sizeMode = SizeMode.FULL_SIZE;
}
refreshImage(false);
}
private void updateSimpleLine() {
if (index < 0) {
index = 0;
}
if (index > listModel.getSize() - 1) {
index = listModel.getSize() - 1;
}
simpleLine = (SimpleLine) listModel.getElementAt(index);
setTitle(simpleLine.toString());
refreshImage(false);
}
private void refreshSimpleLine() {
for (SimpleLine line : main.getCurrentDirectoryListing2()) {
if (line.getFile().equals(simpleLine.getFile())) {
simpleLine = line;
setTitle(simpleLine.toString());
}
}
}
private ScrollablePicture buildScrollablePicture() {
final GeneratedImage generatedImage = simpleLine.getGeneratedImage();
if (generatedImage == null) {
return null;
}
final File png = generatedImage.getPngFile();
BufferedImage image = null;
try {
image = SImageIO.read(new SFile(png.getAbsolutePath()));
if (sizeMode == SizeMode.ZOOM_FIT) {
final Dimension imageDim = new Dimension(image.getWidth(), image.getHeight());
final Dimension newImgDim = ImageHelper.getScaledDimension(imageDim,
scrollPane.getViewport().getSize());
image = ImageHelper.getScaledInstance(image, newImgDim, getHints(), true);
} else if (sizeMode == SizeMode.WIDTH_FIT) {
final Dimension imageDim = new Dimension(image.getWidth(), image.getHeight());
final Dimension newImgDim = ImageHelper.getScaledDimensionWidthFit(imageDim,
scrollPane.getViewport().getSize());
image = ImageHelper.getScaledInstance(image, newImgDim, getHints(), false);
} else if (zoomFactor != 0) {
final Dimension imageDim = new Dimension(image.getWidth(), image.getHeight());
final Dimension newImgDim = ImageHelper.getScaledDimension(imageDim, getZoom());
image = ImageHelper.getScaledInstance(image, newImgDim, getHints(), false);
}
} catch (IOException ex) {
final String msg = "Error reading file: " + ex.toString();
final TextBlock error = GraphicStrings.createForError(Arrays.asList(msg), false);
try {
final byte[] bytes = ImageBuilder.plainPngBuilder(error).writeByteArray();
image = SImageIO.read(bytes);
} catch (IOException e) {
Logme.error(e);
}
}
final ImageIcon imageIcon = new ImageIcon(image, simpleLine.toString());
final ScrollablePicture scrollablePicture = new ScrollablePicture(imageIcon, 1);
scrollablePicture.addMouseListener(new MouseAdapter() {
public void mousePressed(MouseEvent me) {
super.mousePressed(me);
startX = me.getX();
startY = me.getY();
}
});
scrollablePicture.addMouseMotionListener(new MouseMotionAdapter() {
public void mouseDragged(MouseEvent me) {
super.mouseDragged(me);
final int diffX = me.getX() - startX;
final int diffY = me.getY() - startY;
final JScrollBar hbar = scrollPane.getHorizontalScrollBar();
hbar.setValue(hbar.getValue() - diffX);
final JScrollBar vbar = scrollPane.getVerticalScrollBar();
vbar.setValue(vbar.getValue() - diffY);
}
});
return scrollablePicture;
}
private RenderingHints getHints() {
final RenderingHints hints = new RenderingHints(RenderingHints.KEY_INTERPOLATION,
RenderingHints.VALUE_INTERPOLATION_BILINEAR);
hints.put(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
hints.put(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
return hints;
}
private double getZoom() {
// if (zoomFactor <= -10) {
// return 0.05;
// }
// return 1.0 + zoomFactor / 10.0;
return Math.pow(1.1, zoomFactor);
}
private void copy() {
final GeneratedImage generatedImage = simpleLine.getGeneratedImage();
if (generatedImage == null) {
return;
}
try {
final File png = generatedImage.getPngFile();
final Image image = SImageIO.read(png);
final ImageSelection imgSel = new ImageSelection(image);
Toolkit.getDefaultToolkit().getSystemClipboard().setContents(imgSel, null);
} catch (IOException e) {
Logme.error(e);
}
}
public SimpleLine getSimpleLine() {
return simpleLine;
}
private int v1;
private int v2;
public void refreshImage(boolean external) {
final JScrollBar bar1 = scrollPane.getVerticalScrollBar();
final JScrollBar bar2 = scrollPane.getHorizontalScrollBar();
if (external && isError() == false) {
v1 = bar1.getValue();
v2 = bar2.getValue();
}
scrollPane.setViewportView(buildScrollablePicture());
force();
if (external) {
SwingUtilities.invokeLater(new Runnable() {
public void run() {
refreshSimpleLine();
if (isError() == false) {
bar1.setValue(v1);
bar2.setValue(v2);
}
}
});
}
}
private boolean isError() {
return simpleLine.getGeneratedImage() != null && simpleLine.getGeneratedImage().lineErrorRaw() != -1;
}
private void force() {
// setVisible(true);
repaint();
// validate();
// getContentPane().validate();
// getContentPane().setVisible(true);
// getContentPane().repaint();
// scrollPane.validate();
// scrollPane.setVisible(true);
// scrollPane.repaint();
}
}