JAL-3438 spotless for 2.11.2.0
[jalview.git] / src / jalview / util / ImageMaker.java
index 64771c4..0cd017f 100755 (executable)
  */
 package jalview.util;
 
-import jalview.bin.Cache;
-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;
 import java.awt.Graphics2D;
 import java.awt.RenderingHints;
 import java.awt.image.BufferedImage;
 import java.io.File;
 import java.io.FileOutputStream;
-import java.util.concurrent.atomic.AtomicBoolean;
+import java.io.IOException;
 
 import javax.imageio.ImageIO;
-import javax.swing.JOptionPane;
 
 import org.jfree.graphics2d.svg.SVGGraphics2D;
 import org.jfree.graphics2d.svg.SVGHints;
@@ -57,10 +50,6 @@ public class ImageMaker
 
   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;
 
   Graphics graphics;
@@ -71,12 +60,6 @@ public class ImageMaker
 
   TYPE type;
 
-  private IProgressIndicator pIndicator;
-
-  private long pSessionId;
-
-  private boolean headless;
-
   public enum TYPE
   {
     EPS("EPS", MessageManager.getString("label.eps_file"), EPS_EXTENSION,
@@ -119,79 +102,34 @@ public class ImageMaker
   }
 
   /**
-   * Constructor builds the image and writes it to file. If the supplied file
-   * name is null, the user is prompted for the output file.
+   * Constructor configures the graphics context ready for writing to
    * 
-   * @param parent
-   * @param type
-   * @param title
+   * @param imageType
    * @param width
    * @param height
    * @param file
    * @param fileTitle
-   * @param pIndicator
-   * @param pSessionId
-   * @param headless
+   * @param useLineart
+   * @throws IOException
    */
-  public ImageMaker(Component parent, TYPE type, String title, int width,
-          int height, File file, String fileTitle,
-          IProgressIndicator pIndicator, long pSessionId, boolean headless)
+  public ImageMaker(TYPE imageType, int width, int height, File file,
+          String fileTitle, boolean useLineart) throws IOException
   {
-    this.pIndicator = pIndicator;
-    this.type = type;
-    this.pSessionId = pSessionId;
-    this.headless = headless;
-    if (file == null && !Jalview.isHeadlessMode())
-    {
-      setProgressMessage(MessageManager.formatMessage(
-              "status.waiting_for_user_to_select_output_file", type.name));
-      JalviewFileChooser chooser = type.getFileChooser();
-      chooser.setFileView(new jalview.io.JalviewFileView());
-      chooser.setDialogTitle(title);
-      chooser.setToolTipText(MessageManager.getString("action.save"));
-      int value = chooser.showSaveDialog(parent);
-
-      if (value == JalviewFileChooser.APPROVE_OPTION)
-      {
-        Cache.setProperty("LAST_DIRECTORY",
-                chooser.getSelectedFile().getParent());
-        file = chooser.getSelectedFile();
-      }
-      else
-      {
-        setProgressMessage(MessageManager.formatMessage(
-                "status.cancelled_image_export_operation", type.name));
-      }
-    }
-
-    if (file != null)
-    {
-      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()));
-      }
+    this.type = imageType;
+
+    out = new FileOutputStream(file);
+    switch (imageType)
+    {
+    case SVG:
+      setupSVG(width, height, useLineart);
+      break;
+    case EPS:
+      setupEPS(width, height, fileTitle, useLineart);
+      break;
+    case PNG:
+      setupPNG(width, height);
+      break;
+    default:
     }
   }
 
@@ -234,146 +172,18 @@ 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)
-  {
-    String renderStyle = Cache.getDefault("EPS_RENDERING",
-            "Prompt each time");
-    AtomicBoolean textOption = new AtomicBoolean(
-            !"Lineart".equals(renderStyle));
-
-    /*
-     * configure the action to run on OK in the dialog
-     */
-    RunResponse okAction = new RunResponse(JOptionPane.OK_OPTION)
-    {
-      @Override
-      public void run()
-      {
-        writeEPS(width, height, title, 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 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 */
-    }
-    else
-    {
-      /*
-       * 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)
+  protected void setupPNG(int width, int height)
   {
     bi = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
     graphics = bi.getGraphics();
     Graphics2D ig2 = (Graphics2D) graphics;
     ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
             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)
-  {
-    String renderStyle = Cache.getDefault("SVG_RENDERING",
-            "Prompt each time");
-    AtomicBoolean textOption = new AtomicBoolean(
-            !"Lineart".equals(renderStyle));
-
-    /*
-     * 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",
-              TYPE.SVG.getName(), textOption);
-      svgOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
-      {
-        @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 */
-    }
-    else
-    {
-      /*
-       * else (if preference set) just do the export action
-       */
-      setupSVG(width, height, textOption.get());
-    }
-  }
-
-  void setProgressMessage(String message)
-  {
-    if (pIndicator != null && !headless)
-    {
-      pIndicator.setProgressBar(message, pSessionId);
-    }
   }
 
   /**
@@ -382,19 +192,17 @@ public class ImageMaker
    * 
    * @param width
    * @param height
-   * @param textOption
-   *          true for Text, false for Lineart
+   * @param useLineart
+   *          true for Lineart character rendering, false for Text
    */
-  protected void setupSVG(int width, int height, boolean textOption)
+  protected void setupSVG(int width, int height, boolean useLineart)
   {
     SVGGraphics2D g2 = new SVGGraphics2D(width, height);
-    if (!textOption) // Lineart selected
+    if (useLineart)
     {
       g2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
               SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
     }
-    setProgressMessage(MessageManager
-            .formatMessage("status.export_complete", type.getName()));
     graphics = g2;
   }
 
@@ -405,34 +213,18 @@ public class ImageMaker
    * @param width
    * @param height
    * @param title
-   * @param textOption
-   *          true for Text, false for Lineart
+   * @param useLineart
+   *          true for Lineart character rendering, false for Text
+   * @throws IOException
    */
-  protected void writeEPS(int width, int height, String title,
-          boolean textOption)
+  protected void setupEPS(int width, int height, String title,
+          boolean useLineart) throws IOException
   {
-    try
-    {
-      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());
-    }
-  }
-
-  static JalviewFileChooser getSVGChooser()
-  {
-    if (Jalview.isHeadlessMode())
-    {
-      return null;
-    }
-    return new JalviewFileChooser(SVG_EXTENSION, SVG_DESCRIPTION);
+    pg = new EpsGraphics2D(title, out, 0, 0, width, height);
+    Graphics2D ig2 = pg;
+    ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+            RenderingHints.VALUE_ANTIALIAS_ON);
+    pg.setAccurateTextMode(useLineart);
+    graphics = pg;
   }
 }