JAL-2089 patch broken merge to master for Release 2.10.0b1
[jalview.git] / src / jalview / appletgui / AnnotationPanel.java
index d533498..6012c1a 100755 (executable)
@@ -1,37 +1,56 @@
 /*
- * 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-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.appletgui;
 
-import java.util.*;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.font.LineMetrics;
-import java.awt.geom.AffineTransform;
-
-import jalview.analysis.AAFrequency;
-import jalview.datamodel.*;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.Annotation;
+import jalview.datamodel.SequenceI;
 import jalview.renderer.AnnotationRenderer;
 import jalview.renderer.AwtRenderPanelI;
-import jalview.schemes.ColourSchemeI;
-
-public class AnnotationPanel extends Panel implements AwtRenderPanelI, AdjustmentListener,
-        ActionListener, MouseListener, MouseMotionListener
+import jalview.schemes.ResidueProperties;
+import jalview.util.Comparison;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Image;
+import java.awt.MenuItem;
+import java.awt.Panel;
+import java.awt.PopupMenu;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.AdjustmentEvent;
+import java.awt.event.AdjustmentListener;
+import java.awt.event.InputEvent;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+
+public class AnnotationPanel extends Panel implements AwtRenderPanelI,
+        AdjustmentListener, ActionListener, MouseListener,
+        MouseMotionListener
 {
   AlignViewport av;
 
@@ -39,21 +58,24 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
 
   int activeRow = -1;
 
-  Vector activeRes;
+  final String HELIX = "Helix";
 
-  static String HELIX = "Helix";
+  final String SHEET = "Sheet";
 
-  static String SHEET = "Sheet";
+  /**
+   * For RNA secondary structure "stems" aka helices
+   */
+  final String STEM = "RNA Helix";
 
-  static String LABEL = "Label";
+  final String LABEL = "Label";
 
-  static String REMOVE = "Remove Annotation";
+  final String REMOVE = "Remove Annotation";
 
-  static String COLOUR = "Colour";
+  final String COLOUR = "Colour";
 
-  static Color HELIX_COLOUR = Color.red.darker();
+  final Color HELIX_COLOUR = Color.red.darker();
 
-  static Color SHEET_COLOUR = Color.green.darker().darker();
+  final Color SHEET_COLOUR = Color.green.darker().darker();
 
   Image image;
 
@@ -80,7 +102,8 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
 
   public AnnotationPanel(AlignmentPanel ap)
   {
-    MAC = new jalview.util.Platform().isAMac();
+    new jalview.util.Platform();
+    MAC = Platform.isAMac();
     this.ap = ap;
     av = ap.av;
     setLayout(null);
@@ -101,6 +124,7 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     renderer = new AnnotationRenderer();
   }
 
+  @Override
   public void adjustmentValueChanged(AdjustmentEvent evt)
   {
   }
@@ -111,6 +135,7 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void actionPerformed(ActionEvent evt)
   {
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
@@ -129,15 +154,21 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     }
 
     String label = "";
-    if (av.getColumnSelection() != null && av.getColumnSelection().size() > 0
+    if (av.getColumnSelection() != null
+            && !av.getColumnSelection().isEmpty()
             && anot[av.getColumnSelection().getMin()] != null)
+    {
       label = anot[av.getColumnSelection().getMin()].displayCharacter;
+    }
 
     if (evt.getActionCommand().equals(REMOVE))
     {
-      for (int i = 0; i < av.getColumnSelection().size(); i++)
+      for (int index : av.getColumnSelection().getSelected())
       {
-        anot[av.getColumnSelection().columnAt(i)] = null;
+        if (av.getColumnSelection().isVisible(index))
+        {
+          anot[index] = null;
+        }
       }
     }
     else if (evt.getActionCommand().equals(LABEL))
@@ -154,12 +185,14 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
         aa[activeRow].hasText = true;
       }
 
-      for (int i = 0; i < av.getColumnSelection().size(); i++)
+      for (int index : av.getColumnSelection().getSelected())
       {
-        int index = av.getColumnSelection().columnAt(i);
-
+        // TODO: JAL-2001 - provide a fast method to list visible selected
+        // columns
         if (!av.getColumnSelection().isVisible(index))
+        {
           continue;
+        }
 
         if (anot[index] == null)
         {
@@ -176,12 +209,12 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
 
       Color col = udc.getColor();
 
-      for (int i = 0; i < av.getColumnSelection().size(); i++)
+      for (int index : av.getColumnSelection().getSelected())
       {
-        int index = av.getColumnSelection().columnAt(i);
-
         if (!av.getColumnSelection().isVisible(index))
+        {
           continue;
+        }
 
         if (anot[index] == null)
         {
@@ -207,6 +240,14 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
         symbol = "\u03B2";
       }
 
+      // Added by LML to color stems
+      else if (evt.getActionCommand().equals(STEM))
+      {
+        type = 'S';
+        int column = av.getColumnSelection().getSelectedRanges().get(0)[0];
+        symbol = aa[activeRow].getDefaultRnaHelixSymbol(column);
+      }
+
       if (!aa[activeRow].hasIcons)
       {
         aa[activeRow].hasIcons = true;
@@ -222,25 +263,33 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
       if ((label.length() > 0) && !aa[activeRow].hasText)
       {
         aa[activeRow].hasText = true;
+        if (evt.getActionCommand().equals(STEM))
+        {
+          aa[activeRow].showAllColLabels = true;
+        }
       }
 
-      for (int i = 0; i < av.getColumnSelection().size(); i++)
+      for (int index : av.getColumnSelection().getSelected())
       {
-        int index = av.getColumnSelection().columnAt(i);
-
         if (!av.getColumnSelection().isVisible(index))
+        {
           continue;
+        }
 
         if (anot[index] == null)
         {
           anot[index] = new Annotation(label, "", type, 0);
         }
 
-        anot[index].secondaryStructure = type;
+        anot[index].secondaryStructure = type != 'S' ? type : label
+                .length() == 0 ? ' ' : label.charAt(0);
         anot[index].displayCharacter = label;
       }
     }
 
+    av.getAlignment().validateAnnotation(aa[activeRow]);
+
+    ap.alignmentChanged();
     adjustPanelHeight();
     repaint();
 
@@ -253,11 +302,16 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
             ap.alignFrame, "Enter Label", 400, 200, true);
 
     if (dialog.accept)
+    {
       return dialog.getName();
+    }
     else
+    {
       return null;
+    }
   }
 
+  @Override
   public void mousePressed(MouseEvent evt)
   {
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
@@ -296,18 +350,31 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     if ((evt.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK
             && activeRow != -1)
     {
-      if (av.getColumnSelection() == null)
+      if (av.getColumnSelection() == null
+              || av.getColumnSelection().isEmpty())
       {
         return;
       }
 
-      PopupMenu pop = new PopupMenu("Structure type");
-      MenuItem item = new MenuItem(HELIX);
-      item.addActionListener(this);
-      pop.add(item);
-      item = new MenuItem(SHEET);
-      item.addActionListener(this);
-      pop.add(item);
+      PopupMenu pop = new PopupMenu(
+              MessageManager.getString("label.structure_type"));
+      MenuItem item;
+
+      if (av.getAlignment().isNucleotide())
+      {
+        item = new MenuItem(STEM);
+        item.addActionListener(this);
+        pop.add(item);
+      }
+      else
+      {
+        item = new MenuItem(HELIX);
+        item.addActionListener(this);
+        pop.add(item);
+        item = new MenuItem(SHEET);
+        item.addActionListener(this);
+        pop.add(item);
+      }
       item = new MenuItem(LABEL);
       item.addActionListener(this);
       pop.add(item);
@@ -323,14 +390,10 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
       return;
     }
 
-    if (aa == null)
-    {
-      return;
-    }
-
     ap.scalePanel.mousePressed(evt);
   }
 
+  @Override
   public void mouseReleased(MouseEvent evt)
   {
     graphStretch = -1;
@@ -344,12 +407,14 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     ap.scalePanel.mouseReleased(evt);
   }
 
+  @Override
   public void mouseClicked(MouseEvent evt)
   {
   }
 
   boolean needValidating = false;
 
+  @Override
   public void mouseDragged(MouseEvent evt)
   {
     if (graphStretch > -1)
@@ -361,7 +426,7 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
         av.getAlignment().getAlignmentAnnotation()[graphStretch].graphHeight = 0;
       }
       graphStretchY = evt.getY();
-      calcPanelHeight();
+      av.calcPanelHeight();
       needValidating = true;
       ap.paintAlignment(true);
     }
@@ -371,6 +436,7 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     }
   }
 
+  @Override
   public void mouseMoved(MouseEvent evt)
   {
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
@@ -396,30 +462,78 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
       }
     }
 
-    int res = evt.getX() / av.getCharWidth() + av.getStartRes();
+    int column = evt.getX() / av.getCharWidth() + av.getStartRes();
 
     if (av.hasHiddenColumns())
     {
-      res = av.getColumnSelection().adjustForHiddenColumns(res);
+      column = av.getColumnSelection().adjustForHiddenColumns(column);
     }
 
-    if (row > -1 && res < aa[row].annotations.length
-            && aa[row].annotations[res] != null)
+    if (row > -1 && column < aa[row].annotations.length
+            && aa[row].annotations[column] != null)
     {
-      StringBuffer text = new StringBuffer("Sequence position " + (res + 1));
-      if (aa[row].annotations[res].description != null)
+      StringBuilder text = new StringBuilder();
+      text.append(MessageManager.getString("label.column")).append(" ")
+              .append(column + 1);
+      String description = aa[row].annotations[column].description;
+      if (description != null && description.length() > 0)
+      {
+        text.append("  ").append(description);
+      }
+
+      /*
+       * if the annotation is sequence-specific, show the sequence number
+       * in the alignment, and (if not a gap) the residue and position
+       */
+      SequenceI seqref = aa[row].sequenceRef;
+      if (seqref != null)
       {
-        text.append("  " + aa[row].annotations[res].description);
+        int seqIndex = av.getAlignment().findIndex(seqref);
+        if (seqIndex != -1)
+        {
+          text.append(", ")
+                  .append(MessageManager.getString("label.sequence"))
+                  .append(" ").append(seqIndex + 1);
+          char residue = seqref.getCharAt(column);
+          if (!Comparison.isGap(residue))
+          {
+            text.append(" ");
+            String name;
+            if (av.getAlignment().isNucleotide())
+            {
+              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)));
+              text.append(" Residue: ").append(
+                      name != null ? name : residue);
+            }
+            int residuePos = seqref.findPosition(column);
+            text.append(" (").append(residuePos).append(")");
+            // int residuePos = seqref.findPosition(column);
+            // text.append(residue).append(" (")
+            // .append(residuePos).append(")");
+          }
+        }
       }
+
       ap.alignFrame.statusBar.setText(text.toString());
     }
   }
 
+  @Override
   public void mouseEntered(MouseEvent evt)
   {
     ap.scalePanel.mouseEntered(evt);
   }
 
+  @Override
   public void mouseExited(MouseEvent evt)
   {
     ap.scalePanel.mouseExited(evt);
@@ -432,7 +546,7 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
 
   public int adjustPanelHeight(boolean repaint)
   {
-    int height = calcPanelHeight();
+    int height = av.calcPanelHeight();
     this.setSize(new Dimension(getSize().width, height));
     if (repaint)
     {
@@ -440,59 +554,13 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     }
     return height;
   }
+
   /**
-   * calculate the height for visible annotation, revalidating bounds where necessary
-   * ABSTRACT GUI METHOD
+   * calculate the height for visible annotation, revalidating bounds where
+   * necessary ABSTRACT GUI METHOD
+   * 
    * @return total height of annotation
    */
-  public int calcPanelHeight()
-  {
-    // setHeight of panels
-    AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
-    int height = 0;
-
-    if (aa != null)
-    {
-      for (int i = 0; i < aa.length; i++)
-      {
-        if (!aa[i].visible)
-        {
-          continue;
-        }
-
-        aa[i].height = 0;
-
-        if (aa[i].hasText)
-        {
-          aa[i].height += av.charHeight;
-        }
-
-        if (aa[i].hasIcons)
-        {
-          aa[i].height += 16;
-        }
-
-        if (aa[i].graph > 0)
-        {
-          aa[i].height += aa[i].graphHeight;
-        }
-
-        if (aa[i].height == 0)
-        {
-          aa[i].height = 20;
-        }
-
-        height += aa[i].height;
-      }
-    }
-    if (height == 0)
-    {
-      height = 20;
-    }
-
-    return height;
-
-  }
 
   public void addEditableColumn(int i)
   {
@@ -513,32 +581,26 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
         }
       }
     }
-
-    if (activeRes == null)
-    {
-      activeRes = new Vector();
-      activeRes.addElement(String.valueOf(i));
-      return;
-    }
-
-    activeRes.addElement(String.valueOf(i));
   }
 
+  @Override
   public void update(Graphics g)
   {
     paint(g);
   }
 
+  @Override
   public void paint(Graphics g)
   {
     Dimension d = getSize();
     imgWidth = d.width;
     // (av.endRes - av.startRes + 1) * av.charWidth;
-    if (imgWidth<1 || d.height<1)
+    if (imgWidth < 1 || d.height < 1)
     {
       return;
     }
-    if (image == null || imgWidth != image.getWidth(this) || d.height != image.getHeight(this))
+    if (image == null || imgWidth != image.getWidth(this)
+            || d.height != image.getHeight(this))
     {
       image = createImage(imgWidth, d.height);
       gg = image.getGraphics();
@@ -563,20 +625,21 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
 
   public void fastPaint(int horizontal)
   {
-    if (horizontal == 0 || av.getAlignment().getAlignmentAnnotation() == null
+    if (horizontal == 0
+            || av.getAlignment().getAlignmentAnnotation() == null
             || av.getAlignment().getAlignmentAnnotation().length < 1)
     {
       repaint();
       return;
     }
 
-    gg.copyArea(0, 0, imgWidth, getSize().height, -horizontal
-            * av.charWidth, 0);
+    gg.copyArea(0, 0, imgWidth, getSize().height,
+            -horizontal * av.getCharWidth(), 0);
     int sr = av.startRes, er = av.endRes + 1, transX = 0;
 
     if (horizontal > 0) // scrollbar pulled right, image to the left
     {
-      transX = (er - sr - horizontal) * av.charWidth;
+      transX = (er - sr - horizontal) * av.getCharWidth();
       sr = er - horizontal;
     }
     else if (horizontal < 0)
@@ -610,7 +673,8 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     g.setFont(ofont);
 
     g.setColor(Color.white);
-    g.fillRect(0, 0, (endRes - startRes) * av.charWidth, getSize().height);
+    g.fillRect(0, 0, (endRes - startRes) * av.getCharWidth(),
+            getSize().height);
 
     if (fm == null)
     {
@@ -625,7 +689,8 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
       g.setColor(Color.black);
       if (av.validCharWidth)
       {
-        g.drawString("Alignment has no annotations", 20, 15);
+        g.drawString(MessageManager
+                .getString("label.alignment_has_no_annotations"), 20, 15);
       }
 
       return;
@@ -634,13 +699,16 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
     renderer.drawComponent(this, av, g, activeRow, startRes, endRes);
     g.translate(0, +scrollOffset);
   }
-  
+
   int scrollOffset = 0;
 
-  public void setScrollOffset(int value)
+  public void setScrollOffset(int value, boolean repaint)
   {
     scrollOffset = value;
-    repaint();
+    if (repaint)
+    {
+      repaint();
+    }
   }
 
   @Override
@@ -660,4 +728,23 @@ public class AnnotationPanel extends Panel implements AwtRenderPanelI, Adjustmen
   {
     return imgWidth;
   }
+
+  private int[] bounds = new int[2];
+
+  @Override
+  public int[] getVisibleVRange()
+  {
+    if (ap != null && ap.alabels != null)
+    {
+      int sOffset = -ap.alabels.scrollOffset;
+      int visHeight = sOffset + ap.annotationPanelHolder.getHeight();
+      bounds[0] = sOffset;
+      bounds[1] = visHeight;
+      return bounds;
+    }
+    else
+    {
+      return null;
+    }
+  }
 }