*/
package jalview.util;
-import jalview.bin.Jalview;
-import jalview.gui.EPSOptions;
-import jalview.gui.IProgressIndicator;
-import jalview.gui.SVGOptions;
-import jalview.io.JalviewFileChooser;
-
-import java.awt.Component;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.RenderingHints;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileOutputStream;
+import java.io.IOException;
import javax.imageio.ImageIO;
import org.jfree.graphics2d.svg.SVGHints;
import org.jibble.epsgraphics.EpsGraphics2D;
+import jalview.bin.Console;
+import jalview.io.JalviewFileChooser;
+import jalview.util.imagemaker.BitmapImageSizing;
+
public class ImageMaker
{
public static final String SVG_DESCRIPTION = "Scalable Vector Graphics";
public static final String PNG_DESCRIPTION = "Portable network graphics";
- public static final String HTML_EXTENSION = "html";
-
- public static final String HTML_DESCRIPTION = "Hypertext Markup Language";
-
EpsGraphics2D pg;
- SVGGraphics2D g2;
-
Graphics graphics;
FileOutputStream out;
TYPE type;
- private IProgressIndicator pIndicator;
-
- private long pSessionId;
-
- private boolean headless;
-
public enum TYPE
{
- EPS("EPS", MessageManager.getString("label.eps_file"), getEPSChooser()),
- PNG("PNG", MessageManager.getString("label.png_image"),
- getPNGChooser()),
- SVG("SVG", "SVG", getSVGChooser());
+ EPS("EPS", MessageManager.getString("label.eps_file"), EPS_EXTENSION,
+ EPS_DESCRIPTION),
+ PNG("PNG", MessageManager.getString("label.png_image"), PNG_EXTENSION,
+ PNG_DESCRIPTION),
+ SVG("SVG", "SVG", SVG_EXTENSION, SVG_DESCRIPTION);
- private JalviewFileChooser chooser;
+ public final String name;
- private String name;
+ public final String label;
- private String label;
+ public final String extension;
- TYPE(String name, String label, JalviewFileChooser chooser)
+ public final String description;
+
+ TYPE(String name, String label, String ext, String desc)
{
this.name = name;
this.label = label;
- this.chooser = chooser;
+ this.extension = ext;
+ this.description = desc;
}
public String getName()
return name;
}
- public JalviewFileChooser getChooser()
+ public JalviewFileChooser getFileChooser()
{
- return chooser;
+ return new JalviewFileChooser(extension, description);
}
public String getLabel()
}
- public ImageMaker(Component parent, TYPE type, String title, int width,
- int height, File file, String fileTitle,
- IProgressIndicator pIndicator, long pSessionId, boolean headless)
+ /**
+ * Constructor configures the graphics context ready for writing to
+ *
+ * @param imageType
+ * @param width
+ * @param height
+ * @param file
+ * @param fileTitle
+ * @param useLineart
+ * @param bitmapscale
+ * @throws IOException
+ */
+ public ImageMaker(TYPE imageType, int width, int height, File file,
+ String fileTitle, boolean useLineart, BitmapImageSizing userBis)
+ throws IOException
{
- this.pIndicator = pIndicator;
- this.type = type;
- this.pSessionId = pSessionId;
- this.headless = headless;
- if (file == null)
- {
- setProgressMessage(MessageManager.formatMessage(
- "status.waiting_for_user_to_select_output_file", type.name));
- JalviewFileChooser chooser;
- chooser = type.getChooser();
- chooser.setFileView(new jalview.io.JalviewFileView());
- chooser.setDialogTitle(title);
- chooser.setToolTipText(MessageManager.getString("action.save"));
- int value = chooser.showSaveDialog(parent);
-
- if (value == jalview.io.JalviewFileChooser.APPROVE_OPTION)
- {
- jalview.bin.Cache.setProperty("LAST_DIRECTORY",
- chooser.getSelectedFile().getParent());
- file = chooser.getSelectedFile();
- }
- else
- {
- setProgressMessage(MessageManager.formatMessage(
- "status.cancelled_image_export_operation", type.name));
- }
- }
+ this.type = imageType;
- if (file != null)
+ out = new FileOutputStream(file);
+ switch (imageType)
{
- try
- {
- out = new FileOutputStream(file);
- setProgressMessage(null);
- setProgressMessage(MessageManager.formatMessage(
- "status.exporting_alignment_as_x_file", type.getName()));
- if (type == TYPE.SVG)
- {
- setupSVG(width, height, fileTitle);
- }
- else if (type == TYPE.EPS)
- {
- setupEPS(width, height, fileTitle);
- }
- else if (type == TYPE.PNG)
- {
- setupPNG(width, height);
- }
-
- } catch (Exception ex)
- {
- System.out.println("Error creating " + type.getName() + " file.");
-
- setProgressMessage(MessageManager
- .formatMessage("info.error_creating_file", type.getName()));
- }
+ case SVG:
+ setupSVG(width, height, useLineart);
+ break;
+ case EPS:
+ setupEPS(width, height, fileTitle, useLineart);
+ break;
+ case PNG:
+ setupPNG(width, height, userBis);
+ break;
+ default:
}
}
return graphics;
}
+ /**
+ * For SVG or PNG, writes the generated graphics data to the file output
+ * stream. For EPS, flushes the output graphics (which is written to file as
+ * it is generated).
+ */
public void writeImage()
{
try
}
}
- void setupEPS(int width, int height, String title)
+ /**
+ * Sets up a graphics object for the PNG image to be written on
+ *
+ * @param width
+ * @param height
+ * @param scale
+ */
+ protected void setupPNG(int width, int height, BitmapImageSizing userBis)
{
- boolean accurateText = true;
-
- String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
- "Prompt each time");
-
- // If we need to prompt, and if the GUI is visible then
- // Prompt for EPS rendering style
- if (renderStyle.equalsIgnoreCase("Prompt each time")
- && !(System.getProperty("java.awt.headless") != null && System
- .getProperty("java.awt.headless").equals("true")))
- {
- EPSOptions eps = new EPSOptions();
- renderStyle = eps.getValue();
+ if (width == 0 || height == 0)
+ return;
- if (renderStyle == null || eps.cancelled)
- {
- setProgressMessage(MessageManager.formatMessage(
- "status.cancelled_image_export_operation", "EPS"));
- return;
- }
- }
+ BitmapImageSizing bis = ImageMaker.getScaleWidthHeight(width, height,
+ userBis);
+ float usescale = bis.scale();
+ int usewidth = bis.width();
+ int useheight = bis.height();
- if (renderStyle.equalsIgnoreCase("text"))
+ bi = new BufferedImage(usewidth, useheight, BufferedImage.TYPE_INT_RGB);
+ graphics = bi.getGraphics();
+ Graphics2D ig2 = (Graphics2D) graphics;
+ ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+ RenderingHints.VALUE_ANTIALIAS_ON);
+ if (usescale > 0.0f)
{
- accurateText = false;
+ ig2.scale(usescale, usescale);
}
+ }
- try
- {
- pg = new EpsGraphics2D(title, out, 0, 0, width, height);
- Graphics2D ig2 = pg;
- ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
- RenderingHints.VALUE_ANTIALIAS_ON);
-
- pg.setAccurateTextMode(accurateText);
-
- graphics = pg;
- setProgressMessage(MessageManager
- .formatMessage("status.export_complete", type.getName()));
- } catch (Exception ex)
+ /**
+ * A helper method to configure the SVG output graphics, with choice of Text
+ * or Lineart character rendering
+ *
+ * @param width
+ * @param height
+ * @param useLineart
+ * true for Lineart character rendering, false for Text
+ */
+ protected void setupSVG(int width, int height, boolean useLineart)
+ {
+ SVGGraphics2D g2 = new SVGGraphics2D(width, height);
+ if (useLineart)
{
+ g2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
+ SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
}
+ graphics = g2;
}
- void setupPNG(int width, int height)
+ /**
+ * A helper method that sets up the EPS graphics output with user choice of
+ * Text or Lineart character rendering
+ *
+ * @param width
+ * @param height
+ * @param title
+ * @param useLineart
+ * true for Lineart character rendering, false for Text
+ * @throws IOException
+ */
+ protected void setupEPS(int width, int height, String title,
+ boolean useLineart) throws IOException
{
- bi = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
- graphics = bi.getGraphics();
- Graphics2D ig2 = (Graphics2D) graphics;
+ pg = new EpsGraphics2D(title, out, 0, 0, width, height);
+ Graphics2D ig2 = pg;
ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
RenderingHints.VALUE_ANTIALIAS_ON);
- setProgressMessage(MessageManager
- .formatMessage("status.export_complete", type.getName()));
-
+ pg.setAccurateTextMode(useLineart);
+ graphics = pg;
}
- void setupSVG(int width, int height, String title)
+ /**
+ * Takes initial width and height, and suggested float scale, int width, int
+ * height and create a bounding box returned as a BitmapImageSizing object
+ * with consistent scale, width, height fields.
+ *
+ * @param width
+ * The unscaled image width
+ * @param height
+ * The unscaled image height
+ * @param scale
+ * The suggested scaling
+ * @param bitmapwidth
+ * The suggested width
+ * @param bitmapheight
+ * The suggested height
+ * @return BitmapImageSizing A consistent scale,width and height for the final
+ * image
+ */
+ public static BitmapImageSizing getScaleWidthHeight(int width, int height,
+ float scale, int bitmapwidth, int bitmapheight)
{
+ float usescale = 0.0f;
+ int usewidth = width;
+ int useheight = height;
- g2 = new SVGGraphics2D(width, height);
- Graphics2D ig2 = g2;
-
- String renderStyle = jalview.bin.Cache.getDefault("SVG_RENDERING",
- "Prompt each time");
-
- // If we need to prompt, and if the GUI is visible then
- // Prompt for EPS rendering style
- if (renderStyle.equalsIgnoreCase("Prompt each time")
- && !(System.getProperty("java.awt.headless") != null && System
- .getProperty("java.awt.headless").equals("true")))
+ if ((width == 0 && bitmapwidth > 0)
+ || (height == 0 && bitmapheight > 0))
{
- SVGOptions svgOption = new SVGOptions();
- renderStyle = svgOption.getValue();
+ // original image is zero sized! Avoid dividing by zero!
+ return BitmapImageSizing.nullBitmapImageSizing();
+ }
- if (renderStyle == null || svgOption.cancelled)
+ // use the smallest positive scale (i.e. fit in the box)
+ if (scale > 0.0f)
+ {
+ usescale = scale;
+ usewidth = Math.round(scale * width);
+ useheight = Math.round(scale * height);
+ }
+ if (bitmapwidth > 0)
+ {
+ float wscale = (float) bitmapwidth / width;
+ if (wscale > 0.0f && (usescale == 0.0f || wscale < usescale))
{
- setProgressMessage(MessageManager.formatMessage(
- "status.cancelled_image_export_operation", "SVG"));
- return;
+ usescale = wscale;
+ usewidth = bitmapwidth;
+ useheight = Math.round(usescale * height);
}
}
-
- if (renderStyle.equalsIgnoreCase("Lineart"))
+ if (bitmapheight > 0)
{
- ig2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
- SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
+ float hscale = (float) bitmapheight / height;
+ if (hscale > 0.0f && (usescale == 0.0f || hscale < usescale))
+ {
+ usescale = hscale;
+ usewidth = Math.round(usescale * width);
+ useheight = bitmapheight;
+ }
}
-
- setProgressMessage(MessageManager
- .formatMessage("status.export_complete", type.getName()));
- graphics = g2;
+ return new BitmapImageSizing(usescale, usewidth, useheight, false);
}
- static JalviewFileChooser getPNGChooser()
+ /**
+ * Takes suggested scale, width, height as a BitmapImageSizing object and
+ * create a bounding box returned as a BitmapImageSizing object with
+ * consistent scale, width, height fields.
+ *
+ * @param bis
+ * @return BitmapImageSizing
+ */
+ public static BitmapImageSizing getScaleWidthHeight(int width, int height,
+ BitmapImageSizing bis)
{
- if (Jalview.isHeadlessMode())
- {
- return null;
- }
- return new JalviewFileChooser(PNG_EXTENSION, PNG_DESCRIPTION);
+ return ImageMaker.getScaleWidthHeight(width, height, bis.scale(),
+ bis.width(), bis.height());
}
- static JalviewFileChooser getEPSChooser()
+ /**
+ * Takes String versions of suggested float scale, int width, int height and
+ * create a bounding box returned as a BitmapImageSizing object with
+ * consistent scale, width, height fields.
+ *
+ * @param scaleS
+ * @param widthS
+ * @param heightS
+ * @return BitmapImageSizing
+ */
+ public static BitmapImageSizing parseScaleWidthHeightStrings(
+ String scaleS, String widthS, String heightS)
{
- if (Jalview.isHeadlessMode())
+ if (scaleS == null && widthS == null && heightS == null)
{
- return null;
+ // if all items are null (i.e. not provided) we use the dynamic
+ // preferences set BIS
+ return BitmapImageSizing.defaultBitmapImageSizing();
}
- return new JalviewFileChooser(EPS_EXTENSION, EPS_DESCRIPTION);
- }
- private void setProgressMessage(String message)
- {
- if (pIndicator != null && !headless)
+ float scale = 0.0f;
+ int width = 0;
+ int height = 0;
+
+ if (scaleS != null)
{
- pIndicator.setProgressBar(message, pSessionId);
+ try
+ {
+ scale = Float.parseFloat(scaleS);
+ } catch (NumberFormatException e)
+ {
+ Console.warn("Did not understand scale '" + scaleS
+ + "', won't be used.");
+ }
}
- }
-
- static JalviewFileChooser getSVGChooser()
- {
- if (Jalview.isHeadlessMode())
+ if (widthS != null)
{
- return null;
+ try
+ {
+ width = Integer.parseInt(widthS);
+ } catch (NumberFormatException e)
+ {
+ Console.warn("Did not understand width '" + widthS
+ + "', won't be used.");
+ }
}
- return new JalviewFileChooser(SVG_EXTENSION, SVG_DESCRIPTION);
+ if (heightS != null)
+ {
+ try
+ {
+ height = Integer.parseInt(heightS);
+ } catch (NumberFormatException e)
+ {
+ Console.warn("Did not understand height '" + heightS
+ + "', won't be used.");
+ }
+ }
+
+ return new BitmapImageSizing(scale, width, height, false);
}
}
git://source.jalview.org / jalview.git / blobdiff