JAL-3071 IdPanel.ScrollThread for JalviewJS, Javadoc
[jalview.git] / src / jalview / gui / IdPanel.java
index 4ccfb2f..8290dcf 100755 (executable)
@@ -20,6 +20,7 @@
  */
 package jalview.gui;
 
+import jalview.bin.Jalview;
 import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceGroup;
@@ -28,8 +29,11 @@ import jalview.io.SequenceAnnotationReport;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.viewmodel.AlignmentViewport;
+import jalview.viewmodel.ViewportRanges;
 
 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;
@@ -39,6 +43,7 @@ import java.util.List;
 
 import javax.swing.JPanel;
 import javax.swing.SwingUtilities;
+import javax.swing.Timer;
 import javax.swing.ToolTipManager;
 
 /**
@@ -108,8 +113,7 @@ public class IdPanel extends JPanel
       SequenceI sequence = av.getAlignment().getSequenceAt(seq);
       StringBuilder tip = new StringBuilder(64);
       seqAnnotReport.createTooltipAnnotationReport(tip, sequence,
-              av.isShowDBRefs(), av.isShowNPFeats(),
-              sp.seqCanvas.fr.getMinMax());
+              av.isShowDBRefs(), av.isShowNPFeats(), sp.seqCanvas.fr);
       setToolTipText(JvSwingUtils.wrapTooltip(true,
               sequence.getDisplayId(true) + " " + tip.toString()));
     }
@@ -138,7 +142,7 @@ public class IdPanel extends JPanel
     }
 
     lastid = seq;
-    alignPanel.paintAlignment(false);
+    alignPanel.paintAlignment(false, false);
   }
 
   /**
@@ -148,24 +152,25 @@ public class IdPanel extends JPanel
   public void mouseWheelMoved(MouseWheelEvent e)
   {
     e.consume();
-    if (e.getWheelRotation() > 0)
+    double wheelRotation = e.getPreciseWheelRotation();
+    if (wheelRotation > 0)
     {
       if (e.isShiftDown())
       {
         av.getRanges().scrollRight(true);
       }
-      else if (!av.getWrapAlignment())
+      else
       {
         av.getRanges().scrollUp(false);
       }
     }
-    else
+    else if (wheelRotation < 0)
     {
       if (e.isShiftDown())
       {
         av.getRanges().scrollRight(false);
       }
-      else if (!av.getWrapAlignment())
+      else
       {
         av.getRanges().scrollUp(true);
       }
@@ -214,17 +219,24 @@ public class IdPanel extends JPanel
   }
 
   /**
-   * 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();
     }
   }
 
@@ -242,16 +254,70 @@ public class IdPanel extends JPanel
       return;
     }
 
-    if (mouseDragging && (e.getY() < 0)
-            && (av.getRanges().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.getRanges().getEndSeq()))
+  /**
+   * Starts scrolling either up or down
+   * 
+   * @param up
+   */
+  void startScrolling(boolean up)
+  {
+    scrollThread = new ScrollThread(up);
+    if (!Jalview.isJS())
     {
-      scrollThread = new ScrollThread(false);
+      /*
+       * Java - run in a new thread
+       */
+      scrollThread.start();
+    }
+    else
+    {
+      /*
+       * 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)
+          {
+            // finished and nulled itself
+            t.stop();
+          }
+        }
+      });
+      t.start();
     }
   }
 
@@ -313,7 +379,7 @@ public class IdPanel extends JPanel
 
     av.isSelectionGroupChanged(true);
 
-    alignPanel.paintAlignment(false);
+    alignPanel.paintAlignment(false, false);
   }
 
   /**
@@ -325,28 +391,25 @@ public class IdPanel extends JPanel
   {
     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
+
+    /*
+     *  build a new links menu based on the current links
+     *  and any non-positional features
+     */
     List<String> nlinks = Preferences.sequenceUrlLinks.getLinksForMenu();
-    SequenceFeature sfs[] = sq == null ? null : sq.getSequenceFeatures();
-    if (sfs != null)
+    List<SequenceFeature> features = sq.getFeatures().getNonPositionalFeatures();
+    for (SequenceFeature sf : features)
     {
-      for (SequenceFeature sf : sfs)
+      if (sf.links != null)
       {
-        if (sf.begin == sf.end && sf.begin == 0)
+        for (String link : sf.links)
         {
-          if (sf.links != null && sf.links.size() > 0)
-          {
-            for (int l = 0, lSize = sf.links.size(); l < lSize; l++)
-            {
-              nlinks.add(sf.links.elementAt(l));
-            }
-          }
+          nlinks.add(link);
         }
       }
     }
 
-    PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
+    PopupMenu pop = new PopupMenu(alignPanel, sq, features,
             Preferences.getGroupURLLinks());
     pop.show(this, e.getX(), e.getY());
   }
@@ -409,10 +472,7 @@ public class IdPanel extends JPanel
   @Override
   public void mouseReleased(MouseEvent e)
   {
-    if (scrollThread != null)
-    {
-      scrollThread.running = false;
-    }
+    stopScrolling();
 
     mouseDragging = false;
     PaintRefresher.Refresh(this, av.getSequenceSetId());
@@ -460,24 +520,42 @@ public class IdPanel extends JPanel
     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;
+      setName("IdPanel$ScrollThread$" + String.valueOf(up));
       start();
     }
 
+    /**
+     * 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()
     {
@@ -485,34 +563,7 @@ public class IdPanel extends JPanel
 
       while (running)
       {
-        if (av.getRanges().scrollUp(up))
-        {
-          // scroll was ok, so add new sequence to selection
-          int seq = av.getRanges().getStartSeq();
-
-          if (!up)
-          {
-            seq = av.getRanges().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);
@@ -520,6 +571,27 @@ public class IdPanel extends JPanel
         {
         }
       }
+      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;
     }
   }
 }