JAL-1620 version bump and release notes
[jalview.git] / src / jalview / gui / AnnotationLabels.java
index 6d32c04..9c1db3d 100755 (executable)
@@ -1,33 +1,62 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
-import java.util.*;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.Annotation;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.io.FormatAdapter;
+import jalview.util.MessageManager;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.Image;
+import java.awt.MediaTracker;
+import java.awt.RenderingHints;
+import java.awt.Toolkit;
+import java.awt.datatransfer.StringSelection;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.awt.geom.AffineTransform;
+import java.awt.image.BufferedImage;
+import java.util.Arrays;
+import java.util.Vector;
 import java.util.regex.Pattern;
 
-import java.awt.*;
-import java.awt.datatransfer.*;
-import java.awt.event.*;
-import java.awt.image.*;
-import javax.swing.*;
-
-import jalview.datamodel.*;
-import jalview.io.*;
+import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JMenuItem;
+import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
+import javax.swing.SwingUtilities;
+import javax.swing.ToolTipManager;
 
 /**
  * DOCUMENT ME!
@@ -38,21 +67,21 @@ import jalview.io.*;
 public class AnnotationLabels extends JPanel implements MouseListener,
         MouseMotionListener, ActionListener
 {
-  static String TOGGLE_LABELSCALE = "Scale Label to Column";
+  String TOGGLE_LABELSCALE = MessageManager.getString("label.scale_label_to_column");
 
-  static String ADDNEW = "Add New Row";
+  String ADDNEW = MessageManager.getString("label.add_new_row");
 
-  static String EDITNAME = "Edit Label/Description";
+  String EDITNAME = MessageManager.getString("label.edit_label_description");
 
-  static String HIDE = "Hide This Row";
+  String HIDE = MessageManager.getString("label.hide_row");
 
-  static String DELETE = "Delete This Row";
+  String DELETE = MessageManager.getString("label.delete_row");
 
-  static String SHOWALL = "Show All Hidden Rows";
+  String SHOWALL = MessageManager.getString("label.show_all_hidden_rows");
 
-  static String OUTPUT_TEXT = "Export Annotation";
+  String OUTPUT_TEXT = MessageManager.getString("label.export_annotation");
 
-  static String COPYCONS_SEQ = "Copy Consensus Sequence";
+  String COPYCONS_SEQ = MessageManager.getString("label.copy_consensus_sequence");
 
   boolean resizePanel = false;
 
@@ -110,10 +139,11 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     Graphics2D g = (Graphics2D) bi.getGraphics();
     g.rotate(Math.toRadians(90));
     g.drawImage(temp, 0, -bi.getWidth(this), this);
-    image = (Image) bi;
+    image = bi;
 
     addMouseListener(this);
     addMouseMotionListener(this);
+    addMouseWheelListener(ap.annotationPanel);
   }
 
   public AnnotationLabels(AlignViewport av)
@@ -143,7 +173,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
   void getSelectedRow(int y)
   {
     int height = 0;
-    AlignmentAnnotation[] aa = ap.av.getAlignment().getAlignmentAnnotation();
+    AlignmentAnnotation[] aa = ap.av.getAlignment()
+            .getAlignmentAnnotation();
     selectedRow = -2;
     if (aa != null)
     {
@@ -175,7 +206,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
    */
   public void actionPerformed(ActionEvent evt)
   {
-    AlignmentAnnotation[] aa = ap.av.getAlignment().getAlignmentAnnotation();
+    AlignmentAnnotation[] aa = ap.av.getAlignment()
+            .getAlignmentAnnotation();
 
     if (evt.getActionCommand().equals(ADDNEW))
     {
@@ -241,11 +273,18 @@ public class AnnotationLabels extends JPanel implements MouseListener,
       aa[selectedRow].scaleColLabel = !aa[selectedRow].scaleColLabel;
     }
 
+    refresh();
+
+  }
+
+  /**
+   * Redraw sensibly.
+   */
+  protected void refresh()
+  {
     ap.validateAnnotationDimensions(false);
     ap.addNotify();
     ap.repaint();
-    //validate();
-    //ap.paintAlignment(true);
   }
 
   /**
@@ -311,7 +350,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
       {
         end = ap.av.getAlignment().getAlignmentAnnotation().length - 1;
       }
-      AlignmentAnnotation endAA = ap.av.getAlignment().getAlignmentAnnotation()[end];
+      AlignmentAnnotation endAA = ap.av.getAlignment()
+              .getAlignmentAnnotation()[end];
 
       ap.av.getAlignment().getAlignmentAnnotation()[end] = startAA;
       ap.av.getAlignment().getAlignmentAnnotation()[start] = endAA;
@@ -404,52 +444,73 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     if (selectedRow > -1
             && ap.av.getAlignment().getAlignmentAnnotation().length > selectedRow)
     {
-      AlignmentAnnotation aa = ap.av.getAlignment().getAlignmentAnnotation()[selectedRow];
-      
+      AlignmentAnnotation aa = ap.av.getAlignment()
+              .getAlignmentAnnotation()[selectedRow];
+
       StringBuffer desc = new StringBuffer();
       if (aa.description != null
               && !aa.description.equals("New description"))
       {
-        // TODO: we could refactor and merge this code with the code in jalview.gui.SeqPanel.mouseMoved(..) that formats sequence feature tooltips
+        // TODO: we could refactor and merge this code with the code in
+        // jalview.gui.SeqPanel.mouseMoved(..) that formats sequence feature
+        // tooltips
         desc.append(aa.getDescription(true).trim());
         // check to see if the description is an html fragment.
-        if (desc.length()<6 || (desc.substring(0,6).toLowerCase().indexOf("<html>")<0))
+        if (desc.length() < 6
+                || (desc.substring(0, 6).toLowerCase().indexOf("<html>") < 0))
         {
           // clean the description ready for embedding in html
-          desc = new StringBuffer(Pattern.compile("<").matcher(desc).replaceAll("&lt;"));        
+          desc = new StringBuffer(Pattern.compile("<").matcher(desc)
+                  .replaceAll("&lt;"));
           desc.insert(0, "<html>");
-        } else {
-               // remove terminating html if any
-               int i=desc.substring(desc.length()-7).toLowerCase().lastIndexOf("</html>");
-               if (i>-1) {
-                 desc.setLength(desc.length()-7+i);
-               }
+        }
+        else
+        {
+          // remove terminating html if any
+          int i = desc.substring(desc.length() - 7).toLowerCase()
+                  .lastIndexOf("</html>");
+          if (i > -1)
+          {
+            desc.setLength(desc.length() - 7 + i);
+          }
         }
         if (aa.hasScore())
         {
           desc.append("<br/>");
         }
-        
-        
-      } else {
-        // begin the tooltip's html fragment
-        desc.append("<html>");
+        // if (aa.hasProperties())
+        // {
+        // desc.append("<table>");
+        // for (String prop : aa.getProperties())
+        // {
+        // desc.append("<tr><td>" + prop + "</td><td>"
+        // + aa.getProperty(prop) + "</td><tr>");
+        // }
+        // desc.append("</table>");
+        // }
       }
-      if (aa.hasScore())
+      else
       {
-        // TODO: limit precision of score to avoid noise from imprecise doubles (64.7 becomes 64.7+/some tiny value).
-        desc.append(" Score: " + aa.score);
+        // begin the tooltip's html fragment
+        desc.append("<html>");
+        if (aa.hasScore())
+        {
+          // TODO: limit precision of score to avoid noise from imprecise
+          // doubles
+          // (64.7 becomes 64.7+/some tiny value).
+          desc.append(" Score: " + aa.score);
+        }
       }
-
       if (desc.length() > 6)
       {
         desc.append("</html>");
         this.setToolTipText(desc.toString());
       }
       else
+      {
         this.setToolTipText(null);
+      }
     }
-
   }
 
   /**
@@ -460,7 +521,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
    */
   public void mouseClicked(MouseEvent evt)
   {
-    AlignmentAnnotation[] aa = ap.av.getAlignment().getAlignmentAnnotation();
+    final AlignmentAnnotation[] aa = ap.av.getAlignment()
+            .getAlignmentAnnotation();
     if (SwingUtilities.isLeftMouseButton(evt))
     {
       if (selectedRow > -1 && selectedRow < aa.length)
@@ -469,7 +531,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
         {
           if (evt.getClickCount() >= 2)
           {
-            // todo: make the ap scroll to the selection - not necessary, first click highlights/scrolls, second selects
+            // todo: make the ap scroll to the selection - not necessary, first
+            // click highlights/scrolls, second selects
             ap.seqPanel.ap.idPanel.highlightSearchResults(null);
             ap.av.setSelectionGroup(// new SequenceGroup(
             aa[selectedRow].groupRef); // );
@@ -487,17 +550,40 @@ public class AnnotationLabels extends JPanel implements MouseListener,
         }
         else if (aa[selectedRow].sequenceRef != null)
         {
-          Vector sr = new Vector();
-          sr.addElement(aa[selectedRow].sequenceRef);
           if (evt.getClickCount() == 1)
           {
-            ap.seqPanel.ap.idPanel.highlightSearchResults(sr);
+            ap.seqPanel.ap.idPanel.highlightSearchResults(Arrays
+                    .asList(new SequenceI[]
+                    { aa[selectedRow].sequenceRef }));
           }
           else if (evt.getClickCount() >= 2)
           {
             ap.seqPanel.ap.idPanel.highlightSearchResults(null);
-            SequenceGroup sg = new SequenceGroup();
-            sg.addSequence(aa[selectedRow].sequenceRef, false);
+            SequenceGroup sg = ap.av.getSelectionGroup();
+            if (sg!=null)
+            {
+              // we make a copy rather than edit the current selection if no modifiers pressed
+              // see Enhancement JAL-1557
+              if (!(evt.isControlDown() || evt.isShiftDown()))
+              {
+                sg = new SequenceGroup(sg);
+                sg.clear();
+                sg.addSequence(aa[selectedRow].sequenceRef, false);
+              } else {
+                if (evt.isControlDown())
+                {
+                  sg.addOrRemove(aa[selectedRow].sequenceRef, true);
+                } else {
+                  // notionally, we should also add intermediate sequences from last added sequence ?
+                  sg.addSequence(aa[selectedRow].sequenceRef, true);
+                }
+              }
+            } else {
+              sg = new SequenceGroup();
+              sg.setStartRes(0);
+              sg.setEndRes(ap.av.getAlignment().getWidth()-1);
+              sg.addSequence(aa[selectedRow].sequenceRef, false);
+            }
             ap.av.setSelectionGroup(sg);
             ap.av.sendSelection();
             ap.paintAlignment(false);
@@ -512,7 +598,8 @@ public class AnnotationLabels extends JPanel implements MouseListener,
       return;
     }
 
-    JPopupMenu pop = new JPopupMenu("Annotations");
+    JPopupMenu pop = new JPopupMenu(
+            MessageManager.getString("label.annotations"));
     JMenuItem item = new JMenuItem(ADDNEW);
     item.addActionListener(this);
     pop.add(item);
@@ -533,6 +620,35 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     item = new JMenuItem(HIDE);
     item.addActionListener(this);
     pop.add(item);
+    // JAL-1264 hide all sequence-specific annotations of this type
+    final String label = aa[selectedRow].label;
+    if (selectedRow < aa.length)
+    {
+      if (aa[selectedRow].sequenceRef != null)
+      {
+        JMenuItem hideType = new JMenuItem();
+        String text = MessageManager.getString("label.hide_all") + " " + label;
+        hideType.setText(text);
+        hideType.addActionListener(new ActionListener()
+        {
+          @Override
+          public void actionPerformed(ActionEvent e)
+          {
+            for (AlignmentAnnotation ann : ap.av.getAlignment()
+                    .getAlignmentAnnotation())
+            {
+              if (ann.sequenceRef != null && ann.label != null
+                      && ann.label.equals(label))
+              {
+                ann.visible = false;
+              }
+            }
+            refresh();
+          }
+        });
+        pop.add(hideType);
+      }
+    }
     item = new JMenuItem(DELETE);
     item.addActionListener(this);
     pop.add(item);
@@ -562,12 +678,12 @@ public class AnnotationLabels extends JPanel implements MouseListener,
           pop.add(item);
         }
       }
-      else if (aa[selectedRow].label.indexOf("Consensus") > -1)
+      else if (label.indexOf("Consensus") > -1)
       {
         pop.addSeparator();
         // av and sequencegroup need to implement same interface for
         final JCheckBoxMenuItem cbmi = new JCheckBoxMenuItem(
-                "Ignore Gaps In Consensus",
+                       MessageManager.getString("label.ignore_gaps_consensus"),
                 (aa[selectedRow].groupRef != null) ? aa[selectedRow].groupRef
                         .getIgnoreGapsConsensus() : ap.av
                         .getIgnoreGapsConsensus());
@@ -593,7 +709,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
         if (aaa.groupRef != null)
         {
           final JCheckBoxMenuItem chist = new JCheckBoxMenuItem(
-                  "Show Group Histogram",
+                         MessageManager.getString("label.show_group_histogram"),
                   aa[selectedRow].groupRef.isShowConsensusHistogram());
           chist.addActionListener(new ActionListener()
           {
@@ -612,7 +728,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
           });
           pop.add(chist);
           final JCheckBoxMenuItem cprofl = new JCheckBoxMenuItem(
-                  "Show Group Logo",
+                         MessageManager.getString("label.show_group_logo"),
                   aa[selectedRow].groupRef.isShowSequenceLogo());
           cprofl.addActionListener(new ActionListener()
           {
@@ -631,13 +747,13 @@ public class AnnotationLabels extends JPanel implements MouseListener,
           });
           pop.add(cprofl);
           final JCheckBoxMenuItem cproflnorm = new JCheckBoxMenuItem(
-                  "Normalise Group Logo",
+                         MessageManager.getString("label.normalise_group_logo"),
                   aa[selectedRow].groupRef.isNormaliseSequenceLogo());
           cproflnorm.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
             {
-              
+
               // TODO: pass on reference
               // to ap
               // so the
@@ -656,7 +772,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
         else
         {
           final JCheckBoxMenuItem chist = new JCheckBoxMenuItem(
-                  "Show Histogram", av.isShowConsensusHistogram());
+                         MessageManager.getString("label.show_histogram"), av.isShowConsensusHistogram());
           chist.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
@@ -675,7 +791,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
           });
           pop.add(chist);
           final JCheckBoxMenuItem cprof = new JCheckBoxMenuItem(
-                  "Show Logo", av.isShowSequenceLogo());
+                         MessageManager.getString("label.show_logo"), av.isShowSequenceLogo());
           cprof.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
@@ -694,7 +810,7 @@ public class AnnotationLabels extends JPanel implements MouseListener,
           });
           pop.add(cprof);
           final JCheckBoxMenuItem cprofnorm = new JCheckBoxMenuItem(
-                  "Normalise Logo", av.isNormaliseSequenceLogo());
+                         MessageManager.getString("label.normalise_logo"), av.isNormaliseSequenceLogo());
           cprofnorm.addActionListener(new ActionListener()
           {
             public void actionPerformed(ActionEvent e)
@@ -798,18 +914,41 @@ public class AnnotationLabels extends JPanel implements MouseListener,
               RenderingHints.VALUE_ANTIALIAS_ON);
     }
 
-    drawComponent(g2, width);
+    drawComponent(g2, true, width);
 
   }
 
   /**
-   * DOCUMENT ME!
+   * Draw the full set of annotation Labels for the alignment at the given
+   * cursor
    * 
    * @param g
-   *          DOCUMENT ME!
+   *          Graphics2D instance (needed for font scaling)
+   * @param width
+   *          Width for scaling labels
+   * 
    */
   public void drawComponent(Graphics g, int width)
   {
+    drawComponent(g, false, width);
+  }
+
+  private final boolean debugRedraw = false;
+
+  /**
+   * Draw the full set of annotation Labels for the alignment at the given
+   * cursor
+   * 
+   * @param g
+   *          Graphics2D instance (needed for font scaling)
+   * @param clip
+   *          - true indicates that only current visible area needs to be
+   *          rendered
+   * @param width
+   *          Width for scaling labels
+   */
+  public void drawComponent(Graphics g, boolean clip, int width)
+  {
     if (av.getFont().getSize() < 10)
     {
       g.setFont(font);
@@ -832,21 +971,65 @@ public class AnnotationLabels extends JPanel implements MouseListener,
     int x = 0;
     int graphExtras = 0;
     int offset = 0;
-
+    Font baseFont = g.getFont();
+    FontMetrics baseMetrics = fm;
+    int ofontH = fontHeight;
+    int sOffset = 0;
+    int visHeight = 0;
+    int[] visr = (ap != null && ap.annotationPanel != null) ? ap.annotationPanel
+            .getVisibleVRange() : null;
+    if (clip && visr != null)
+    {
+      sOffset = visr[0];
+      visHeight = visr[1];
+    }
+    boolean visible = true, before = false, after = false;
     if (aa != null)
     {
       hasHiddenRows = false;
+      int olY = 0;
       for (int i = 0; i < aa.length; i++)
       {
-        g.setColor(Color.black);
-
+        visible = true;
         if (!aa[i].visible)
         {
           hasHiddenRows = true;
           continue;
         }
-
+        olY = y;
         y += aa[i].height;
+        if (clip)
+        {
+          if (y < sOffset)
+          {
+            if (!before)
+            {
+              if (debugRedraw)
+              {
+                System.out.println("before vis: " + i);
+              }
+              before = true;
+            }
+            // don't draw what isn't visible
+            continue;
+          }
+          if (olY > visHeight)
+          {
+
+            if (!after)
+            {
+              if (debugRedraw)
+              {
+                System.out.println("Scroll offset: " + sOffset
+                        + " after vis: " + i);
+              }
+              after = true;
+            }
+            // don't draw what isn't visible
+            continue;
+          }
+        }
+        g.setColor(Color.black);
 
         offset = -aa[i].height / 2;
 
@@ -856,13 +1039,17 @@ public class AnnotationLabels extends JPanel implements MouseListener,
           offset -= fm.getDescent();
         }
         else
+        {
           offset += fm.getDescent();
+        }
 
         x = width - fm.stringWidth(aa[i].label) - 3;
 
         if (aa[i].graphGroup > -1)
         {
           int groupSize = 0;
+          // TODO: JAL-1291 revise rendering model so the graphGroup map is
+          // computed efficiently for all visible labels
           for (int gg = 0; gg < aa.length; gg++)
           {
             if (aa[gg].graphGroup == aa[i].graphGroup)
@@ -870,30 +1057,55 @@ public class AnnotationLabels extends JPanel implements MouseListener,
               groupSize++;
             }
           }
-
           if (groupSize * (fontHeight + 8) < aa[i].height)
           {
             graphExtras = (aa[i].height - (groupSize * (fontHeight + 8))) / 2;
           }
-
-          for (int gg = 0; gg < aa.length; gg++)
+          else
           {
-            if (aa[gg].graphGroup == aa[i].graphGroup)
+            // scale font to fit
+            float h = aa[i].height / (float) groupSize, s;
+            if (h < 9)
+            {
+              visible = false;
+            }
+            else
             {
-              x = width - fm.stringWidth(aa[gg].label) - 3;
-              g.drawString(aa[gg].label, x, y - graphExtras);
-              if (aa[gg].annotations[0] != null)
+              fontHeight = -8 + (int) h;
+              s = ((float) fontHeight) / (float) ofontH;
+              Font f = baseFont.deriveFont(AffineTransform
+                      .getScaleInstance(s, s));
+              g.setFont(f);
+              fm = g.getFontMetrics();
+              graphExtras = (aa[i].height - (groupSize * (fontHeight + 8))) / 2;
+            }
+          }
+          if (visible)
+          {
+            for (int gg = 0; gg < aa.length; gg++)
+            {
+              if (aa[gg].graphGroup == aa[i].graphGroup)
               {
-                g.setColor(aa[gg].annotations[0].colour);
-              }
+                x = width - fm.stringWidth(aa[gg].label) - 3;
+                g.drawString(aa[gg].label, x, y - graphExtras);
 
-              g.drawLine(x, y - graphExtras - 3,
-                      x + fm.stringWidth(aa[gg].label), y - graphExtras - 3);
+                if (aa[gg]._linecolour != null)
+                {
 
-              g.setColor(Color.black);
-              graphExtras += fontHeight + 8;
+                  g.setColor(aa[gg]._linecolour);
+                  g.drawLine(x, y - graphExtras + 3,
+                          x + fm.stringWidth(aa[gg].label), y - graphExtras
+                                  + 3);
+                }
+
+                g.setColor(Color.black);
+                graphExtras += fontHeight + 8;
+              }
             }
           }
+          g.setFont(baseFont);
+          fm = baseMetrics;
+          fontHeight = ofontH;
         }
         else
         {
@@ -913,10 +1125,11 @@ public class AnnotationLabels extends JPanel implements MouseListener,
               dragEvent.getY() - scrollOffset);
     }
 
-    if ((aa == null) || (aa.length < 1))
+    if (!av.wrapAlignment && ((aa == null) || (aa.length < 1)))
     {
-      g.drawString("Right click", 2, 8);
-      g.drawString("to add annotation", 2, 18);
+      g.drawString(MessageManager.getString("label.right_click"), 2, 8);
+      g.drawString(MessageManager.getString("label.to_add_annotation"), 2,
+              18);
     }
   }
 }