JAL-4024 only render partially when new view overlaps with last rendered annotation...
[jalview.git] / src / jalview / gui / AnnotationPanel.java
index ab86707..e9ef19c 100755 (executable)
  */
 package jalview.gui;
 
-import jalview.datamodel.AlignmentAnnotation;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.Annotation;
-import jalview.datamodel.ColumnSelection;
-import jalview.datamodel.HiddenColumns;
-import jalview.datamodel.SequenceI;
-import jalview.renderer.AnnotationRenderer;
-import jalview.renderer.AwtRenderPanelI;
-import jalview.schemes.ResidueProperties;
-import jalview.util.Comparison;
-import jalview.util.MessageManager;
-import jalview.util.Platform;
-import jalview.viewmodel.ViewportListenerI;
-import jalview.viewmodel.ViewportRanges;
-
 import java.awt.AlphaComposite;
 import java.awt.Color;
 import java.awt.Dimension;
@@ -59,13 +44,28 @@ import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
-import javax.swing.JColorChooser;
 import javax.swing.JMenuItem;
 import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
 import javax.swing.Scrollable;
 import javax.swing.ToolTipManager;
 
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Annotation;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.SequenceI;
+import jalview.gui.JalviewColourChooser.ColourChooserListener;
+import jalview.renderer.AnnotationRenderer;
+import jalview.renderer.AwtRenderPanelI;
+import jalview.schemes.ResidueProperties;
+import jalview.util.Comparison;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.viewmodel.ViewportListenerI;
+import jalview.viewmodel.ViewportRanges;
+
 /**
  * AnnotationPanel displays visible portion of annotation rows below unwrapped
  * alignment
@@ -77,6 +77,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         MouseListener, MouseWheelListener, MouseMotionListener,
         ActionListener, AdjustmentListener, Scrollable, ViewportListenerI
 {
+  enum DragMode
+  {
+    Select, Resize, Undefined
+  };
+
   String HELIX = MessageManager.getString("label.helix");
 
   String SHEET = MessageManager.getString("label.sheet");
@@ -109,7 +114,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   public volatile BufferedImage fadedImage;
 
-  Graphics2D gg;
+  // private Graphics2D gg;
 
   public FontMetrics fm;
 
@@ -120,11 +125,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   // Used For mouse Dragging and resizing graphs
   int graphStretch = -1;
 
-  int graphStretchY = -1;
+  int mouseDragLastX = -1;
 
-  int min; // used by mouseDragged to see if user
+  int mouseDragLastY = -1;
 
-  int max; // used by mouseDragged to see if user
+  DragMode dragMode = DragMode.Undefined;
 
   boolean mouseDragging = false;
 
@@ -310,7 +315,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     else if (action.equals(LABEL))
     {
       String exMesg = collectAnnotVals(anot, LABEL);
-      String label = JvOptionPane.showInputDialog(this,
+      String label = JvOptionPane.showInputDialog(
               MessageManager.getString("label.enter_label"), exMesg);
 
       if (label == null)
@@ -342,24 +347,31 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
     else if (action.equals(COLOUR))
     {
-      Color col = JColorChooser.showDialog(this,
-              MessageManager.getString("label.select_foreground_colour"),
-              Color.black);
-
-      for (int index : av.getColumnSelection().getSelected())
+      final Annotation[] fAnot = anot;
+      String title = MessageManager
+              .getString("label.select_foreground_colour");
+      ColourChooserListener listener = new ColourChooserListener()
       {
-        if (!av.getAlignment().getHiddenColumns().isVisible(index))
-        {
-          continue;
-        }
-
-        if (anot[index] == null)
+        @Override
+        public void colourSelected(Color c)
         {
-          anot[index] = new Annotation("", "", ' ', 0);
-        }
-
-        anot[index].colour = col;
-      }
+          HiddenColumns hiddenColumns = av.getAlignment()
+                  .getHiddenColumns();
+          for (int index : av.getColumnSelection().getSelected())
+          {
+            if (hiddenColumns.isVisible(index))
+            {
+              if (fAnot[index] == null)
+              {
+                fAnot[index] = new Annotation("", "", ' ', 0);
+              }
+              fAnot[index].colour = c;
+            }
+          }
+        };
+      };
+      JalviewColourChooser.showColourChooser(this, title, Color.black,
+              listener);
     }
     else
     // HELIX, SHEET or STEM
@@ -500,10 +512,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   }
 
   /**
-   * DOCUMENT ME!
+   * Action on right mouse pressed on Mac is to show a pop-up menu for the
+   * annotation. Action on left mouse pressed is to find which annotation is
+   * pressed and mark the start of a column selection or graph resize operation.
    * 
    * @param evt
-   *          DOCUMENT ME!
    */
   @Override
   public void mousePressed(MouseEvent evt)
@@ -514,7 +527,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     {
       return;
     }
+    mouseDragLastX = evt.getX();
+    mouseDragLastY = evt.getY();
 
+    /*
+     * add visible annotation heights until we reach the y
+     * position, to find which annotation it is in
+     */
     int height = 0;
     activeRow = -1;
 
@@ -534,11 +553,11 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         }
         else if (aa[i].graph > 0)
         {
-          // Stretch Graph
+          /*
+           * we have clicked on a resizable graph annotation
+           */
           graphStretch = i;
-          graphStretchY = y;
         }
-
         break;
       }
     }
@@ -604,17 +623,24 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   }
 
   /**
-   * DOCUMENT ME!
+   * Action on mouse up is to clear mouse drag data and call mouseReleased on
+   * ScalePanel, to deal with defining the selection group (if any) defined by
+   * the mouse drag
    * 
    * @param evt
-   *          DOCUMENT ME!
    */
   @Override
   public void mouseReleased(MouseEvent evt)
   {
     graphStretch = -1;
-    graphStretchY = -1;
+    mouseDragLastX = -1;
+    mouseDragLastY = -1;
     mouseDragging = false;
+    if (dragMode == DragMode.Resize)
+    {
+      ap.adjustAnnotationHeight();
+    }
+    dragMode = DragMode.Undefined;
     ap.getScalePanel().mouseReleased(evt);
 
     /*
@@ -637,14 +663,15 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   @Override
   public void mouseEntered(MouseEvent evt)
   {
+    this.mouseDragging = false;
     ap.getScalePanel().mouseEntered(evt);
   }
 
   /**
-   * DOCUMENT ME!
+   * On leaving the panel, calls ScalePanel.mouseExited to deal with scrolling
+   * with column selection on a mouse drag
    * 
    * @param evt
-   *          DOCUMENT ME!
    */
   @Override
   public void mouseExited(MouseEvent evt)
@@ -653,32 +680,90 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   }
 
   /**
-   * DOCUMENT ME!
+   * Action on starting or continuing a mouse drag. There are two possible
+   * actions:
+   * <ul>
+   * <li>drag up or down on a graphed annotation increases or decreases the
+   * height of the graph</li>
+   * <li>dragging left or right selects the columns dragged across</li>
+   * </ul>
+   * A drag on a graph annotation is treated as column selection if it starts
+   * with more horizontal than vertical movement, and as resize if it starts
+   * with more vertical than horizontal movement. Once started, the drag does
+   * not change mode.
    * 
    * @param evt
-   *          DOCUMENT ME!
    */
   @Override
   public void mouseDragged(MouseEvent evt)
   {
-    if (graphStretch > -1)
+    /*
+     * if dragMode is Undefined:
+     * - set to Select if dx > dy
+     * - set to Resize if dy > dx
+     * - do nothing if dx == dy
+     */
+    final int x = evt.getX();
+    final int y = evt.getY();
+    if (dragMode == DragMode.Undefined)
     {
-      av.getAlignment()
-              .getAlignmentAnnotation()[graphStretch].graphHeight += graphStretchY
-                      - evt.getY();
-      if (av.getAlignment()
-              .getAlignmentAnnotation()[graphStretch].graphHeight < 0)
+      int dx = Math.abs(x - mouseDragLastX);
+      int dy = Math.abs(y - mouseDragLastY);
+      if (graphStretch == -1 || dx > dy)
+      {
+        /*
+         * mostly horizontal drag, or not a graph annotation
+         */
+        dragMode = DragMode.Select;
+      }
+      else if (dy > dx)
       {
-        av.getAlignment()
-                .getAlignmentAnnotation()[graphStretch].graphHeight = 0;
+        /*
+         * mostly vertical drag
+         */
+        dragMode = DragMode.Resize;
       }
-      graphStretchY = evt.getY();
-      adjustPanelHeight();
-      ap.paintAlignment(false, false);
     }
-    else
+
+    if (dragMode == DragMode.Undefined)
     {
-      ap.getScalePanel().mouseDragged(evt);
+      /*
+       * drag is diagonal - defer deciding whether to
+       * treat as up/down or left/right
+       */
+      return;
+    }
+
+    try
+    {
+      if (dragMode == DragMode.Resize)
+      {
+        /*
+         * resize graph annotation if mouse was dragged up or down
+         */
+        int deltaY = mouseDragLastY - evt.getY();
+        if (deltaY != 0)
+        {
+          AlignmentAnnotation graphAnnotation = av.getAlignment()
+                  .getAlignmentAnnotation()[graphStretch];
+          int newHeight = Math.max(0, graphAnnotation.graphHeight + deltaY);
+          graphAnnotation.graphHeight = newHeight;
+          adjustPanelHeight();
+          ap.paintAlignment(false, false);
+        }
+      }
+      else
+      {
+        /*
+         * for mouse drag left or right, delegate to 
+         * ScalePanel to adjust the column selection
+         */
+        ap.getScalePanel().mouseDragged(evt);
+      }
+    } finally
+    {
+      mouseDragLastX = x;
+      mouseDragLastY = y;
     }
   }
 
@@ -716,7 +801,9 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     if (row > -1 && ann.annotations != null
             && column < ann.annotations.length)
     {
-      setToolTipText(buildToolTip(ann, column, aa));
+      String toolTip = buildToolTip(ann, column, aa);
+      setToolTipText(toolTip == null ? null
+              : JvSwingUtils.wrapTooltip(true, toolTip));
       String msg = getStatusMessage(av.getAlignment(), column, ann);
       ap.alignFrame.setStatus(msg);
     }
@@ -763,7 +850,9 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   }
 
   /**
-   * Answers a tooltip for the annotation at the current mouse position
+   * Answers a tooltip for the annotation at the current mouse position, not
+   * wrapped in &lt;html&gt; tags (apply if wanted). Answers null if there is no
+   * tooltip to show.
    * 
    * @param ann
    * @param column
@@ -776,45 +865,33 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     if (ann.graphGroup > -1)
     {
       StringBuilder tip = new StringBuilder(32);
-      tip.append("<html>");
+      boolean first = true;
       for (int i = 0; i < anns.length; i++)
       {
         if (anns[i].graphGroup == ann.graphGroup
                 && anns[i].annotations[column] != null)
         {
+          if (!first)
+          {
+            tip.append("<br>");
+          }
+          first = false;
           tip.append(anns[i].label);
           String description = anns[i].annotations[column].description;
           if (description != null && description.length() > 0)
           {
             tip.append(" ").append(description);
           }
-          tip.append("<br>");
         }
       }
-      if (tip.length() != 6)
-      {
-        tip.setLength(tip.length() - 4);
-        tooltip = tip.toString() + "</html>";
-      }
+      tooltip = first ? null : tip.toString();
     }
     else if (column < ann.annotations.length
             && ann.annotations[column] != null)
     {
-      String description = ann.annotations[column].description;
-      if (description != null && description.length() > 0)
-      {
-        tooltip = JvSwingUtils.wrapTooltip(true, description);
-      }
-      else
-      {
-        tooltip = null; // no tooltip if null or empty description
-      }
-    }
-    else
-    {
-      // clear the tooltip.
-      tooltip = null;
+      tooltip = ann.annotations[column].description;
     }
+
     return tooltip;
   }
 
@@ -925,6 +1002,9 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   private volatile boolean imageFresh = false;
 
+  private Rectangle visibleRect = new Rectangle(),
+          clipBounds = new Rectangle();
+
   /**
    * DOCUMENT ME!
    * 
@@ -934,16 +1014,27 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   @Override
   public void paintComponent(Graphics g)
   {
-    super.paintComponent(g);
+
+    // BH: note that this method is generally recommended to
+    // call super.paintComponent(g). Otherwise, the children of this
+    // component will not be rendered. That is not needed here
+    // because AnnotationPanel does not have any children. It is
+    // just a JPanel contained in a JViewPort.
+
+    computeVisibleRect(visibleRect);
 
     g.setColor(Color.white);
-    g.fillRect(0, 0, getWidth(), getHeight());
+    g.fillRect(0, 0, visibleRect.width, visibleRect.height);
 
     if (image != null)
     {
-      if (fastPaint || (getVisibleRect().width != g.getClipBounds().width)
-              || (getVisibleRect().height != g.getClipBounds().height))
+      // BH 2018 optimizing generation of new Rectangle().
+      if (fastPaint
+              || (visibleRect.width != (clipBounds = g
+                      .getClipBounds(clipBounds)).width)
+              || (visibleRect.height != clipBounds.height))
       {
+
         g.drawImage(image, 0, 0, this);
         fastPaint = false;
         return;
@@ -955,6 +1046,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     {
       return;
     }
+    Graphics2D gg;
     if (image == null || imgWidth != image.getWidth(this)
             || image.getHeight(this) != getHeight())
     {
@@ -991,9 +1083,15 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       gg.fillRect(0, 0, imgWidth, image.getHeight());
       imageFresh = true;
     }
-    
+    else
+    {
+      gg = (Graphics2D) image.getGraphics();
+
+    }
+
     drawComponent(gg, av.getRanges().getStartRes(),
             av.getRanges().getEndRes() + 1);
+    gg.dispose();
     imageFresh = false;
     g.drawImage(image, 0, 0, this);
   }
@@ -1011,7 +1109,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
    */
   public void fastPaint(int horizontal)
   {
-    if ((horizontal == 0) || gg == null
+    if ((horizontal == 0) || image == null
             || av.getAlignment().getAlignmentAnnotation() == null
             || av.getAlignment().getAlignmentAnnotation().length < 1
             || av.isCalcInProgress())
@@ -1024,25 +1122,31 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     int er = av.getRanges().getEndRes() + 1;
     int transX = 0;
 
-    gg.copyArea(0, 0, imgWidth, getHeight(),
-            -horizontal * av.getCharWidth(), 0);
+    Graphics2D gg = (Graphics2D) image.getGraphics();
 
-    if (horizontal > 0) // scrollbar pulled right, image to the left
-    {
-      transX = (er - sr - horizontal) * av.getCharWidth();
-      sr = er - horizontal;
-    }
-    else if (horizontal < 0)
-    {
-      er = sr - horizontal;
+    if (imgWidth>Math.abs(horizontal*av.getCharWidth())) {
+      //scroll is less than imgWidth away so can re-use buffered graphics
+      gg.copyArea(0, 0, imgWidth, getHeight(),
+              -horizontal * av.getCharWidth(), 0);
+      
+      if (horizontal > 0) // scrollbar pulled right, image to the left
+      {
+        transX = (er - sr - horizontal) * av.getCharWidth();
+        sr = er - horizontal;
+      }
+      else if (horizontal < 0)
+      {
+        er = sr - horizontal;
+      }
     }
-
     gg.translate(transX, 0);
 
     drawComponent(gg, sr, er);
 
     gg.translate(-transX, 0);
 
+    gg.dispose();
+
     fastPaint = true;
 
     // Call repaint on alignment panel so that repaints from other alignment
@@ -1186,7 +1290,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     ap = null;
     image = null;
     fadedImage = null;
-    gg = null;
+    // gg = null;
     _mwl = null;
 
     /*
@@ -1240,7 +1344,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
      * hscroll, status bar, insets. 
      */
     int stuff = (ap.getViewName() != null ? 30 : 0)
-            + (Platform.isAMac() ? 120 : 140);
+            + (Platform.isAMacAndNotJS() ? 120 : 140);
     int availableHeight = ap.alignFrame.getHeight() - stuff;
     int rowHeight = av.getCharHeight();