JAL-4274 Use Cache BITMAP_* if no other image restrictions given
[jalview.git] / src / jalview / gui / ImageExporter.java
index fc971e2..457ea1f 100644 (file)
@@ -1,20 +1,41 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.gui;
 
+import java.awt.Component;
+import java.awt.Graphics;
+import java.io.File;
+import java.util.concurrent.atomic.AtomicBoolean;
+
 import jalview.bin.Cache;
 import jalview.bin.Jalview;
 import jalview.io.JalviewFileChooser;
 import jalview.io.JalviewFileView;
+import jalview.io.exceptions.ImageOutputException;
 import jalview.util.ImageMaker;
 import jalview.util.ImageMaker.TYPE;
 import jalview.util.MessageManager;
-import jalview.util.dialogrunner.RunResponse;
-
-import java.awt.Component;
-import java.awt.Graphics;
-import java.io.File;
-import java.util.concurrent.atomic.AtomicBoolean;
-
-import javax.swing.JOptionPane;
+import jalview.util.Platform;
+import jalview.util.StringUtils;
+import jalview.util.imagemaker.BitmapImageSizing;
 
 /**
  * A class that marshals steps in exporting a view in image graphics format
@@ -40,8 +61,7 @@ public class ImageExporter
    */
   public interface ImageWriterI
   {
-    void exportImage(Graphics g)
-            throws Exception;
+    void exportImage(Graphics g) throws Exception;
   }
 
   private IProgressIndicator messageBoard;
@@ -85,15 +105,33 @@ public class ImageExporter
    *          what the image is of e.g. Tree, Alignment
    */
   public void doExport(File file, Component parent, int width, int height,
-          String imageSource)
+          String imageSource) throws ImageOutputException
+  {
+    doExport(file, parent, width, height, imageSource, null,
+            BitmapImageSizing.defaultBitmapImageSizing());
+  }
+
+  public void doExport(File file, Component parent, int width, int height,
+          String imageSource, String renderer, BitmapImageSizing userBis)
+          throws ImageOutputException
   {
     final long messageId = System.currentTimeMillis();
+    setStatus(
+            MessageManager.formatMessage(
+                    "status.exporting_alignment_as_x_file", imageType),
+            messageId);
 
     /*
      * prompt user for output file if not provided
      */
     if (file == null && !Jalview.isHeadlessMode())
     {
+      if (Desktop.instance.isInBatchMode())
+      {
+        // defensive error report - we could wait for user input.. I guess ?
+        throw (new ImageOutputException(
+                "Need an output file to render to when exporting images in batch mode!"));
+      }
       JalviewFileChooser chooser = imageType.getFileChooser();
       chooser.setFileView(new JalviewFileView());
       MessageManager.formatMessage("label.create_image_of",
@@ -118,49 +156,46 @@ public class ImageExporter
     /*
      * Prompt for Text or Lineart (EPS/SVG) unless a preference is already set
      * for this as EPS_RENDERING / SVG_RENDERING
+     * Always set to Text for JalviewJS as Lineart (glyph fonts) not available
      */
-    String renderStyle = Cache.getDefault(
-            imageType.getName() + "_RENDERING",
-            LineartOptions.PROMPT_EACH_TIME);
+    String renderStyle = renderer == null
+            ? Cache.getDefault(imageType.getName() + "_RENDERING",
+                    LineartOptions.PROMPT_EACH_TIME)
+            : renderer;
+    if (Platform.isJS())
+    {
+      renderStyle = "Text";
+    }
     AtomicBoolean textSelected = new AtomicBoolean(
-            !"Lineart".equals(renderStyle));
-    if ((imageType == TYPE.EPS || imageType == TYPE.SVG)
-            && LineartOptions.PROMPT_EACH_TIME.equals(renderStyle)
+            !StringUtils.equalsIgnoreCase("lineart", renderStyle));
+    if ((imageType == TYPE.EPS || imageType == TYPE.SVG) && StringUtils
+            .equalsIgnoreCase(LineartOptions.PROMPT_EACH_TIME, renderStyle)
             && !Jalview.isHeadlessMode())
     {
       final File chosenFile = file;
-      RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
-      {
-        @Override
-        public void run()
-        {
-          exportImage(chosenFile, !textSelected.get(), width, height,
-                  messageId);
-        }
+      Runnable okAction = () -> {
+        exportImage(chosenFile, !textSelected.get(), width, height,
+                messageId, userBis);
       };
       LineartOptions epsOption = new LineartOptions(TYPE.EPS.getName(),
               textSelected);
-      epsOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
-      {
-        @Override
-        public void run()
-        {
-          setStatus(MessageManager.formatMessage(
-                  "status.cancelled_image_export_operation",
-                  imageType.getName()), messageId);
-        }
+      epsOption.setResponseAction(1, () -> {
+        setStatus(MessageManager.formatMessage(
+                "status.cancelled_image_export_operation",
+                imageType.getName()), messageId);
       });
-      epsOption.setResponseAction(okAction);
+      epsOption.setResponseAction(0, okAction);
       epsOption.showDialog();
       /* no code here - JalviewJS cannot execute it */
     }
     else
     {
       /*
-       * character rendering not required, or preference already set 
-       * - just do the export
+       * character rendering not required, or preference already set
+       * or we're in headless mode - just do the export
        */
-      exportImage(file, !textSelected.get(), width, height, messageId);
+      exportImage(file, !textSelected.get(), width, height, messageId,
+              userBis);
     }
   }
 
@@ -176,17 +211,17 @@ public class ImageExporter
    * @param messageId
    */
   protected void exportImage(File chosenFile, boolean asLineart, int width,
-          int height, long messageId)
+          int height, long messageId, BitmapImageSizing userBis)
   {
     String type = imageType.getName();
     try
     {
-      setStatus(
-              MessageManager.formatMessage(
-                      "status.exporting_alignment_as_x_file", type),
-              messageId);
+      // setStatus(
+      // MessageManager.formatMessage(
+      // "status.exporting_alignment_as_x_file", type),
+      // messageId);
       ImageMaker im = new ImageMaker(imageType, width, height, chosenFile,
-              title, asLineart);
+              title, asLineart, userBis);
       imageWriter.exportImage(im.getGraphics());
       im.writeImage();
       setStatus(
@@ -194,9 +229,8 @@ public class ImageExporter
               messageId);
     } catch (Exception e)
     {
-      System.out
-              .println(String.format("Error creating %s file: %s", type,
-                      e.toString()));
+      jalview.bin.Console.error(String.format("Error creating %s file: %s",
+              type, e.toString()), e);
       setStatus(MessageManager.formatMessage("info.error_creating_file",
               type), messageId);
     }