JAL-2831 Added move viewport event and set up cursor code to use it

[jalview.git] / src / jalview / viewmodel / ViewportRanges.java

diff --git a/src/jalview/viewmodel/ViewportRanges.java b/src/jalview/viewmodel/ViewportRanges.java
index b1d2c02..9a1e13c 100644 (file)
--- a/src/jalview/viewmodel/ViewportRanges.java
+++ b/src/jalview/viewmodel/ViewportRanges.java
@@ -41,6 +41,8 @@ public class ViewportRanges extends ViewportProperties
 
   public static final String STARTRESANDSEQ = "startresandseq";
 
+  public static final String MOVE_VIEWPORT = "move_viewport";
+
   private boolean wrappedMode = false;
 
   // start residue of viewport
@@ -292,7 +294,9 @@ public class ViewportRanges extends ViewportProperties
   }
 
   /**
-   * Set start residue and start sequence together (fires single event)
+   * Set start residue and start sequence together (fires single event). The
+   * event supplies a pair of old values and a pair of new values: [old start
+   * residue, old start sequence] and [new start residue, new start sequence]
    * 
    * @param res
    *          the start residue
@@ -465,23 +469,39 @@ public class ViewportRanges extends ViewportProperties
    */
   public boolean scrollUp(boolean up)
   {
+    /*
+     * if in unwrapped mode, scroll up or down one sequence row;
+     * if in wrapped mode, scroll by one visible width of columns
+     */
     if (up)
     {
-      if (startSeq < 1)
+      if (wrappedMode)
       {
-        return false;
+        pageUp();
+      }
+      else
+      {
+        if (startSeq < 1)
+        {
+          return false;
+        }
+        setStartSeq(startSeq - 1);
       }
-
-      setStartSeq(startSeq - 1);
     }
     else
     {
-      if (endSeq >= getVisibleAlignmentHeight() - 1)
+      if (wrappedMode)
       {
-        return false;
+        pageDown();
+      }
+      else
+      {
+        if (endSeq >= getVisibleAlignmentHeight() - 1)
+        {
+          return false;
+        }
+        setStartSeq(startSeq + 1);
       }
-
-      setStartSeq(startSeq + 1);
     }
     return true;
   }
@@ -575,7 +595,7 @@ public class ViewportRanges extends ViewportProperties
     {
       scrollUp(false);
     }
-
+    
     HiddenColumns hidden = al.getHiddenColumns();
     while (x < hidden.adjustForHiddenColumns(startRes))
     {
@@ -594,6 +614,40 @@ public class ViewportRanges extends ViewportProperties
   }
 
   /**
+   * Set the viewport location so that a position is visible
+   * 
+   * @param x
+   *          column to be visible
+   * @param y
+   *          row to be visible
+   */
+  public boolean setViewportLocation(int x, int y)
+  {
+    // if (x,y) is already visible don't do anything
+    boolean changedLocation = false;
+    if (startRes > x || x > endRes || startSeq > y && y > endSeq)
+    {
+      int width = getViewportWidth();
+      int[] oldresvalues = updateStartEndRes(x, x + width - 1);
+
+      int startseq = y;
+      int height = getViewportHeight();
+      if (startseq + height - 1 > getVisibleAlignmentHeight() - 1)
+      {
+        startseq = getVisibleAlignmentHeight() - height;
+      }
+      int[] oldseqvalues = updateStartEndSeq(startseq,
+              startseq + height - 1);
+
+      int[] old = new int[] { oldresvalues[0], oldseqvalues[0] };
+      int[] newresseq = new int[] { startRes, startSeq };
+      changedLocation = true;
+      changeSupport.firePropertyChange(MOVE_VIEWPORT, old, newresseq);
+    }
+    return changedLocation;
+  }
+
+  /**
    * Adjust sequence position for page up. Fires a property change event.
    */
   public void pageUp()