JAL-3048 JalviewJS compliant use of LineartOptions dialog
[jalview.git] / src / jalview / io / HtmlSvgOutput.java
index a184185..30c40a9 100644 (file)
  */
 package jalview.io;
 
+import jalview.bin.Cache;
 import jalview.exceptions.NoFileSelectedException;
 import jalview.gui.AlignmentPanel;
 import jalview.gui.LineartOptions;
 import jalview.gui.OOMWarning;
 import jalview.math.AlignmentDimension;
 import jalview.util.MessageManager;
+import jalview.util.dialogrunner.RunResponse;
 
 import java.awt.Graphics;
 import java.awt.print.PrinterException;
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import javax.swing.JOptionPane;
 
 import org.jfree.graphics2d.svg.SVGGraphics2D;
 import org.jfree.graphics2d.svg.SVGHints;
@@ -84,7 +89,7 @@ public class HtmlSvgOutput extends HTMLOutput
     return ap.printWrappedAlignment(pwidth, pheight, pi, pg[0]);
   }
 
-  private String getHtml(String titleSvg, String alignmentSvg,
+  String getHtml(String titleSvg, String alignmentSvg,
           String jsonData, boolean wrapped)
   {
     StringBuilder htmlSvg = new StringBuilder();
@@ -238,36 +243,87 @@ public class HtmlSvgOutput extends HTMLOutput
       setProgressMessage(null);
       setProgressMessage(MessageManager.formatMessage(
               "status.exporting_alignment_as_x_file", "HTML"));
-      AlignmentDimension aDimension = ap.getAlignmentDimension();
-      SVGGraphics2D idPanelGraphics = new SVGGraphics2D(
-              aDimension.getWidth(), aDimension.getHeight());
-      SVGGraphics2D alignPanelGraphics = new SVGGraphics2D(
-              aDimension.getWidth(), aDimension.getHeight());
 
-      String renderStyle = jalview.bin.Cache.getDefault("HTML_RENDERING",
+      String renderStyle = Cache.getDefault("HTML_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()
+        {
+          doOutput(textOption.get());
+        }
+      };
 
-      // If we need to prompt, and if the GUI is visible then
-      // Prompt for rendering style
+      /*
+       * Prompt for character rendering style if preference is not set
+       */
       if (renderStyle.equalsIgnoreCase("Prompt each time") && !isHeadless())
       {
         LineartOptions svgOption = new LineartOptions("HTML_RENDERING",
-                "HTML");
-        renderStyle = svgOption.getValue();
-
-        if (renderStyle == null || svgOption.cancelled)
+                "HTML", textOption);
+        svgOption.setResponseAction(new RunResponse(JOptionPane.NO_OPTION)
         {
-          setProgressMessage(MessageManager.formatMessage(
-                  "status.cancelled_image_export_operation", "HTML"));
-          return;
-        }
+          @Override
+          public void run()
+          {
+            setProgressMessage(MessageManager.formatMessage(
+                    "status.cancelled_image_export_operation", "HTML"));
+          }
+        });
+        svgOption.setResponseAction(okAction);
+        svgOption.showDialog();
+        /* no code here - JalviewJS cannot execute it */
+      }
+      else
+      {
+        /*
+         * else (if preference set) just do the export action
+         */
+        doOutput(textOption.get());
       }
+    } catch (OutOfMemoryError err)
+    {
+      System.out.println("########################\n" + "OUT OF MEMORY "
+              + generatedFile + "\n" + "########################");
+      new OOMWarning("Creating Image for " + generatedFile, err);
+    } catch (Exception e)
+    {
+      e.printStackTrace();
+      setProgressMessage(MessageManager
+              .formatMessage("info.error_creating_file", "HTML"));
+    }
+  }
 
-      if (renderStyle.equalsIgnoreCase("Lineart"))
+  /**
+   * Builds and writes the image to the file specified by field
+   * <code>generatedFile</code>
+   * 
+   * @param textCharacters
+   *          true for Text character rendering, false for Lineart
+   */
+  protected void doOutput(boolean textCharacters)
+  {
+    try
+    {
+      AlignmentDimension aDimension = ap.getAlignmentDimension();
+      SVGGraphics2D idPanelGraphics = new SVGGraphics2D(
+              aDimension.getWidth(), aDimension.getHeight());
+      SVGGraphics2D alignPanelGraphics = new SVGGraphics2D(
+              aDimension.getWidth(), aDimension.getHeight());
+      if (!textCharacters) // Lineart selected
       {
-        idPanelGraphics.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
+        idPanelGraphics.setRenderingHint(
+                SVGHints.KEY_DRAW_STRING_TYPE,
                 SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
-        alignPanelGraphics.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
+        alignPanelGraphics.setRenderingHint(
+                SVGHints.KEY_DRAW_STRING_TYPE,
                 SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
       }
       if (ap.av.getWrapAlignment())
@@ -277,15 +333,15 @@ public class HtmlSvgOutput extends HTMLOutput
       }
       else
       {
-        printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
-                idPanelGraphics, alignPanelGraphics);
+        printUnwrapped(aDimension.getWidth(), aDimension.getHeight(),
+                0, idPanelGraphics, alignPanelGraphics);
       }
 
       String idPanelSvgData = idPanelGraphics.getSVGDocument();
       String alignPanelSvgData = alignPanelGraphics.getSVGDocument();
       String jsonData = getBioJSONData();
-      String htmlData = getHtml(idPanelSvgData, alignPanelSvgData, jsonData,
-              ap.av.getWrapAlignment());
+      String htmlData = getHtml(idPanelSvgData, alignPanelSvgData,
+              jsonData, ap.av.getWrapAlignment());
       FileOutputStream out = new FileOutputStream(generatedFile);
       out.write(htmlData.getBytes());
       out.flush();
@@ -293,11 +349,6 @@ public class HtmlSvgOutput extends HTMLOutput
       setProgressMessage(MessageManager
               .formatMessage("status.export_complete", "HTML"));
       exportCompleted();
-    } catch (OutOfMemoryError err)
-    {
-      System.out.println("########################\n" + "OUT OF MEMORY "
-              + generatedFile + "\n" + "########################");
-      new OOMWarning("Creating Image for " + generatedFile, err);
     } catch (Exception e)
     {
       e.printStackTrace();