JAL-3438 spotless for 2.11.2.0
[jalview.git] / src / jalview / gui / IdPanel.java
index e5870df..7b491e4 100755 (executable)
  */
 package jalview.gui;
 
-import jalview.datamodel.Sequence;
-import jalview.datamodel.SequenceFeature;
-import jalview.datamodel.SequenceGroup;
-import jalview.datamodel.SequenceI;
-import jalview.io.SequenceAnnotationReport;
-import jalview.util.MessageManager;
-import jalview.util.UrlLink;
-import jalview.viewmodel.AlignmentViewport;
-
 import java.awt.BorderLayout;
+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.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.JPopupMenu;
 import javax.swing.SwingUtilities;
+import javax.swing.Timer;
 import javax.swing.ToolTipManager;
 
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.gui.SeqPanel.MousePos;
+import jalview.io.SequenceAnnotationReport;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.viewmodel.AlignmentViewport;
+import jalview.viewmodel.ViewportRanges;
+
 /**
  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
  * as well as highlighting ids matched by a search from the Find menu.
@@ -50,8 +54,8 @@ import javax.swing.ToolTipManager;
  * @author $author$
  * @version $Revision$
  */
-public class IdPanel extends JPanel implements MouseListener,
-        MouseMotionListener, MouseWheelListener
+public class IdPanel extends JPanel
+        implements MouseListener, MouseMotionListener, MouseWheelListener
 {
   private IdCanvas idCanvas;
 
@@ -61,8 +65,6 @@ public class IdPanel extends JPanel implements MouseListener,
 
   ScrollThread scrollThread = null;
 
-  String linkImageURL;
-
   int offy;
 
   // int width;
@@ -83,8 +85,7 @@ public class IdPanel extends JPanel implements MouseListener,
     this.av = av;
     alignPanel = parent;
     setIdCanvas(new IdCanvas(av));
-    linkImageURL = getClass().getResource("/images/link.gif").toString();
-    seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
+    seqAnnotReport = new SequenceAnnotationReport(true);
     setLayout(new BorderLayout());
     add(getIdCanvas(), BorderLayout.CENTER);
     addMouseListener(this);
@@ -94,26 +95,45 @@ public class IdPanel extends JPanel implements MouseListener,
   }
 
   /**
-   * Respond to mouse movement by constructing tooltip text for the sequence id
-   * under the mouse.
+   * Responds to mouse movement by setting tooltip text for the sequence id
+   * under the mouse (or possibly annotation label, when in wrapped mode)
    * 
    * @param e
-   *          DOCUMENT ME!
    */
   @Override
   public void mouseMoved(MouseEvent e)
   {
     SeqPanel sp = alignPanel.getSeqPanel();
-    int seq = Math.max(0, sp.findSeq(e));
-    if (seq > -1 && seq < av.getAlignment().getHeight())
+    MousePos pos = sp.findMousePosition(e);
+    if (pos.isOverAnnotation())
     {
-      SequenceI sequence = av.getAlignment().getSequenceAt(seq);
-      StringBuffer tip = new StringBuffer(64);
-      seqAnnotReport.createSequenceAnnotationReport(tip, sequence,
-              av.isShowDBRefs(), av.isShowNPFeats(),
-              sp.seqCanvas.fr.getMinMax());
-      setToolTipText(JvSwingUtils.wrapTooltip(true,
-              sequence.getDisplayId(true) + " " + tip.toString()));
+      /*
+       * mouse is over an annotation label in wrapped mode
+       */
+      AlignmentAnnotation[] anns = av.getAlignment()
+              .getAlignmentAnnotation();
+      AlignmentAnnotation annotation = anns[pos.annotationIndex];
+      setToolTipText(AnnotationLabels.getTooltip(annotation));
+      alignPanel.alignFrame.setStatus(
+              AnnotationLabels.getStatusMessage(annotation, anns));
+    }
+    else
+    {
+      int seq = Math.max(0, pos.seqIndex);
+      if (seq < av.getAlignment().getHeight())
+      {
+        SequenceI sequence = av.getAlignment().getSequenceAt(seq);
+        StringBuilder tip = new StringBuilder(64);
+        tip.append(sequence.getDisplayId(true)).append(" ");
+        seqAnnotReport.createTooltipAnnotationReport(tip, sequence,
+                av.isShowDBRefs(), av.isShowNPFeats(), sp.seqCanvas.fr);
+        setToolTipText(JvSwingUtils.wrapTooltip(true, tip.toString()));
+
+        StringBuilder text = new StringBuilder();
+        text.append("Sequence ").append(String.valueOf(seq + 1))
+                .append(" ID: ").append(sequence.getName());
+        alignPanel.alignFrame.setStatus(text.toString());
+      }
     }
   }
 
@@ -128,7 +148,14 @@ public class IdPanel extends JPanel implements MouseListener,
   {
     mouseDragging = true;
 
-    int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e));
+    MousePos pos = alignPanel.getSeqPanel().findMousePosition(e);
+    if (pos.isOverAnnotation())
+    {
+      // mouse is over annotation label in wrapped mode
+      return;
+    }
+
+    int seq = Math.max(0, pos.seqIndex);
 
     if (seq < lastid)
     {
@@ -140,7 +167,7 @@ public class IdPanel extends JPanel implements MouseListener,
     }
 
     lastid = seq;
-    alignPanel.paintAlignment(true);
+    alignPanel.paintAlignment(false, false);
   }
 
   /**
@@ -150,26 +177,27 @@ public class IdPanel extends JPanel implements MouseListener,
   public void mouseWheelMoved(MouseWheelEvent e)
   {
     e.consume();
-    if (e.getWheelRotation() > 0)
+    double wheelRotation = e.getPreciseWheelRotation();
+    if (wheelRotation > 0)
     {
       if (e.isShiftDown())
       {
-        alignPanel.scrollRight(true);
+        av.getRanges().scrollRight(true);
       }
       else
       {
-        alignPanel.scrollUp(false);
+        av.getRanges().scrollUp(false);
       }
     }
-    else
+    else if (wheelRotation < 0)
     {
       if (e.isShiftDown())
       {
-        alignPanel.scrollRight(false);
+        av.getRanges().scrollRight(false);
       }
       else
       {
-        alignPanel.scrollUp(true);
+        av.getRanges().scrollUp(true);
       }
     }
   }
@@ -198,74 +226,49 @@ public class IdPanel extends JPanel implements MouseListener,
       return;
     }
 
-    Vector links = Preferences.sequenceURLLinks;
-    if (links == null || links.size() < 1)
+    MousePos pos = alignPanel.getSeqPanel().findMousePosition(e);
+    int seq = pos.seqIndex;
+    if (pos.isOverAnnotation() || seq < 0)
     {
       return;
     }
 
-    int seq = alignPanel.getSeqPanel().findSeq(e);
-    String url = null;
-    int i = 0;
     String id = av.getAlignment().getSequenceAt(seq).getName();
-    while (url == null && i < links.size())
-    {
-      // DEFAULT LINK IS FIRST IN THE LINK LIST
-      // BUT IF ITS A REGEX AND DOES NOT MATCH THE NEXT ONE WILL BE TRIED
-      url = links.elementAt(i++).toString();
-      jalview.util.UrlLink urlLink = null;
-      try
-      {
-        urlLink = new UrlLink(url);
-      } catch (Exception foo)
-      {
-        jalview.bin.Cache.log.error("Exception for URLLink '" + url + "'",
-                foo);
-        url = null;
-        continue;
-      }
-      ;
-      if (!urlLink.isValid())
-      {
-        jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
-        url = null;
-        continue;
-      }
+    String url = Preferences.sequenceUrlLinks.getPrimaryUrl(id);
 
-      String urls[] = urlLink.makeUrls(id, true);
-      if (urls == null || urls[0] == null || urls[0].length() < 4)
-      {
-        url = null;
-        continue;
-      }
-      // just take first URL made from regex
-      url = urls[1];
-    }
     try
     {
       jalview.util.BrowserLauncher.openURL(url);
     } catch (Exception ex)
     {
-      JOptionPane.showInternalMessageDialog(Desktop.desktop,
+      JvOptionPane.showInternalMessageDialog(Desktop.desktop,
               MessageManager.getString("label.web_browser_not_found_unix"),
               MessageManager.getString("label.web_browser_not_found"),
-              JOptionPane.WARNING_MESSAGE);
+              JvOptionPane.WARNING_MESSAGE);
       ex.printStackTrace();
     }
   }
 
   /**
-   * DOCUMENT ME!
+   * On (re-)entering the panel, stop any scrolling
    * 
    * @param e
-   *          DOCUMENT ME!
    */
   @Override
   public void mouseEntered(MouseEvent e)
   {
+    stopScrolling();
+  }
+
+  /**
+   * Interrupts the scroll thread if one is running
+   */
+  void stopScrolling()
+  {
     if (scrollThread != null)
     {
-      scrollThread.running = false;
+      scrollThread.stopScrolling();
+      scrollThread = null;
     }
   }
 
@@ -283,15 +286,72 @@ public class IdPanel extends JPanel implements MouseListener,
       return;
     }
 
-    if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
+    if (mouseDragging)
     {
-      scrollThread = new ScrollThread(true);
+      /*
+       * on mouse drag above or below the panel, start 
+       * scrolling if there are more sequences to show
+       */
+      ViewportRanges ranges = av.getRanges();
+      if (e.getY() < 0 && ranges.getStartSeq() > 0)
+      {
+        startScrolling(true);
+      }
+      else if (e.getY() >= getHeight()
+              && ranges.getEndSeq() <= av.getAlignment().getHeight())
+      {
+        startScrolling(false);
+      }
     }
+  }
 
-    if (mouseDragging && (e.getY() >= getHeight())
-            && (av.getAlignment().getHeight() > av.getEndSeq()))
+  /**
+   * Starts scrolling either up or down
+   * 
+   * @param up
+   */
+  void startScrolling(boolean up)
+  {
+    scrollThread = new ScrollThread(up);
+    if (Platform.isJS())
+    {
+      /*
+       * for JalviewJS using Swing Timer
+       */
+      Timer t = new Timer(20, new ActionListener()
+      {
+        @Override
+        public void actionPerformed(ActionEvent e)
+        {
+          if (scrollThread != null)
+          {
+            // if (!scrollOnce() {t.stop();}) gives compiler error :-(
+            scrollThread.scrollOnce();
+          }
+        }
+      });
+      t.addActionListener(new ActionListener()
+      {
+        @Override
+        public void actionPerformed(ActionEvent e)
+        {
+          if (scrollThread == null)
+          {
+            // IdPanel.stopScrolling called
+            t.stop();
+          }
+        }
+      });
+      t.start();
+    }
+    else
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     */
     {
-      scrollThread = new ScrollThread(false);
+      scrollThread.start();
     }
   }
 
@@ -316,35 +376,45 @@ public class IdPanel extends JPanel implements MouseListener,
       return;
     }
 
+    MousePos pos = alignPanel.getSeqPanel().findMousePosition(e);
+
     if (e.isPopupTrigger()) // Mac reports this in mousePressed
     {
-      showPopupMenu(e);
+      showPopupMenu(e, pos);
+      return;
+    }
 
+    /*
+     * defer right-mouse click handling to mouseReleased on Windows
+     * (where isPopupTrigger() will answer true)
+     * NB isRightMouseButton is also true for Cmd-click on Mac
+     */
+    if (Platform.isWinRightButton(e))
+    {
       return;
     }
 
     if ((av.getSelectionGroup() == null)
-            || (!jalview.util.Platform.isControlDown(e)
-                    && !e.isShiftDown() && av.getSelectionGroup() != null))
+            || (!jalview.util.Platform.isControlDown(e) && !e.isShiftDown()
+                    && av.getSelectionGroup() != null))
     {
       av.setSelectionGroup(new SequenceGroup());
       av.getSelectionGroup().setStartRes(0);
       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
     }
 
-    int seq = alignPanel.getSeqPanel().findSeq(e);
     if (e.isShiftDown() && (lastid != -1))
     {
-      selectSeqs(lastid, seq);
+      selectSeqs(lastid, pos.seqIndex);
     }
     else
     {
-      selectSeq(seq);
+      selectSeq(pos.seqIndex);
     }
-    // TODO is this addition ok here?
+
     av.isSelectionGroupChanged(true);
 
-    alignPanel.paintAlignment(true);
+    alignPanel.paintAlignment(false, false);
   }
 
   /**
@@ -352,34 +422,52 @@ public class IdPanel extends JPanel implements MouseListener,
    * 
    * @param e
    */
-  void showPopupMenu(MouseEvent e)
+  void showPopupMenu(MouseEvent e, MousePos pos)
   {
-    int seq2 = alignPanel.getSeqPanel().findSeq(e);
-    Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2);
-    // build a new links menu based on the current links + any non-positional
-    // features
-    Vector<String> nlinks = new Vector<String>(
-            Preferences.sequenceURLLinks);
-    SequenceFeature sfs[] = sq == null ? null : sq.getSequenceFeatures();
-    if (sfs != null)
-    {
-      for (SequenceFeature sf : sfs)
-      {
-        if (sf.begin == sf.end && sf.begin == 0)
-        {
-          if (sf.links != null && sf.links.size() > 0)
-          {
-            for (int l = 0, lSize = sf.links.size(); l < lSize; l++)
-            {
-              nlinks.addElement(sf.links.elementAt(l));
-            }
-          }
-        }
-      }
+    if (pos.isOverAnnotation())
+    {
+      showAnnotationMenu(e, pos);
+      return;
+    }
+
+    Sequence sq = (Sequence) av.getAlignment().getSequenceAt(pos.seqIndex);
+    if (sq != null)
+    {
+      PopupMenu pop = new PopupMenu(alignPanel, sq,
+              Preferences.getGroupURLLinks());
+      pop.show(this, e.getX(), e.getY());
     }
+  }
 
-    PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
-            Preferences.getGroupURLLinks());
+  /**
+   * On right mouse click on a Consensus annotation label, shows a limited popup
+   * menu, with options to configure the consensus calculation and rendering.
+   * 
+   * @param e
+   * @param pos
+   * @see AnnotationLabels#showPopupMenu(MouseEvent)
+   */
+  void showAnnotationMenu(MouseEvent e, MousePos pos)
+  {
+    if (pos.annotationIndex == -1)
+    {
+      return;
+    }
+    AlignmentAnnotation[] anns = this.av.getAlignment()
+            .getAlignmentAnnotation();
+    if (anns == null || pos.annotationIndex >= anns.length)
+    {
+      return;
+    }
+    AlignmentAnnotation ann = anns[pos.annotationIndex];
+    if (!ann.label.contains("Consensus"))
+    {
+      return;
+    }
+
+    JPopupMenu pop = new JPopupMenu(
+            MessageManager.getString("label.annotations"));
+    AnnotationLabels.addConsensusMenuOptions(this.alignPanel, ann, pop);
     pop.show(this, e.getX(), e.getY());
   }
 
@@ -393,7 +481,7 @@ public class IdPanel extends JPanel implements MouseListener,
     lastid = seq;
 
     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
-    av.getSelectionGroup().addOrRemove(pickedSeq, true);
+    av.getSelectionGroup().addOrRemove(pickedSeq, false);
   }
 
   /**
@@ -427,8 +515,8 @@ public class IdPanel extends JPanel implements MouseListener,
 
     for (int i = start; i <= end; i++)
     {
-      av.getSelectionGroup().addSequence(
-              av.getAlignment().getSequenceAt(i), i == end);
+      av.getSelectionGroup().addSequence(av.getAlignment().getSequenceAt(i),
+              false);
     }
   }
 
@@ -443,8 +531,9 @@ public class IdPanel extends JPanel implements MouseListener,
   {
     if (scrollThread != null)
     {
-      scrollThread.running = false;
+      stopScrolling();
     }
+    MousePos pos = alignPanel.getSeqPanel().findMousePosition(e);
 
     mouseDragging = false;
     PaintRefresher.Refresh(this, av.getSequenceSetId());
@@ -453,7 +542,7 @@ public class IdPanel extends JPanel implements MouseListener,
 
     if (e.isPopupTrigger()) // Windows reports this in mouseReleased
     {
-      showPopupMenu(e);
+      showPopupMenu(e, pos);
     }
   }
 
@@ -467,7 +556,7 @@ public class IdPanel extends JPanel implements MouseListener,
   {
     getIdCanvas().setHighlighted(list);
 
-    if (list == null)
+    if (list == null || list.isEmpty())
     {
       return;
     }
@@ -475,9 +564,10 @@ public class IdPanel extends JPanel implements MouseListener,
     int index = av.getAlignment().findIndex(list.get(0));
 
     // do we need to scroll the panel?
-    if ((av.getStartSeq() > index) || (av.getEndSeq() < index))
+    if ((av.getRanges().getStartSeq() > index)
+            || (av.getRanges().getEndSeq() < index))
     {
-      alignPanel.setScrollValues(av.getStartRes(), index);
+      av.getRanges().setStartSeq(index);
     }
   }
 
@@ -491,24 +581,41 @@ public class IdPanel extends JPanel implements MouseListener,
     this.idCanvas = idCanvas;
   }
 
-  // this class allows scrolling off the bottom of the visible alignment
+  /**
+   * Performs scrolling of the visible alignment up or down, adding newly
+   * visible sequences to the current selection
+   */
   class ScrollThread extends Thread
   {
-    boolean running = false;
+    private boolean running = false;
 
-    boolean up = true;
+    private boolean up;
 
+    /**
+     * Constructor for a thread that scrolls either up or down
+     * 
+     * @param up
+     */
     public ScrollThread(boolean up)
     {
       this.up = up;
-      start();
+      setName("IdPanel$ScrollThread$" + String.valueOf(up));
     }
 
+    /**
+     * Sets a flag to stop the scrolling
+     */
     public void stopScrolling()
     {
       running = false;
     }
 
+    /**
+     * Scrolls the alignment either up or down, one row at a time, adding newly
+     * visible sequences to the current selection. Speed is limited to a maximum
+     * of ten rows per second. The thread exits when the end of the alignment is
+     * reached or a flag is set to stop it by a call to stopScrolling.
+     */
     @Override
     public void run()
     {
@@ -516,34 +623,7 @@ public class IdPanel extends JPanel implements MouseListener,
 
       while (running)
       {
-        if (alignPanel.scrollUp(up))
-        {
-          // scroll was ok, so add new sequence to selection
-          int seq = av.getStartSeq();
-
-          if (!up)
-          {
-            seq = av.getEndSeq();
-          }
-
-          if (seq < lastid)
-          {
-            selectSeqs(lastid - 1, seq);
-          }
-          else if (seq > lastid)
-          {
-            selectSeqs(lastid + 1, seq);
-          }
-
-          lastid = seq;
-        }
-        else
-        {
-          running = false;
-        }
-
-        alignPanel.paintAlignment(false);
-
+        running = scrollOnce();
         try
         {
           Thread.sleep(100);
@@ -551,6 +631,27 @@ public class IdPanel extends JPanel implements MouseListener,
         {
         }
       }
+      IdPanel.this.scrollThread = null;
+    }
+
+    /**
+     * Scrolls one row up or down. Answers true if a scroll could be done, false
+     * if not (top or bottom of alignment reached).
+     */
+    boolean scrollOnce()
+    {
+      ViewportRanges ranges = IdPanel.this.av.getRanges();
+      if (ranges.scrollUp(up))
+      {
+        int toSeq = up ? ranges.getStartSeq() : ranges.getEndSeq();
+        int fromSeq = toSeq < lastid ? lastid - 1 : lastid + 1;
+        IdPanel.this.selectSeqs(fromSeq, toSeq);
+        lastid = toSeq;
+        alignPanel.paintAlignment(false, false);
+        return true;
+      }
+
+      return false;
     }
   }
 }