Merge branch 'feature/JAL-3690_callback-based-web-services' into alpha/JAL-3066_Jalvi...
[jalview.git] / src / jalview / gui / AnnotationPanel.java
index 16db94c..15adafc 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
@@ -114,7 +114,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   public volatile BufferedImage fadedImage;
 
-  Graphics2D gg;
+  // private Graphics2D gg;
 
   public FontMetrics fm;
 
@@ -150,6 +150,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
    */
   public AnnotationPanel(AlignmentPanel ap)
   {
+    setName("AnnotationPanel");
     ToolTipManager.sharedInstance().registerComponent(this);
     ToolTipManager.sharedInstance().setInitialDelay(0);
     ToolTipManager.sharedInstance().setDismissDelay(10000);
@@ -315,7 +316,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)
@@ -347,24 +348,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
@@ -629,6 +637,10 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     mouseDragLastX = -1;
     mouseDragLastY = -1;
     mouseDragging = false;
+    if (dragMode == DragMode.Resize)
+    {
+      ap.adjustAnnotationHeight();
+    }
     dragMode = DragMode.Undefined;
     ap.getScalePanel().mouseReleased(evt);
 
@@ -652,14 +664,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)
@@ -668,16 +681,25 @@ 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)
   {
     /*
-     * todo: if dragMode is Undefined:
+     * if dragMode is Undefined:
      * - set to Select if dx > dy
      * - set to Resize if dy > dx
      * - do nothing if dx == dy
@@ -705,14 +727,13 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
 
     if (dragMode == DragMode.Undefined)
-    {
+      {
       /*
        * drag is diagonal - defer deciding whether to
        * treat as up/down or left/right
        */
-      return;
-    }
-
+        return;
+      }
     try
     {
       if (dragMode == DragMode.Resize)
@@ -728,6 +749,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
           int newHeight = Math.max(0, graphAnnotation.graphHeight + deltaY);
           graphAnnotation.graphHeight = newHeight;
           adjustPanelHeight();
+          setNoFastPaint();
           ap.paintAlignment(false, false);
         }
       }
@@ -780,7 +802,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);
     }
@@ -827,7 +851,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
@@ -840,45 +866,37 @@ 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 = ann.annotations[column].description;
+      if ("".equals(tooltip))
       {
-        tooltip = null; // no tooltip if null or empty description
+        tooltip = null;
       }
     }
-    else
-    {
-      // clear the tooltip.
-      tooltip = null;
-    }
+
     return tooltip;
   }
 
@@ -989,6 +1007,9 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   private volatile boolean imageFresh = false;
 
+  private Rectangle visibleRect = new Rectangle(),
+          clipBounds = new Rectangle();
+
   /**
    * DOCUMENT ME!
    * 
@@ -998,27 +1019,43 @@ 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)
+    ViewportRanges ranges = av.getRanges();
+
+    if (allowFastPaint && 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;
       }
     }
-    imgWidth = (av.getRanges().getEndRes() - av.getRanges().getStartRes()
-            + 1) * av.getCharWidth();
+
+    imgWidth = (ranges.getEndRes() - ranges.getStartRes() + 1)
+            * av.getCharWidth();
+
     if (imgWidth < 1)
     {
+      fastPaint = false;
       return;
     }
+    Graphics2D gg;
     if (image == null || imgWidth != image.getWidth(this)
             || image.getHeight(this) != getHeight())
     {
@@ -1055,19 +1092,19 @@ 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);
+    else
+    {
+      gg = (Graphics2D) image.getGraphics();
+
+    }
+
+    drawComponent(gg, ranges.getStartRes(), av.getRanges().getEndRes() + 1);
+    gg.dispose();
     imageFresh = false;
     g.drawImage(image, 0, 0, this);
   }
 
   /**
-   * set true to enable redraw timing debug output on stderr
-   */
-  private final boolean debugRedraw = false;
-
-  /**
    * non-Thread safe repaint
    * 
    * @param horizontal
@@ -1075,7 +1112,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())
@@ -1088,6 +1125,14 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     int er = av.getRanges().getEndRes() + 1;
     int transX = 0;
 
+    if (er == sr + 1)
+    {
+      fastPaint = false;
+      return;
+    }
+
+    Graphics2D gg = (Graphics2D) image.getGraphics();
+
     gg.copyArea(0, 0, imgWidth, getHeight(),
             -horizontal * av.getCharWidth(), 0);
 
@@ -1107,6 +1152,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
     gg.translate(-transX, 0);
 
+    gg.dispose();
+
     fastPaint = true;
 
     // Call repaint on alignment panel so that repaints from other alignment
@@ -1224,6 +1271,8 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
 
   private int[] bounds = new int[2];
 
+  private boolean allowFastPaint;
+
   @Override
   public int[] getVisibleVRange()
   {
@@ -1250,7 +1299,7 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     ap = null;
     image = null;
     fadedImage = null;
-    gg = null;
+    // gg = null;
     _mwl = null;
 
     /*
@@ -1304,7 +1353,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();
 
@@ -1330,4 +1379,14 @@ public class AnnotationPanel extends JPanel implements AwtRenderPanelI,
     }
     return annotationHeight;
   }
+  
+  /**
+   * Clears the flag that allows a 'fast paint' on the next repaint, so
+   * requiring a full repaint
+   */
+  public void setNoFastPaint()
+  {
+    allowFastPaint = false;
+  }
+
 }