JAL-1421 typed map / lists, explicit imports, method refactoring
[jalview.git] / src / jalview / gui / SeqPanel.java
index 791a371..1f1dd2f 100644 (file)
  */
 package jalview.gui;
 
-import java.awt.BorderLayout;
-import java.awt.Color;
-import java.awt.Font;
-import java.awt.FontMetrics;
-import java.awt.Point;
-import java.awt.event.MouseEvent;
-import java.awt.event.MouseListener;
-import java.awt.event.MouseMotionListener;
-import java.awt.event.MouseWheelEvent;
-import java.awt.event.MouseWheelListener;
-import java.util.List;
-import java.util.Vector;
-
-import javax.swing.JOptionPane;
-import javax.swing.JPanel;
-import javax.swing.ToolTipManager;
-
 import jalview.api.AlignViewportI;
+import jalview.bin.Cache;
 import jalview.commands.EditCommand;
 import jalview.commands.EditCommand.Action;
 import jalview.commands.EditCommand.Edit;
+import jalview.datamodel.AlignmentI;
 import jalview.datamodel.ColumnSelection;
 import jalview.datamodel.SearchResults;
 import jalview.datamodel.SearchResults.Match;
@@ -60,6 +45,24 @@ import jalview.util.MappingUtils;
 import jalview.util.MessageManager;
 import jalview.viewmodel.AlignmentViewport;
 
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Point;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.awt.event.MouseWheelEvent;
+import java.awt.event.MouseWheelListener;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.SwingUtilities;
+import javax.swing.ToolTipManager;
+
 /**
  * DOCUMENT ME!
  * 
@@ -128,6 +131,8 @@ public class SeqPanel extends JPanel implements MouseListener,
 
   StructureSelectionManager ssm;
 
+  SearchResults lastSearchResults;
+
   /**
    * Creates a new SeqPanel object.
    * 
@@ -167,6 +172,13 @@ public class SeqPanel extends JPanel implements MouseListener,
 
   int wrappedBlock = -1;
 
+  /**
+   * Returns the aligned sequence position (base 0) at the mouse position, or
+   * the closest visible one
+   * 
+   * @param evt
+   * @return
+   */
   int findRes(MouseEvent evt)
   {
     int res = 0;
@@ -182,8 +194,7 @@ public class SeqPanel extends JPanel implements MouseListener,
       }
 
       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
-              + hgap
-              + seqCanvas.getAnnotationHeight();
+              + hgap + seqCanvas.getAnnotationHeight();
 
       int y = evt.getY();
       y -= hgap;
@@ -203,13 +214,18 @@ public class SeqPanel extends JPanel implements MouseListener,
     }
     else
     {
-      if (x > seqCanvas.getWidth() + seqCanvas.getWidth())
+      if (x > seqCanvas.getX() + seqCanvas.getWidth())
       {
         // make sure we calculate relative to visible alignment, rather than
         // right-hand gutter
         x = seqCanvas.getX() + seqCanvas.getWidth();
       }
       res = (x / av.getCharWidth()) + av.getStartRes();
+      if (res > av.getEndRes())
+      {
+        // moused off right
+        res = av.getEndRes();
+      }
     }
 
     if (av.hasHiddenColumns())
@@ -235,8 +251,7 @@ public class SeqPanel extends JPanel implements MouseListener,
       }
 
       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
-              + hgap
-              + seqCanvas.getAnnotationHeight();
+              + hgap + seqCanvas.getAnnotationHeight();
 
       y -= hgap;
 
@@ -496,6 +511,7 @@ public class SeqPanel extends JPanel implements MouseListener,
 
   void insertNucAtCursor(boolean group, String nuc)
   {
+    // TODO not called - delete?
     groupEditing = group;
     startseq = seqCanvas.cursorY;
     lastres = seqCanvas.cursorX;
@@ -586,7 +602,7 @@ public class SeqPanel extends JPanel implements MouseListener,
   {
     lastMousePress = evt.getPoint();
 
-    if (javax.swing.SwingUtilities.isMiddleMouseButton(evt))
+    if (SwingUtilities.isMiddleMouseButton(evt))
     {
       mouseWheelPressed = true;
       return;
@@ -644,18 +660,30 @@ public class SeqPanel extends JPanel implements MouseListener,
     lastMessage = tmp;
   }
 
+  /**
+   * Highlight the mapped region described by the search results object (unless
+   * unchanged). This supports highlight of protein while mousing over linked
+   * cDNA and vice versa. The status bar is also updated to show the location of
+   * the start of the highlighted region.
+   */
   @Override
   public void highlightSequence(SearchResults results)
   {
+    if (results == null || results.equals(lastSearchResults))
+    {
+      return;
+    }
+    lastSearchResults = results;
+
     if (av.isFollowHighlight())
     {
       /*
-       * if scrollToPosition requires scroll adjustment, this flag prevents
+       * if scrollToPosition requires a scroll adjustment, this flag prevents
        * another scroll event being propagated back to the originator
        * 
        * @see AlignmentPanel#adjustmentValueChanged
        */
-      ap.setFollowingComplementScroll(true);
+      ap.setDontScrollComplement(true);
       if (ap.scrollToPosition(results, false))
       {
         seqCanvas.revalidate();
@@ -670,6 +698,7 @@ public class SeqPanel extends JPanel implements MouseListener,
   {
     return this.ap == null ? null : this.ap.av;
   }
+
   @Override
   public void updateColours(SequenceI seq, int index)
   {
@@ -741,9 +770,9 @@ public class SeqPanel extends JPanel implements MouseListener,
     if (av.isShowSequenceFeatures())
     {
       int rpos;
-      List<SequenceFeature> features = ap.getFeatureRenderer().findFeaturesAtRes(
-              sequence.getDatasetSequence(),
-              rpos = sequence.findPosition(res));
+      List<SequenceFeature> features = ap.getFeatureRenderer()
+              .findFeaturesAtRes(sequence.getDatasetSequence(),
+                      rpos = sequence.findPosition(res));
       seqARep.appendFeatures(tooltipText, rpos, features,
               this.ap.getSeqPanel().seqCanvas.fr.getMinMax());
     }
@@ -775,6 +804,7 @@ public class SeqPanel extends JPanel implements MouseListener,
    * 
    * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
    */
+  @Override
   public Point getToolTipLocation(MouseEvent event)
   {
     int x = event.getX(), w = getWidth();
@@ -830,8 +860,9 @@ public class SeqPanel extends JPanel implements MouseListener,
     }
     else
     {
-      residue = "X".equalsIgnoreCase(displayChar) ? "X"
-              : ResidueProperties.aa2Triplet.get(displayChar);
+      residue = "X".equalsIgnoreCase(displayChar) ? "X" : ("*"
+              .equals(displayChar) ? "STOP" : ResidueProperties.aa2Triplet
+              .get(displayChar));
       if (residue != null)
       {
         text.append(" Residue: ").append(residue);
@@ -856,19 +887,31 @@ public class SeqPanel extends JPanel implements MouseListener,
    */
   private void setStatusMessage(SearchResults results)
   {
-    List<Match> matches = results.getResults();
-    if (!matches.isEmpty())
+    AlignmentI al = this.av.getAlignment();
+    int sequenceIndex = al.findIndex(results);
+    if (sequenceIndex == -1)
+    {
+      return;
+    }
+    SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
+    for (Match m : results.getResults())
     {
-      Match m = matches.get(0);
       SequenceI seq = m.getSequence();
-      int sequenceIndex = this.av.getAlignment().findIndex(seq);
+      if (seq.getDatasetSequence() != null)
+      {
+        seq = seq.getDatasetSequence();
+      }
 
-      /*
-       * Convert position in sequence (base 1) to sequence character array index
-       * (base 0)
-       */
-      int start = m.getStart() - 1;
-      setStatusMessage(seq, start, sequenceIndex);
+      if (seq == ds)
+      {
+        /*
+         * Convert position in sequence (base 1) to sequence character array
+         * index (base 0)
+         */
+        int start = m.getStart() - m.getSequence().getStart();
+        setStatusMessage(seq, start, sequenceIndex);
+        return;
+      }
     }
   }
 
@@ -995,7 +1038,8 @@ public class SeqPanel extends JPanel implements MouseListener,
       message.append("Edit group:");
       if (editCommand == null)
       {
-        editCommand = new EditCommand(MessageManager.getString("action.edit_group"));
+        editCommand = new EditCommand(
+                MessageManager.getString("action.edit_group"));
       }
     }
     else
@@ -1008,7 +1052,8 @@ public class SeqPanel extends JPanel implements MouseListener,
       }
       if (editCommand == null)
       {
-        editCommand = new EditCommand(MessageManager.formatMessage("label.edit_params", new String[]{label}));
+        editCommand = new EditCommand(MessageManager.formatMessage(
+                "label.edit_params", new String[] { label }));
       }
     }
 
@@ -1129,8 +1174,7 @@ public class SeqPanel extends JPanel implements MouseListener,
           {
             for (int j = 0; j < startres - lastres; j++)
             {
-              if (!jalview.util.Comparison.isGap(groupSeqs[g]
-                      .getCharAt(fixedRight - j)))
+              if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
               {
                 blank = false;
                 break;
@@ -1192,7 +1236,7 @@ public class SeqPanel extends JPanel implements MouseListener,
               continue;
             }
 
-            if (!jalview.util.Comparison.isGap(groupSeqs[g].getCharAt(j)))
+            if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
             {
               // Not a gap, block edit not valid
               endEditing();
@@ -1246,14 +1290,13 @@ public class SeqPanel extends JPanel implements MouseListener,
         {
           for (int j = lastres; j < startres; j++)
           {
-            insertChar(j, new SequenceI[]
-            { seq }, fixedRight);
+            insertChar(j, new SequenceI[] { seq }, fixedRight);
           }
         }
         else
         {
-          appendEdit(Action.INSERT_GAP, new SequenceI[]
-          { seq }, lastres, startres - lastres);
+          appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
+                  startres - lastres);
         }
       }
       else
@@ -1270,8 +1313,7 @@ public class SeqPanel extends JPanel implements MouseListener,
                 endEditing();
                 break;
               }
-              deleteChar(startres, new SequenceI[]
-              { seq }, fixedRight);
+              deleteChar(startres, new SequenceI[] { seq }, fixedRight);
             }
           }
           else
@@ -1289,8 +1331,8 @@ public class SeqPanel extends JPanel implements MouseListener,
 
             if (max > 0)
             {
-              appendEdit(Action.DELETE_GAP, new SequenceI[]
-              { seq }, startres, max);
+              appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
+                      startres, max);
             }
           }
         }
@@ -1300,14 +1342,13 @@ public class SeqPanel extends JPanel implements MouseListener,
           {
             for (int j = lastres; j < startres; j++)
             {
-              insertChar(j, new SequenceI[]
-              { seq }, fixedRight);
+              insertChar(j, new SequenceI[] { seq }, fixedRight);
             }
           }
           else
           {
-            appendEdit(Action.INSERT_NUC, new SequenceI[]
-            { seq }, lastres, startres - lastres);
+            appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
+                    startres - lastres);
           }
         }
       }
@@ -1327,7 +1368,7 @@ public class SeqPanel extends JPanel implements MouseListener,
 
       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
       {
-        if (jalview.util.Comparison.isGap(seq[s].getCharAt(blankColumn)))
+        if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
         {
           // Theres a space, so break and insert the gap
           break;
@@ -1363,8 +1404,7 @@ public class SeqPanel extends JPanel implements MouseListener,
     final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
             av.getAlignment().getGapCharacter());
 
-    editCommand.appendEdit(edit, av.getAlignment(),
-            true, null);
+    editCommand.appendEdit(edit, av.getAlignment(), true, null);
   }
 
   void deleteChar(int j, SequenceI[] seq, int fixedColumn)
@@ -1430,21 +1470,23 @@ public class SeqPanel extends JPanel implements MouseListener,
         av.setSelectionGroup(null);
       }
 
-      List<SequenceFeature> features = seqCanvas.getFeatureRenderer().findFeaturesAtRes(
-              sequence.getDatasetSequence(),
-              sequence.findPosition(findRes(evt)));
+      List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
+              .findFeaturesAtRes(sequence.getDatasetSequence(),
+                      sequence.findPosition(findRes(evt)));
 
-      if (features != null && features.size()> 0)
+      if (features != null && features.size() > 0)
       {
         SearchResults highlight = new SearchResults();
-        highlight.addResult(sequence, features.get(0).getBegin(),
-                features.get(0).getEnd());
+        highlight.addResult(sequence, features.get(0).getBegin(), features
+                .get(0).getEnd());
         seqCanvas.highlightSearchResults(highlight);
       }
-      if (features != null && features.size()> 0)
+      if (features != null && features.size() > 0)
       {
-        seqCanvas.getFeatureRenderer().amendFeatures(new SequenceI[]
-        { sequence }, features.toArray(new SequenceFeature[features.size()]), false, ap);
+        seqCanvas.getFeatureRenderer().amendFeatures(
+                new SequenceI[] { sequence },
+                features.toArray(new SequenceFeature[features.size()]),
+                false, ap);
 
         seqCanvas.highlightSearchResults(null);
       }
@@ -1557,23 +1599,24 @@ public class SeqPanel extends JPanel implements MouseListener,
 
     }
 
-    if (javax.swing.SwingUtilities.isRightMouseButton(evt))
+    if (SwingUtilities.isRightMouseButton(evt))
     {
-      List<SequenceFeature> allFeatures = ap.getFeatureRenderer().findFeaturesAtRes(
-              sequence.getDatasetSequence(), sequence.findPosition(res));
-      Vector links = new Vector();
-      for (SequenceFeature sf:allFeatures)
+      List<SequenceFeature> allFeatures = ap.getFeatureRenderer()
+              .findFeaturesAtRes(sequence.getDatasetSequence(),
+                      sequence.findPosition(res));
+      List<String> links = new ArrayList<String>();
+      for (SequenceFeature sf : allFeatures)
       {
         if (sf.links != null)
         {
-          for (int j = 0; j < sf.links.size(); j++)
+          for (String link : sf.links)
           {
-            links.addElement(sf.links.elementAt(j));
+            links.add(link);
           }
         }
       }
 
-      jalview.gui.PopupMenu pop = new jalview.gui.PopupMenu(ap, null, links);
+      PopupMenu pop = new PopupMenu(ap, null, links);
       pop.show(this, evt.getX(), evt.getY());
       return;
     }
@@ -1878,8 +1921,7 @@ public class SeqPanel extends JPanel implements MouseListener,
     // handles selection messages...
     // TODO: extend config options to allow user to control if selections may be
     // shared between viewports.
-    boolean iSentTheSelection = (av == source
-            || (source instanceof AlignViewport && ((AlignmentViewport) source)
+    boolean iSentTheSelection = (av == source || (source instanceof AlignViewport && ((AlignmentViewport) source)
             .getSequenceSetId().equals(av.getSequenceSetId())));
     if (iSentTheSelection || !av.followSelection)
     {
@@ -1915,7 +1957,7 @@ public class SeqPanel extends JPanel implements MouseListener,
     {
       if (av.getAlignment() == null)
       {
-        jalview.bin.Cache.log.warn("alignviewport av SeqSetId="
+        Cache.log.warn("alignviewport av SeqSetId="
                 + av.getSequenceSetId() + " ViewId=" + av.getViewId()
                 + " 's alignment is NULL! returning immediately.");
         return;
@@ -1923,7 +1965,7 @@ public class SeqPanel extends JPanel implements MouseListener,
       sgroup = seqsel.intersect(av.getAlignment(),
               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
       if ((sgroup == null || sgroup.getSize() == 0)
-              || (colsel == null || colsel.size() == 0))
+              || (colsel == null || colsel.isEmpty()))
       {
         // don't copy columns if the region didn't intersect.
         copycolsel = false;
@@ -1944,7 +1986,7 @@ public class SeqPanel extends JPanel implements MouseListener,
     {
       // the current selection is unset or from a previous message
       // so import the new colsel.
-      if (colsel == null || colsel.size() == 0)
+      if (colsel == null || colsel.isEmpty())
       {
         if (av.getColumnSelection() != null)
         {
@@ -1995,11 +2037,13 @@ public class SeqPanel extends JPanel implements MouseListener,
   protected boolean selectionFromTranslation(SequenceGroup seqsel,
           ColumnSelection colsel, SelectionSource source)
   {
-    if (!(source instanceof AlignViewportI)) {
+    if (!(source instanceof AlignViewportI))
+    {
       return false;
     }
     final AlignViewportI sourceAv = (AlignViewportI) source;
-    if (sourceAv.getCodingComplement() != av && av.getCodingComplement() != sourceAv)
+    if (sourceAv.getCodingComplement() != av
+            && av.getCodingComplement() != sourceAv)
     {
       return false;
     }