JAL-3364 tooltip for nucleotide/protein above in exported image
[jalview.git] / src / jalview / gui / AlignmentPanel.java
index 86e7489..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;
@@ -328,12 +329,12 @@ public class AlignmentPanel extends GAlignmentPanel implements
   }
 
   /**
-   * Highlight the given results on the alignment.
+   * Highlight the given results on the alignment
    * 
    */
   public void highlightSearchResults(SearchResultsI results)
   {
-    boolean scrolled = scrollToPosition(results, 0, true, false);
+    boolean scrolled = scrollToPosition(results, 0, false);
 
     boolean noFastPaint = scrolled && av.getWrapAlignment();
 
@@ -345,13 +346,11 @@ public class AlignmentPanel extends GAlignmentPanel implements
    * (if any)
    * 
    * @param searchResults
-   * @param redrawOverview
    * @return
    */
-  public boolean scrollToPosition(SearchResultsI searchResults,
-          boolean redrawOverview)
+  public boolean scrollToPosition(SearchResultsI searchResults)
   {
-    return scrollToPosition(searchResults, 0, redrawOverview, false);
+    return scrollToPosition(searchResults, 0, false);
   }
 
   /**
@@ -364,14 +363,12 @@ public class AlignmentPanel extends GAlignmentPanel implements
    * @param verticalOffset
    *          if greater than zero, allows scrolling to a position below the
    *          first displayed sequence
-   * @param redrawOverview
-   *          - when set, the overview will be recalculated (takes longer)
    * @param centre
    *          if true, try to centre the search results horizontally in the view
    * @return
    */
   protected boolean scrollToPosition(SearchResultsI results,
-          int verticalOffset, boolean redrawOverview, boolean centre)
+          int verticalOffset, boolean centre)
   {
     int startv, endv, starts, ends;
     ViewportRanges ranges = av.getRanges();
@@ -477,7 +474,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
       scrollNeeded = ranges.scrollToWrappedVisible(start);
     }
 
-    paintAlignment(redrawOverview, false);
+    paintAlignment(false, false);
 
     return scrollNeeded;
   }
@@ -641,16 +638,9 @@ public class AlignmentPanel extends GAlignmentPanel implements
     }
     else
     {
-      int width = av.getAlignment().getWidth();
+      int width = av.getAlignment().getVisibleWidth();
       int height = av.getAlignment().getHeight();
 
-      if (av.hasHiddenColumns())
-      {
-        // reset the width to exclude hidden columns
-        width = av.getAlignment().getHiddenColumns()
-                .absoluteToVisibleColumn(width);
-      }
-
       hextent = getSeqPanel().seqCanvas.getWidth() / av.getCharWidth();
       vextent = getSeqPanel().seqCanvas.getHeight() / av.getCharHeight();
 
@@ -962,8 +952,8 @@ public class AlignmentPanel extends GAlignmentPanel implements
 
     final int totalSeq = (pageHeight - scaleHeight) / charHeight - 1;
 
-    final int alignmentWidth = av.getAlignment().getWidth();
-    final int pagesWide = (alignmentWidth / totalRes) + 1;
+    final int alignmentWidth = av.getAlignment().getVisibleWidth();
+    int pagesWide = (alignmentWidth / totalRes) + 1;
 
     final int startRes = (pageIndex % pagesWide) * totalRes;
     final int endRes = Math.min(startRes + totalRes - 1,
@@ -1080,12 +1070,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
 
     int idWidth = getVisibleIdWidth(false);
 
-    int maxwidth = av.getAlignment().getWidth();
-    if (av.hasHiddenColumns())
-    {
-      maxwidth = av.getAlignment().getHiddenColumns()
-              .absoluteToVisibleColumn(maxwidth) - 1;
-    }
+    int maxwidth = av.getAlignment().getVisibleWidth();
 
     int resWidth = getSeqPanel().seqCanvas
             .getWrappedCanvasWidth(pageWidth - idWidth);
@@ -1165,9 +1150,19 @@ 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 boarderBottomOffset = 5;
+    int borderBottomOffset = 5;
     long pSessionId = System.currentTimeMillis();
     headless = (System.getProperty("java.awt.headless") != null
             && System.getProperty("java.awt.headless").equals("true"));
@@ -1182,77 +1177,110 @@ public class AlignmentPanel extends GAlignmentPanel implements
     }
     try
     {
-      AlignmentDimension aDimension = getAlignmentDimension();
-      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();
-        }
+        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);
 
-        im = new jalview.util.ImageMaker(this, type, imageAction,
-                aDimension.getWidth(),
-                aDimension.getHeight() + boarderBottomOffset, file,
-                imageTitle, alignFrame, pSessionId, headless);
-        Graphics graphics = im.getGraphics();
-        if (av.getWrapAlignment())
+      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();
+      }
+
+      ImageMaker im = new ImageMaker(this, type, imageAction,
+              graphicsWidth, graphicsHeight, file,
+              imageTitle, alignFrame, pSessionId, headless);
+      Graphics graphics = im.getGraphics();
+      if (graphics == null)
+      {
+        return;
+      }
+      graphics.setColor(Color.white);
+      graphics.fillRect(0, 0, graphicsWidth, graphicsHeight);
+      if (av.getWrapAlignment())
+      {
+        printWrappedAlignment(dim1.width, dim1.height + borderBottomOffset,
+                0, graphics);
+      }
+      else
+      {
+        printUnwrapped(dim1.width, dim1.height, 0, graphics, graphics);
+      }
+
+      if (forSplitFrame)
+      {
+        /*
+         * append coding complement image
+         */
+        graphics.translate(0, dim1.height);
+        if (av.getCodingComplement().getWrapAlignment())
         {
-          if (graphics != null)
-          {
-            printWrappedAlignment(aDimension.getWidth(),
-                    aDimension.getHeight() + boarderBottomOffset, 0,
-                    graphics);
-            im.writeImage();
-          }
+          comp.printWrappedAlignment(dim2.width,
+                  dim2.height + borderBottomOffset, 0, graphics);
         }
         else
         {
-          if (graphics != null)
-          {
-            printUnwrapped(aDimension.getWidth(), aDimension.getHeight(), 0,
-                    graphics, graphics);
-            im.writeImage();
-          }
+          comp.printUnwrapped(dim2.width, dim2.height, 0, graphics,
+                  graphics);
         }
-
-      } 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)
-      {
-        ex.printStackTrace();
       }
-    } finally
-    {
 
+      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)
+    {
+      ex.printStackTrace();
     }
   }
 
+  /**
+   * 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>
+   * </ul>
+   * The alignment may be in wrapped or unwrapped mode.
+   * <ul>
+   * 
+   * @return
+   */
   public AlignmentDimension getAlignmentDimension()
   {
-    int maxwidth = av.getAlignment().getWidth();
-    if (av.hasHiddenColumns())
-    {
-      maxwidth = av.getAlignment().getHiddenColumns()
-              .absoluteToVisibleColumn(maxwidth);
-    }
+    int maxwidth = av.getAlignment().getVisibleWidth();
 
     int height = ((av.getAlignment().getHeight() + 1) * av.getCharHeight())
             + getScalePanel().getHeight();
@@ -1281,29 +1309,44 @@ public class AlignmentPanel extends GAlignmentPanel implements
     {
       height += getAnnotationPanel().adjustPanelHeight() + 3;
     }
-    return new AlignmentDimension(width, height);
 
+    return new AlignmentDimension(width, height);
   }
 
   /**
-   * 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)
@@ -1567,7 +1610,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
   @Override
   public String getViewName()
   {
-    return av.viewName;
+    return av.getViewName();
   }
 
   /**
@@ -1698,7 +1741,7 @@ public class AlignmentPanel extends GAlignmentPanel implements
    */
   protected void scrollToCentre(SearchResultsI sr, int verticalOffset)
   {
-    scrollToPosition(sr, verticalOffset, true, true);
+    scrollToPosition(sr, verticalOffset, true);
   }
 
   /**