JAL-3364 tooltip for nucleotide/protein above in exported image
[jalview.git] / src / jalview / gui / AlignmentPanel.java
index b554343..4ec71c5 100644 (file)
@@ -36,6 +36,7 @@ import jalview.math.AlignmentDimension;
 import jalview.schemes.ResidueProperties;
 import jalview.structure.StructureSelectionManager;
 import jalview.util.Comparison;
+import jalview.util.ImageMaker;
 import jalview.util.MessageManager;
 import jalview.viewmodel.ViewportListenerI;
 import jalview.viewmodel.ViewportRanges;
@@ -1149,7 +1150,17 @@ public class AlignmentPanel extends GAlignmentPanel implements
     return idwidth.intValue() + 4;
   }
 
-  void makeAlignmentImage(jalview.util.ImageMaker.TYPE type, File file)
+  /**
+   * Generates an image of the alignment panel of the specified type. If
+   * {@code type} is not null, the image is written to the file, otherwise the
+   * user is prompted to specify the output file before writing to it.
+   * 
+   * @param type
+   * @param file
+   * @param forSplitFrame
+   */
+  void makeAlignmentImage(ImageMaker.TYPE type, File file,
+          boolean forSplitFrame)
   {
     int borderBottomOffset = 5;
     long pSessionId = System.currentTimeMillis();
@@ -1166,122 +1177,91 @@ public class AlignmentPanel extends GAlignmentPanel implements
     }
     try
     {
-      // todo splitFrame a parameter (optional menu item choice)
-      boolean splitFrame = av.getCodingComplement() != null;
-      AlignmentDimension aDimension = getAlignmentDimension(splitFrame);
-      try
+      /*
+       * if exporting a split frame image, the graphics object has 
+       * width: maximum of the top and bottom image widths
+       * height: sum of the top and bottom image heights
+       */
+      AlignmentPanel comp = null;
+      AlignmentDimension dim1 = getAlignmentDimension();
+      AlignmentDimension dim2 = new AlignmentDimension(0, 0);
+      if (forSplitFrame)
       {
-        jalview.util.ImageMaker im;
-        final String imageAction, imageTitle;
-        if (type == jalview.util.ImageMaker.TYPE.PNG)
-        {
-          imageAction = "Create PNG image from alignment";
-          imageTitle = null;
-        }
-        else if (type == jalview.util.ImageMaker.TYPE.EPS)
-        {
-          imageAction = "Create EPS file from alignment";
-          imageTitle = alignFrame.getTitle();
-        }
-        else
-        {
-          imageAction = "Create SVG file from alignment";
-          imageTitle = alignFrame.getTitle();
-        }
-
-        im = new jalview.util.ImageMaker(this, type, imageAction,
-                aDimension.width, aDimension.height + borderBottomOffset,
-                file,
-                imageTitle, alignFrame, pSessionId, headless);
-        Graphics graphics = im.getGraphics();
-        if (graphics != null)
-        {
-          if (av.getWrapAlignment())
-          {
-            printWrappedAlignment(aDimension.width,
-                    aDimension.height + borderBottomOffset, 0,
-                    graphics);
-          }
-          else
-          {
-            printUnwrapped(aDimension.width, aDimension.height, 0,
-                    graphics, graphics);
-          }
+        comp = ((AlignViewport) av.getCodingComplement())
+                .getAlignPanel();
+        dim2 = comp.getAlignmentDimension();
+      }
+      final int graphicsHeight = dim1.height + dim2.height
+              + borderBottomOffset;
+      final int graphicsWidth = Math.max(dim1.width, dim2.width);
 
-          if (splitFrame)
-          {
-            /*
-             * append coding complement image
-             * todo: always top frame first!
-             */
-            int h = getAlignmentDimension(false).height;
-            graphics.translate(0, h);
-            AlignmentPanel comp = ((AlignViewport) av.getCodingComplement())
-                    .getAlignPanel();
-            if (av.getCodingComplement().getWrapAlignment())
-            {
-              comp.printWrappedAlignment(aDimension.width,
-                      aDimension.height + borderBottomOffset, 0, graphics);
-            }
-            else
-            {
-              comp.printUnwrapped(aDimension.width, aDimension.height, 0,
-                      graphics, graphics);
-            }
-          }
+      final String imageAction, imageTitle;
+      if (type == ImageMaker.TYPE.PNG)
+      {
+        imageAction = "Create PNG image from alignment";
+        imageTitle = null;
+      }
+      else if (type == ImageMaker.TYPE.EPS)
+      {
+        imageAction = "Create EPS file from alignment";
+        imageTitle = alignFrame.getTitle();
+      }
+      else
+      {
+        imageAction = "Create SVG file from alignment";
+        imageTitle = alignFrame.getTitle();
+      }
 
-          im.writeImage();
-        }
-      } catch (OutOfMemoryError err)
+      ImageMaker im = new ImageMaker(this, type, imageAction,
+              graphicsWidth, graphicsHeight, file,
+              imageTitle, alignFrame, pSessionId, headless);
+      Graphics graphics = im.getGraphics();
+      if (graphics == null)
       {
-        // Be noisy here.
-        System.out.println("########################\n" + "OUT OF MEMORY "
-                + file + "\n" + "########################");
-        new OOMWarning("Creating Image for " + file, err);
-        // System.out.println("Create IMAGE: " + err);
-      } catch (Exception ex)
+        return;
+      }
+      graphics.setColor(Color.white);
+      graphics.fillRect(0, 0, graphicsWidth, graphicsHeight);
+      if (av.getWrapAlignment())
       {
-        ex.printStackTrace();
+        printWrappedAlignment(dim1.width, dim1.height + borderBottomOffset,
+                0, graphics);
+      }
+      else
+      {
+        printUnwrapped(dim1.width, dim1.height, 0, graphics, graphics);
       }
-    } finally
-    {
 
-    }
-  }
+      if (forSplitFrame)
+      {
+        /*
+         * append coding complement image
+         */
+        graphics.translate(0, dim1.height);
+        if (av.getCodingComplement().getWrapAlignment())
+        {
+          comp.printWrappedAlignment(dim2.width,
+                  dim2.height + borderBottomOffset, 0, graphics);
+        }
+        else
+        {
+          comp.printUnwrapped(dim2.width, dim2.height, 0, graphics,
+                  graphics);
+        }
+      }
 
-  /**
-   * Computes and answers the width and height of the alignment in pixels,
-   * including
-   * <ul>
-   * <li>sequence ids</li>
-   * <li>scale above, left or right if shown</li>
-   * <li>sequences</li>
-   * <li>annotations, if shown</li> The alignment may be in wrapped or unwrapped
-   * mode.
-   * <ul>
-   * 
-   * @param splitFrame
-   *                     if true, the combined dimensions of a split frame view
-   *                     are computed: the sum of the two alignments' heights, and
-   *                     the larger of their widths. Any additional height (e.g.
-   *                     for frame titles) should be added separately.
-   * @return
-   */
-  public AlignmentDimension getAlignmentDimension(boolean splitFrame)
-  {
-    AlignmentDimension d1 = getAlignmentDimension();
-    if (!splitFrame)
+      im.writeImage();
+    } catch (OutOfMemoryError err)
+    {
+      // Be noisy here.
+      System.out.println("########################\n" + "OUT OF MEMORY "
+              + file + "\n" + "########################");
+      new OOMWarning("Creating Image for " + file, err);
+      // System.out.println("Create IMAGE: " + err);
+    } catch (Exception ex)
     {
-      return d1;
+      ex.printStackTrace();
     }
-    AlignmentPanel comp = ((AlignViewport) av.getCodingComplement())
-            .getAlignPanel();
-    AlignmentDimension d2 = comp.getAlignmentDimension();
-
-    int h = d1.height + d2.height;
-    int w = Math.max(d1.width, d2.width);
-
-    return new AlignmentDimension(w, h);
   }
 
   /**
@@ -1291,13 +1271,14 @@ public class AlignmentPanel extends GAlignmentPanel implements
    * <li>sequence ids</li>
    * <li>scale above, left or right if shown</li>
    * <li>sequences</li>
-   * <li>annotations, if shown</li> The alignment may be in wrapped or unwrapped
-   * mode.
+   * <li>annotations, if shown</li>
+   * </ul>
+   * The alignment may be in wrapped or unwrapped mode.
    * <ul>
    * 
    * @return
    */
-  AlignmentDimension getAlignmentDimension()
+  public AlignmentDimension getAlignmentDimension()
   {
     int maxwidth = av.getAlignment().getVisibleWidth();
 
@@ -1333,24 +1314,39 @@ public class AlignmentPanel extends GAlignmentPanel implements
   }
 
   /**
-   * DOCUMENT ME!
+   * Creates and writes an EPS image of the alignment, to the given file if
+   * specified, else after prompting for the output file
+   * 
+   * @param epsFile
+   * @param forSplitFrame
    */
-  public void makeEPS(File epsFile)
+  public void makeEPS(File epsFile, boolean forSplitFrame)
   {
-    makeAlignmentImage(jalview.util.ImageMaker.TYPE.EPS, epsFile);
+    makeAlignmentImage(ImageMaker.TYPE.EPS, epsFile, forSplitFrame);
   }
 
   /**
-   * DOCUMENT ME!
+   * Creates and writes a PNG image of the alignment, to the given file if
+   * specified, else after prompting for the output file
+   * 
+   * @param pngFile
+   * @param forSplitFrame
    */
-  public void makePNG(File pngFile)
+  public void makePNG(File pngFile, boolean forSplitFrame)
   {
-    makeAlignmentImage(jalview.util.ImageMaker.TYPE.PNG, pngFile);
+    makeAlignmentImage(ImageMaker.TYPE.PNG, pngFile, forSplitFrame);
   }
 
-  public void makeSVG(File svgFile)
+  /**
+   * Creates and writes an SVG image of the alignment, to the given file if
+   * specified, else after prompting for the output file
+   * 
+   * @param svgFile
+   * @param forSplitFrame
+   */
+  public void makeSVG(File svgFile, boolean forSplitFrame)
   {
-    makeAlignmentImage(jalview.util.ImageMaker.TYPE.SVG, svgFile);
+    makeAlignmentImage(ImageMaker.TYPE.SVG, svgFile, forSplitFrame);
   }
 
   public void makePNGImageMap(File imgMapFile, String imageName)