JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / util / ImageMaker.java
index e6c2dd2..3c7ac8c 100755 (executable)
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 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.
- * 
+ * 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/>.
+ * 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.util;
 
-import java.io.*;
-import javax.imageio.*;
+import jalview.bin.Jalview;
+import jalview.gui.EPSOptions;
+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.awt.*;
-import java.awt.image.*;
+import javax.imageio.ImageIO;
 
-import org.jibble.epsgraphics.*;
-import jalview.gui.*;
-import jalview.io.*;
+import org.jfree.graphics2d.svg.SVGGraphics2D;
+import org.jfree.graphics2d.svg.SVGHints;
+import org.jibble.epsgraphics.EpsGraphics2D;
 
 public class ImageMaker
 {
-  public static final int EPS = 0;
-
-  public static final int PNG = 1;
-
-  int type = -1;
-
   EpsGraphics2D pg;
 
+  SVGGraphics2D g2;
+
   Graphics graphics;
 
   FileOutputStream out;
 
   BufferedImage bi;
 
-  public ImageMaker(Component parent, int type, String title, int width,
-          int height, File file, String EPStitle)
+  TYPE type;
+
+  public enum TYPE
+  {
+    EPS("EPS", MessageManager.getString("label.eps_file"), getEPSChooser()), PNG(
+            "PNG", MessageManager.getString("label.png_image"),
+            getPNGChooser()), SVG("SVG", "SVG", getSVGChooser());
+
+    private JalviewFileChooser chooser;
+
+    private String name;
+
+    private String label;
+
+    TYPE(String name, String label, JalviewFileChooser chooser)
+    {
+      this.name = name;
+      this.label = label;
+      this.chooser = chooser;
+    }
+
+    public String getName()
+    {
+      return name;
+    }
+
+    public JalviewFileChooser getChooser()
+    {
+      return chooser;
+    }
+
+    public String getLabel()
+    {
+      return label;
+    }
+
+  }
+
+  public ImageMaker(Component parent, TYPE type, String title, int width,
+          int height, File file, String fileTitle)
   {
     this.type = type;
 
     if (file == null)
     {
       JalviewFileChooser chooser;
-      chooser = type == EPS ? getEPSChooser() : getPNGChooser();
-
+      chooser = type.getChooser();
       chooser.setFileView(new jalview.io.JalviewFileView());
       chooser.setDialogTitle(title);
-      chooser.setToolTipText("Save");
-
+      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();
       }
     }
@@ -73,19 +116,22 @@ public class ImageMaker
       try
       {
         out = new FileOutputStream(file);
-
-        if (type == EPS)
+        if (type == TYPE.SVG)
         {
-          setupEPS(width, height, EPStitle);
+          setupSVG(width, height, fileTitle);
         }
-        else
+        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 == EPS ? "EPS" : "PNG") + " file.");
+        System.out.println("Error creating " + type.getName() + " file.");
       }
     }
   }
@@ -95,15 +141,6 @@ public class ImageMaker
     return graphics;
   }
 
-  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);
-  }
-
   public void writeImage()
   {
     try
@@ -114,8 +151,15 @@ public class ImageMaker
         pg.flush();
         pg.close();
         break;
+      case SVG:
+        String svgData = ((SVGGraphics2D) getGraphics()).getSVGDocument();
+        out.write(svgData.getBytes());
+        out.flush();
+        out.close();
+        break;
       case PNG:
         ImageIO.write(bi, "png", out);
+        out.flush();
         out.close();
         break;
       }
@@ -155,7 +199,7 @@ public class ImageMaker
     try
     {
       pg = new EpsGraphics2D(title, out, 0, 0, width, height);
-      Graphics2D ig2 = (Graphics2D) pg;
+      Graphics2D ig2 = pg;
       ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
               RenderingHints.VALUE_ANTIALIAS_ON);
 
@@ -167,19 +211,85 @@ public class ImageMaker
     }
   }
 
-  JalviewFileChooser getPNGChooser()
+  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);
+
+  }
+
+  void setupSVG(int width, int height, String title)
+  {
+
+    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")))
+    {
+      SVGOptions svgOption = new SVGOptions();
+      renderStyle = svgOption.getValue();
+
+      if (renderStyle == null || svgOption.cancelled)
+      {
+        return;
+      }
+    }
+
+    if (renderStyle.equalsIgnoreCase("lineart"))
+    {
+      ig2.setRenderingHint(SVGHints.KEY_DRAW_STRING_TYPE,
+              SVGHints.VALUE_DRAW_STRING_TYPE_VECTOR);
+    }
+
+    graphics = g2;
+  }
+
+  static JalviewFileChooser getPNGChooser()
+  {
+    if (Jalview.isHeadlessMode())
+    {
+      return null;
+    }
+    return new jalview.io.JalviewFileChooser(
+            jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
+            new String[] { "png" },
+            new String[] { "Portable network graphics" },
+            "Portable network graphics");
+  }
+
+  static JalviewFileChooser getEPSChooser()
   {
-    return new jalview.io.JalviewFileChooser(jalview.bin.Cache
-            .getProperty("LAST_DIRECTORY"), new String[]
-    { "png" }, new String[]
-    { "Portable network graphics" }, "Portable network graphics");
+    if (Jalview.isHeadlessMode())
+    {
+      return null;
+    }
+    return new jalview.io.JalviewFileChooser(
+            jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
+            new String[] { "eps" },
+            new String[] { "Encapsulated Postscript" },
+            "Encapsulated Postscript");
   }
 
-  JalviewFileChooser getEPSChooser()
+  static JalviewFileChooser getSVGChooser()
   {
-    return new jalview.io.JalviewFileChooser(jalview.bin.Cache
-            .getProperty("LAST_DIRECTORY"), new String[]
-    { "eps" }, new String[]
-    { "Encapsulated Postscript" }, "Encapsulated Postscript");
+    if (Jalview.isHeadlessMode())
+    {
+      return null;
+    }
+    return new jalview.io.JalviewFileChooser(
+            jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
+            new String[] { "svg" },
+            new String[] { "Scalable Vector Graphics" },
+            "Scalable Vector Graphics");
   }
 }