JAL-3026 major update 1/2
[jalview.git] / src / jalview / gui / AnnotationPanel.java
index e98b79e..1460985 100755 (executable)
@@ -25,12 +25,14 @@ 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.viewmodel.ViewportListenerI;
+import jalview.viewmodel.ViewportRanges;
 
 import java.awt.AlphaComposite;
 import java.awt.Color;
@@ -56,7 +58,6 @@ 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;
@@ -74,6 +75,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");
@@ -117,11 +123,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;
 
@@ -174,11 +180,12 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     if (e.isShiftDown())
     {
       e.consume();
-      if (e.getWheelRotation() > 0)
+      double wheelRotation = e.getPreciseWheelRotation();
+      if (wheelRotation > 0)
       {
         av.getRanges().scrollRight(true);
       }
-      else
+      else if (wheelRotation < 0)
       {
         av.getRanges().scrollRight(false);
       }
@@ -284,7 +291,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
     if (anot.length < av.getColumnSelection().getMax())
     {
-      Annotation[] temp = new Annotation[av.getColumnSelection().getMax() + 2];
+      Annotation[] temp = new Annotation[av.getColumnSelection().getMax()
+              + 2];
       System.arraycopy(anot, 0, temp, 0, anot.length);
       anot = temp;
       aa[activeRow].annotations = anot;
@@ -336,24 +344,29 @@ 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
@@ -412,8 +425,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
           anot[index] = new Annotation(label, "", type, 0);
         }
 
-        anot[index].secondaryStructure = type != 'S' ? type : label
-                .length() == 0 ? ' ' : label.charAt(0);
+        anot[index].secondaryStructure = type != 'S' ? type
+                : label.length() == 0 ? ' ' : label.charAt(0);
         anot[index].displayCharacter = label;
 
       }
@@ -494,10 +507,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)
@@ -508,7 +522,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;
 
@@ -528,11 +548,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;
       }
     }
@@ -598,17 +618,20 @@ 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;
+    dragMode = DragMode.Undefined;
     ap.getScalePanel().mouseReleased(evt);
 
     /*
@@ -631,14 +654,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)
@@ -655,21 +679,73 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   @Override
   public void mouseDragged(MouseEvent evt)
   {
-    if (graphStretch > -1)
+    /*
+     * todo: 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(true);
     }
-    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;
     }
   }
 
@@ -719,7 +795,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     if (av.hasHiddenColumns())
     {
       column = av.getAlignment().getHiddenColumns()
-              .adjustForHiddenColumns(column);
+              .visibleToAbsoluteColumn(column);
     }
 
     AlignmentAnnotation ann = aa[row];
@@ -777,6 +853,10 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       {
         this.setToolTipText(JvSwingUtils.wrapTooltip(true, description));
       }
+      else
+      {
+        this.setToolTipText(null); // no tooltip if null or empty description
+      }
     }
     else
     {
@@ -819,8 +899,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       int seqIndex = av.getAlignment().findIndex(seqref);
       if (seqIndex != -1)
       {
-        text.append(", ")
-                .append(MessageManager.getString("label.sequence"))
+        text.append(", ").append(MessageManager.getString("label.sequence"))
                 .append(" ").append(seqIndex + 1);
         char residue = seqref.getCharAt(column);
         if (!Comparison.isGap(residue))
@@ -829,16 +908,17 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
           String name;
           if (av.getAlignment().isNucleotide())
           {
-            name = ResidueProperties.nucleotideName.get(String
-                    .valueOf(residue));
-            text.append(" Nucleotide: ").append(
-                    name != null ? name : residue);
+            name = ResidueProperties.nucleotideName
+                    .get(String.valueOf(residue));
+            text.append(" Nucleotide: ")
+                    .append(name != null ? name : residue);
           }
           else
           {
-            name = 'X' == residue ? "X" : ('*' == residue ? "STOP"
-                    : ResidueProperties.aa2Triplet.get(String
-                            .valueOf(residue)));
+            name = 'X' == residue ? "X"
+                    : ('*' == residue ? "STOP"
+                            : ResidueProperties.aa2Triplet
+                                    .get(String.valueOf(residue)));
             text.append(" Residue: ").append(name != null ? name : residue);
           }
           int residuePos = seqref.findPosition(column);
@@ -899,6 +979,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   @Override
   public void paintComponent(Graphics g)
   {
+    super.paintComponent(g);
+
     g.setColor(Color.white);
     g.fillRect(0, 0, getWidth(), getHeight());
 
@@ -912,8 +994,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         return;
       }
     }
-    imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes() + 1)
-            * av.getCharWidth();
+    imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
+            + 1) * av.getCharWidth();
     if (imgWidth < 1)
     {
       return;
@@ -923,8 +1005,9 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     {
       try
       {
-        image = new BufferedImage(imgWidth, ap.getAnnotationPanel()
-                .getHeight(), BufferedImage.TYPE_INT_RGB);
+        image = new BufferedImage(imgWidth,
+                ap.getAnnotationPanel().getHeight(),
+                BufferedImage.TYPE_INT_RGB);
       } catch (OutOfMemoryError oom)
       {
         try
@@ -953,9 +1036,9 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       gg.fillRect(0, 0, imgWidth, image.getHeight());
       imageFresh = true;
     }
-
-    drawComponent(gg, av.getRanges().getStartRes(), av.getRanges()
-            .getEndRes() + 1);
+    
+    drawComponent(gg, av.getRanges().getStartRes(),
+            av.getRanges().getEndRes() + 1);
     imageFresh = false;
     g.drawImage(image, 0, 0, this);
   }
@@ -971,7 +1054,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
    * @param horizontal
    *          repaint with horizontal shift in alignment
    */
-  public void fastPaint(int horizontal, boolean isresize)
+  public void fastPaint(int horizontal)
   {
     if ((horizontal == 0) || gg == null
             || av.getAlignment().getAlignmentAnnotation() == null
@@ -985,42 +1068,18 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     int sr = av.getRanges().getStartRes();
     int er = av.getRanges().getEndRes() + 1;
     int transX = 0;
-    long stime;
-    long mtime;
-
-    if (isresize)
-    {
-      imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
-              + 1) * av.getCharWidth();
-
-      BufferedImage newimage = new BufferedImage(imgWidth,
-              ap.getAnnotationPanel().getHeight(),
-              BufferedImage.TYPE_INT_ARGB);
 
-      gg = (Graphics2D) newimage.getGraphics();
-      gg.setFont(av.getFont());
-      gg.drawImage(image, null, 0, 0);
-      image = newimage;
+    gg.copyArea(0, 0, imgWidth, getHeight(),
+            -horizontal * av.getCharWidth(), 0);
 
-      transX = (er - horizontal - sr) * av.getCharWidth();
-      sr = er - horizontal - sr;
+    if (horizontal > 0) // scrollbar pulled right, image to the left
+    {
+      transX = (er - sr - horizontal) * av.getCharWidth();
+      sr = er - horizontal;
     }
-    else
+    else if (horizontal < 0)
     {
-      stime = System.currentTimeMillis();
-      gg.copyArea(0, 0, imgWidth, getHeight(),
-              -horizontal * av.getCharWidth(), 0);
-      mtime = System.currentTimeMillis();
-
-      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;
-      }
+      er = sr - horizontal;
     }
 
     gg.translate(transX, 0);
@@ -1028,17 +1087,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     drawComponent(gg, sr, er);
 
     gg.translate(-transX, 0);
-    long dtime = System.currentTimeMillis();
+
     fastPaint = true;
-    repaint();
-    long rtime = System.currentTimeMillis();
-    if (debugRedraw)
-    {
-      System.err.println("Scroll:\t" + horizontal + "\tCopyArea:\t"
-              + (mtime - stime) + "\tDraw component:\t" + (dtime - mtime)
-              + "\tRepaint call:\t" + (rtime - dtime));
-    }
 
+    // Call repaint on alignment panel so that repaints from other alignment
+    // panel components can be aggregated. Otherwise performance of the overview
+    // window and others may be adversely affected.
+    av.getAlignPanel().repaint();
   }
 
   private volatile boolean lastImageGood = false;
@@ -1067,8 +1122,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
       // and draw a faded image until the calculation
       // has completed
       if (lastImageGood
-              && (fadedImage == null || fadedImage.getWidth() != imgWidth || fadedImage
-                      .getHeight() != image.getHeight()))
+              && (fadedImage == null || fadedImage.getWidth() != imgWidth
+                      || fadedImage.getHeight() != image.getHeight()))
       {
         // System.err.println("redraw faded image ("+(fadedImage==null ?
         // "null image" : "") + " lastGood="+lastImageGood+")");
@@ -1080,8 +1135,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
         fadedG.setColor(Color.white);
         fadedG.fillRect(0, 0, imgWidth, image.getHeight());
 
-        fadedG.setComposite(AlphaComposite.getInstance(
-                AlphaComposite.SRC_OVER, .3f));
+        fadedG.setComposite(
+                AlphaComposite.getInstance(AlphaComposite.SRC_OVER, .3f));
         fadedG.drawImage(image, 0, 0, this);
 
       }
@@ -1122,8 +1177,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
       return;
     }
-    lastImageGood = renderer.drawComponent(this, av, g, activeRow,
-            startRes, endRes);
+    lastImageGood = renderer.drawComponent(this, av, g, activeRow, startRes,
+            endRes);
     if (!lastImageGood && fadedImage == null)
     {
       fadedImage = oldFaded;
@@ -1192,14 +1247,23 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
   public void propertyChange(PropertyChangeEvent evt)
   {
     // Respond to viewport range changes (e.g. alignment panel was scrolled)
-    if (evt.getPropertyName().equals("startres"))
+    // Both scrolling and resizing change viewport ranges: scrolling changes
+    // both start and end points, but resize only changes end values.
+    // Here we only want to fastpaint on a scroll, with resize using a normal
+    // paint, so scroll events are identified as changes to the horizontal or
+    // vertical start value.
+    if (evt.getPropertyName().equals(ViewportRanges.STARTRES))
+    {
+      fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
+    }
+    else if (evt.getPropertyName().equals(ViewportRanges.STARTRESANDSEQ))
     {
-      fastPaint((int) evt.getNewValue() - (int) evt.getOldValue(), false);
+      fastPaint(((int[]) evt.getNewValue())[0]
+              - ((int[]) evt.getOldValue())[0]);
     }
-    else if (evt.getPropertyName().equals("endres"))
+    else if (evt.getPropertyName().equals(ViewportRanges.MOVE_VIEWPORT))
     {
-      // resize
-      fastPaint((int) evt.getNewValue() - (int) evt.getOldValue(), true);
+      repaint();
     }
   }
 }