JAL-3048 JalviewJS compliant use of LineartOptions dialog
[jalview.git] / src / jalview / util / ImageMaker.java
index 493e210..64771c4 100755 (executable)
@@ -25,6 +25,7 @@ import jalview.bin.Jalview;
 import jalview.gui.IProgressIndicator;
 import jalview.gui.LineartOptions;
 import jalview.io.JalviewFileChooser;
+import jalview.util.dialogrunner.RunResponse;
 
 import java.awt.Component;
 import java.awt.Graphics;
@@ -33,8 +34,10 @@ import java.awt.RenderingHints;
 import java.awt.image.BufferedImage;
 import java.io.File;
 import java.io.FileOutputStream;
+import java.util.concurrent.atomic.AtomicBoolean;
 
 import javax.imageio.ImageIO;
+import javax.swing.JOptionPane;
 
 import org.jfree.graphics2d.svg.SVGGraphics2D;
 import org.jfree.graphics2d.svg.SVGHints;
@@ -60,8 +63,6 @@ public class ImageMaker
 
   EpsGraphics2D pg;
 
-  SVGGraphics2D g2;
-
   Graphics graphics;
 
   FileOutputStream out;
@@ -105,7 +106,7 @@ public class ImageMaker
       return name;
     }
 
-    public JalviewFileChooser getChooser()
+    public JalviewFileChooser getFileChooser()
     {
       return new JalviewFileChooser(extension, description);
     }
@@ -144,8 +145,7 @@ public class ImageMaker
     {
       setProgressMessage(MessageManager.formatMessage(
               "status.waiting_for_user_to_select_output_file", type.name));
-      JalviewFileChooser chooser;
-      chooser = type.getChooser();
+      JalviewFileChooser chooser = type.getFileChooser();
       chooser.setFileView(new jalview.io.JalviewFileView());
       chooser.setDialogTitle(title);
       chooser.setToolTipText(MessageManager.getString("action.save"));
@@ -163,7 +163,7 @@ public class ImageMaker
                 "status.cancelled_image_export_operation", type.name));
       }
     }
-    // TODO JAL-3048 refactor to method called by constructor or callback
+
     if (file != null)
     {
       try
@@ -200,6 +200,11 @@ public class ImageMaker
     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
@@ -228,53 +233,71 @@ public class ImageMaker
     }
   }
 
+  /**
+   * Generates an EPS image and writes it to the (previously set) output buffer.
+   * The user is first prompted for choice of Text or Lineart rendering, unless
+   * a preference for this has been set.
+   * 
+   * @param width
+   * @param height
+   * @param title
+   */
   void setupEPS(int width, int height, String title)
   {
-    boolean accurateText = true;
-
     String renderStyle = Cache.getDefault("EPS_RENDERING",
             "Prompt each time");
+    AtomicBoolean textOption = new AtomicBoolean(
+            !"Lineart".equals(renderStyle));
 
-    // 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")))
+    /*
+     * configure the action to run on OK in the dialog
+     */
+    RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
     {
-      LineartOptions eps = new LineartOptions("EPS_RENDERING", "EPS");
-      renderStyle = eps.getValue();
-
-      if (renderStyle == null || eps.cancelled)
+      @Override
+      public void run()
       {
-        setProgressMessage(MessageManager.formatMessage(
-                "status.cancelled_image_export_operation", "EPS"));
-        return;
+        writeEPS(width, height, title, textOption.get());
       }
-    }
+    };
 
-    if (renderStyle.equalsIgnoreCase("text"))
+    /*
+     * Prompt for character rendering style if preference is not set
+     */
+    if (renderStyle.equalsIgnoreCase("Prompt each time")
+            && !(System.getProperty("java.awt.headless") != null && System
+                    .getProperty("java.awt.headless").equals("true")))
     {
-      accurateText = false;
+      LineartOptions epsOption = new LineartOptions("EPS_RENDERING",
+              TYPE.EPS.getName(), textOption);
+      epsOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
+      {
+        @Override
+        public void run()
+        {
+          setProgressMessage(MessageManager.formatMessage(
+                  "status.cancelled_image_export_operation", "EPS"));
+        }
+      });
+      epsOption.setResponseAction(okAction);
+      epsOption.showDialog();
+      /* no code here - JalviewJS cannot execute it */
     }
-
-    try
+    else
     {
-      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)
-    {
-      System.err.println("Error writing PNG: " + ex.toString());
+      /*
+       * else (if preference set) just do the export action
+       */
+      writeEPS(width, height, title, textOption.get());
     }
   }
 
+  /**
+   * Sets up a graphics object for the PNG image to be written on
+   * 
+   * @param width
+   * @param height
+   */
   void setupPNG(int width, int height)
   {
     bi = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
@@ -284,69 +307,123 @@ public class ImageMaker
             RenderingHints.VALUE_ANTIALIAS_ON);
     setProgressMessage(MessageManager
             .formatMessage("status.export_complete", type.getName()));
-
   }
 
+  /**
+   * Sets up a graphics object for the SVG image to be written on. The user is
+   * first prompted for choice of Text or Lineart rendering, unless a preference
+   * for this has been set.
+   * 
+   * @param width
+   * @param height
+   * @param title
+   */
   void setupSVG(int width, int height, String title)
   {
-
-    g2 = new SVGGraphics2D(width, height);
-    Graphics2D ig2 = g2;
-
-    String renderStyle = jalview.bin.Cache.getDefault("SVG_RENDERING",
+    String renderStyle = Cache.getDefault("SVG_RENDERING",
             "Prompt each time");
+    AtomicBoolean textOption = new AtomicBoolean(
+            !"Lineart".equals(renderStyle));
 
-    // If we need to prompt, and if the GUI is visible then
-    // Prompt for EPS rendering style
+    /*
+     * configure the action to run on OK in the dialog
+     */
+    RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
+    {
+      @Override
+      public void run()
+      {
+        setupSVG(width, height, textOption.get());
+      }
+    };
+
+    /*
+     * Prompt for character rendering style if preference is not set
+     */
     if (renderStyle.equalsIgnoreCase("Prompt each time")
             && !(System.getProperty("java.awt.headless") != null && System
                     .getProperty("java.awt.headless").equals("true")))
     {
-      LineartOptions svgOption = new LineartOptions("SVG_RENDERING", "SVG");
-      renderStyle = svgOption.getValue();
-
-      if (renderStyle == null || svgOption.cancelled)
+      LineartOptions svgOption = new LineartOptions("SVG_RENDERING",
+              TYPE.SVG.getName(), textOption);
+      svgOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
       {
-        setProgressMessage(MessageManager.formatMessage(
-                "status.cancelled_image_export_operation", "SVG"));
-        return;
-      }
+        @Override
+        public void run()
+        {
+          setProgressMessage(MessageManager.formatMessage(
+                  "status.cancelled_image_export_operation", "SVG"));
+        }
+      });
+      svgOption.setResponseAction(okAction);
+      svgOption.showDialog();
+      /* no code here - JalviewJS cannot execute it */
     }
-
-    if (renderStyle.equalsIgnoreCase("Lineart"))
+    else
     {
-      ig2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
-              SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
+      /*
+       * else (if preference set) just do the export action
+       */
+      setupSVG(width, height, textOption.get());
     }
-
-    setProgressMessage(MessageManager
-            .formatMessage("status.export_complete", type.getName()));
-    graphics = g2;
   }
 
-  static JalviewFileChooser getPNGChooser()
+  void setProgressMessage(String message)
   {
-    if (Jalview.isHeadlessMode())
+    if (pIndicator != null && !headless)
     {
-      return null;
+      pIndicator.setProgressBar(message, pSessionId);
     }
-    return new JalviewFileChooser(PNG_EXTENSION, PNG_DESCRIPTION);
   }
 
-  static JalviewFileChooser getEPSChooser()
+  /**
+   * A helper method to configure the SVG output graphics, with choice of Text
+   * or Lineart character rendering
+   * 
+   * @param width
+   * @param height
+   * @param textOption
+   *          true for Text, false for Lineart
+   */
+  protected void setupSVG(int width, int height, boolean textOption)
   {
-    if (Jalview.isHeadlessMode())
+    SVGGraphics2D g2 = new SVGGraphics2D(width, height);
+    if (!textOption) // Lineart selected
     {
-      return null;
+      g2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
+              SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
     }
-    return new JalviewFileChooser(EPS_EXTENSION, EPS_DESCRIPTION);
+    setProgressMessage(MessageManager
+            .formatMessage("status.export_complete", type.getName()));
+    graphics = g2;
   }
 
-  private void setProgressMessage(String message)
+  /**
+   * 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 textOption
+   *          true for Text, false for Lineart
+   */
+  protected void writeEPS(int width, int height, String title,
+          boolean textOption)
   {
-    if (pIndicator != null && !headless)
+    try
     {
-      pIndicator.setProgressBar(message, pSessionId);
+      pg = new EpsGraphics2D(title, out, 0, 0, width, height);
+      Graphics2D ig2 = pg;
+      ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+              RenderingHints.VALUE_ANTIALIAS_ON);
+      pg.setAccurateTextMode(!textOption); // true = Lineart
+      graphics = pg;
+      setProgressMessage(MessageManager
+              .formatMessage("status.export_complete", type.getName()));
+    } catch (Exception ex)
+    {
+      System.err.println("Error writing PNG: " + ex.toString());
     }
   }