JAL-2738 copy to spikes/mungo
[jalview.git] / test / jalview / viewmodel / OverviewDimensionsShowHiddenTest.java
index 1bc3bfa..842a0fd 100644 (file)
@@ -21,6 +21,8 @@
 package jalview.viewmodel;
 
 import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertTrue;
 
 import jalview.analysis.AlignmentGenerator;
 import jalview.datamodel.Alignment;
@@ -55,7 +57,7 @@ public class OverviewDimensionsShowHiddenTest
 
   ViewportRanges vpranges;
 
-  Hashtable<SequenceI, SequenceCollectionI> hiddenRepSequences = new Hashtable<SequenceI, SequenceCollectionI>();
+  Hashtable<SequenceI, SequenceCollectionI> hiddenRepSequences = new Hashtable<>();
 
   HiddenColumns hiddenCols = new HiddenColumns();
 
@@ -209,7 +211,7 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxX(), 0);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
-    assertEquals(vpranges.getStartSeq(),
+    assertEquals(vpranges.getStartSeq() + vpranges.getViewportHeight() / 2,
             Math.round((float) 10 * alheight / od.getSequencesHeight()));
     assertEquals(vpranges.getStartRes(), 0);
 
@@ -218,14 +220,13 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxY(), 0);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
-    assertEquals(vpranges.getStartRes(),
-            Math.round((float) 6 * alwidth / od.getWidth()));
+    assertEquals(vpranges.getStartRes(), 0);
     assertEquals(vpranges.getStartSeq(), 0);
 
     // overly large boxX value reset to width-boxWidth
-    mouseClick(od, 100, 6);
+    mouseClick(od, 101, 6);
     assertEquals(od.getBoxX(), od.getWidth() - od.getBoxWidth());
-    assertEquals(od.getBoxY(), 6);
+    assertEquals(od.getBoxY(), 1);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartRes(),
@@ -237,11 +238,11 @@ public class OverviewDimensionsShowHiddenTest
 
     // overly large boxY value reset to sequenceHeight - boxHeight
     mouseClick(od, 10, 520);
-    assertEquals(od.getBoxX(), 10);
+    assertEquals(od.getBoxX(), 0);
     assertEquals(od.getBoxY(), od.getSequencesHeight() - od.getBoxHeight());
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
-    assertEquals(vpranges.getStartRes(),
+    assertEquals(0,
             Math.round((float) od.getBoxX() * alwidth / od.getWidth()));
 
     // here (float) od.getBoxY() * alheight / od.getSequencesHeight() = 507.5
@@ -265,18 +266,19 @@ public class OverviewDimensionsShowHiddenTest
                     / od.getSequencesHeight()));
 
     // move viewport so startRes non-zero and then mouseclick
-    moveViewportH(50);
+    moveViewportH(20);
 
     // click at viewport position
     int oldboxx = od.getBoxX();
     int oldboxy = od.getBoxY();
-    mouseClick(od, od.getBoxX() + 5, od.getBoxY() + 2);
-    assertEquals(od.getBoxX(), oldboxx + 5);
+    mouseClick(od, od.getBoxX() + od.getBoxWidth() / 2 + 6,
+            od.getBoxY() + od.getBoxHeight() / 2 + 3);
+    assertEquals(od.getBoxX(), oldboxx + 6);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartRes(),
             Math.round((float) od.getBoxX() * alwidth / od.getWidth()));
-    assertEquals(od.getBoxY(), oldboxy + 2);
+    assertEquals(od.getBoxY(), oldboxy + 3);
     assertEquals(
             vpranges.getStartSeq(),
             Math.round((float) od.getBoxY() * alheight
@@ -332,10 +334,15 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(vpranges.getStartRes(), 0);
 
     // click to right of hidden columns, box moves to click point
-    testBoxIsAtClickPoint(40, 0);
+    mouseClick(od, 60 + boxWidth / 2, boxHeight / 2);
+    assertEquals(od.getBoxX(), 60);
+    assertEquals(od.getBoxY(), 0);
+    assertEquals(od.getBoxWidth(), boxWidth);
+    assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartSeq(), 0);
     assertEquals(vpranges.getStartRes(),
-            Math.round((float) 40 * alwidth / od.getWidth())
+            Math.round(
+                    (float) 60 * alwidth / od.getWidth())
                     - (lastHiddenCol + 1));
 
     // click to right of hidden columns such that box runs over right hand side
@@ -343,7 +350,7 @@ public class OverviewDimensionsShowHiddenTest
     // box position is adjusted away from the edge
     // overly large boxX value reset to width-boxWidth
     xpos = 100;
-    mouseClick(od, xpos, 5);
+    mouseClick(od, xpos + boxWidth / 2, 5 + boxHeight / 2);
     assertEquals(od.getBoxX(), od.getWidth() - od.getBoxWidth());
     assertEquals(od.getBoxY(), 5);
     assertEquals(od.getBoxWidth(), boxWidth);
@@ -385,10 +392,10 @@ public class OverviewDimensionsShowHiddenTest
 
     // move box so that it overlaps with hidden cols on one side
     // box width changes, boxX and scrollCol as for unhidden case
-    int xpos = 55 - boxWidth; // 55 is position in overview approx halfway
+    int xpos = 54 - boxWidth / 2; // 54 is position in overview approx halfway
                               // between cols 60 and 70
-    mouseClick(od, xpos, 0);
-    assertEquals(od.getBoxX(), xpos);
+    mouseClick(od, xpos, boxHeight / 2);
+    assertEquals(od.getBoxX(), xpos - boxWidth / 2);
     assertEquals(od.getBoxY(), 0);
     assertEquals(
             od.getBoxWidth(),
@@ -396,14 +403,15 @@ public class OverviewDimensionsShowHiddenTest
                     * od.getWidth() / alwidth));
     assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartRes(),
-            Math.round(xpos * alwidth / od.getWidth()));
+            Math.round((xpos - boxWidth / 2) * alwidth / od.getWidth())
+                    + 1); // +1 for rounding
     assertEquals(vpranges.getStartSeq(), 0);
 
     // move box so that it completely covers hidden cols
     // box width changes, boxX and scrollCol as for hidden case
-    xpos = 33;
+    xpos = 24 + boxWidth / 2;
     mouseClick(od, xpos, 0);
-    assertEquals(od.getBoxX(), xpos);
+    assertEquals(od.getBoxX(), 24);
     assertEquals(od.getBoxY(), 0);
     assertEquals(
             od.getBoxWidth(),
@@ -411,42 +419,28 @@ public class OverviewDimensionsShowHiddenTest
                     * od.getWidth() / alwidth));
     assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartRes(),
-            Math.round((float) xpos * alwidth / od.getWidth()));
-    assertEquals(vpranges.getStartSeq(), 0);
-
-    // move box so boxX is in hidden cols, box overhangs at right
-    // boxX and scrollCol at left of hidden area, box width extends across
-    // hidden region
-    xpos = 50;
-    mouseClick(od, xpos, 0);
-    assertEquals(od.getBoxX(),
-            Math.round((float) (firstHidden - 1) * od.getWidth() / alwidth));
-    assertEquals(od.getBoxY(), 0);
-    assertEquals(
-            od.getBoxWidth(),
-            boxWidth
-                    + Math.round((float) (lastHidden - firstHidden + 1)
-                            * od.getWidth() / alwidth));
-    assertEquals(od.getBoxHeight(), boxHeight);
-    assertEquals(vpranges.getStartRes(), firstHidden - 1);
+            Math.round((float) 24 * alwidth / od.getWidth()));
     assertEquals(vpranges.getStartSeq(), 0);
 
     // move box so boxX is to right of hidden cols, but does not go beyond full
     // width of alignment
     // box width, boxX and scrollCol all as for non-hidden case
-    xpos = 75;
-    testBoxIsAtClickPoint(xpos, 0);
+    xpos = Math.round((float) 75 * od.getWidth() / alwidth) + boxWidth / 2;
+    mouseClick(od, xpos, boxHeight / 2);
+    assertEquals(od.getBoxX(), xpos - boxWidth / 2);
+    assertEquals(od.getBoxY(), 0);
+    assertEquals(od.getBoxWidth(), boxWidth);
+    assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartSeq(), 0);
     assertEquals(vpranges.getStartRes(),
-            Math.round(xpos * alwidth / od.getWidth())
-                    - (lastHidden - firstHidden + 1));
+            75 - (lastHidden - firstHidden + 1));
     
     // move box so it goes beyond full width of alignment
     // boxX, scrollCol adjusted back, box width normal
     xpos = 3000;
     mouseClick(od, xpos, 5);
     assertEquals(od.getBoxX(), od.getWidth() - od.getBoxWidth());
-    assertEquals(od.getBoxY(), 5);
+    assertEquals(od.getBoxY(), 0);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(
@@ -487,24 +481,29 @@ public class OverviewDimensionsShowHiddenTest
 
     // click to left of hidden cols, without overlapping
     // boxX, scrollCol and width as normal
-    int xpos = 5;
-    testBoxIsAtClickPoint(xpos, 0);
-    assertEquals(vpranges.getStartSeq(), 0);
-    assertEquals(vpranges.getStartRes(),
-            Math.round((float) xpos * alwidth / od.getWidth()));
+    int xpos = 30;
+    int ypos = 6;
+    testBoxIsAtClickPoint(xpos, ypos);
+    assertEquals(vpranges.getStartSeq(), Math
+            .round((float) (ypos - boxHeight / 2) * alheight
+                    / od.getHeight()));
+    assertEquals(vpranges.getStartRes(), Math.round(
+            (float) (xpos - boxWidth / 2) * alwidth / od.getWidth()));
 
     // click to left of hidden cols, with overlap
     // boxX and scrollCol adjusted for hidden cols, width normal
     xpos = Math.round((float) 145 * od.getWidth() / alwidth) - boxWidth;
-    mouseClick(od, xpos, 0);
+    mouseClick(od, xpos + boxWidth / 2, boxHeight / 2);
     assertEquals(od.getBoxX(),
-            Math.round((float) (firstHidden - 1) * od.getWidth() / alwidth)
+            Math.round((float) (firstHidden - 1)
+                    * od.getWidth() / alwidth)
                     - boxWidth + 1);
     assertEquals(od.getBoxY(), 0);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
     assertEquals(vpranges.getStartRes(),
-            Math.round((float) od.getBoxX() * alwidth / od.getWidth()));
+            Math.round((float) (od.getBoxX()) * alwidth
+                    / od.getWidth()));
     assertEquals(vpranges.getStartSeq(), 0);
 
     // click in hidden cols
@@ -823,7 +822,7 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxHeight(), boxHeight);
 
     // click below hidden rows
-    mouseClick(od, 0, 150);
+    mouseClick(od, 0, 150 + boxHeight/2);
     assertEquals(od.getBoxX(), 0);
     assertEquals(od.getBoxY(), 150);
     assertEquals(od.getBoxWidth(), boxWidth);
@@ -860,26 +859,15 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxHeight(), boxHeight);
 
     // click above hidden rows, so that box overlaps
-    int ypos = 35; // column value in residues
+    int rowpos = 35; // row value in residues
+    int centrepos = 43; // centre row
     mouseClick(od, 0,
-            Math.round((float) ypos * od.getSequencesHeight() / alheight));
-    assertEquals(od.getBoxX(), 0);
-    assertEquals(od.getBoxY(),
-            Math.round((float) ypos * od.getSequencesHeight() / alheight));
-    assertEquals(od.getBoxWidth(), boxWidth);
-    assertEquals(
-            od.getBoxHeight(),
-            boxHeight
-                    + Math.round((float) (lastHiddenRow - firstHiddenRow + 1)
-                            * od.getSequencesHeight() / alheight));
-
-    // click so that box straddles hidden rows
-    ypos = 44; // column value in residues
-    mouseClick(od, 0,
-            Math.round((float) ypos * od.getSequencesHeight() / alheight));
+            Math.round((float) centrepos * od.getSequencesHeight()
+                    / alheight));
     assertEquals(od.getBoxX(), 0);
     assertEquals(od.getBoxY(),
-            Math.round((float) ypos * od.getSequencesHeight() / alheight));
+            Math.round(
+                    (float) rowpos * od.getSequencesHeight() / alheight));
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(
             od.getBoxHeight(),
@@ -915,19 +903,19 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
 
-    // click above hidden rows
-    int ypos = 40; // row 40
+    // click above hidden rows, no overlap
+    int ypos = 40 + viewHeight / 2; // top is row 40
     mouseClick(od, 0,
             Math.round((float) ypos * od.getSequencesHeight() / alheight));
     assertEquals(od.getBoxX(), 0);
     assertEquals(od.getBoxY(),
-            Math.round((float) ypos * od.getSequencesHeight() / alheight));
+            Math.round((float) 40 * od.getSequencesHeight() / alheight));
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
 
     // click above hidden rows so box overlaps
     // boxY moved upwards, boxHeight remains same
-    ypos = 497; // row 497
+    ypos = 497 + viewHeight / 2; // row 497
     mouseClick(od, 0,
             Math.round((float) ypos * od.getSequencesHeight() / alheight));
     assertEquals(od.getBoxX(), 0);
@@ -939,7 +927,7 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxHeight(), boxHeight);
 
     // click within hidden rows
-    ypos = 505;
+    ypos = 505 + boxHeight / 2;
     mouseClick(od, 0,
             Math.round((float) ypos * od.getSequencesHeight() / alheight));
     assertEquals(od.getBoxX(), 0);
@@ -951,6 +939,105 @@ public class OverviewDimensionsShowHiddenTest
     assertEquals(od.getBoxHeight(), boxHeight);
   }
 
+  /**
+   * Test the function to determine if a point is in the overview's box or not
+   */
+  @Test(groups = { "Functional" })
+  public void testPositionInBox()
+  {
+    od.updateViewportFromMouse(0, 0, al.getHiddenSequences(), hiddenCols);
+
+    assertFalse(od.isPositionInBox(0, 0));
+    assertTrue(od.isPositionInBox(10, 9));
+    assertFalse(od.isPositionInBox(0, 9));
+    assertFalse(od.isPositionInBox(9, 0));
+    assertFalse(od.isPositionInBox(75, 20));
+
+    assertTrue(od.isPositionInBox(47, 6));
+    assertFalse(od.isPositionInBox(48, 6));
+    assertTrue(od.isPositionInBox(47, 9));
+    assertFalse(od.isPositionInBox(47, 10));
+
+    // hide columns in the box area
+    // extends area where a point is considered to be in the box
+    hiddenCols.hideColumns(1, 4);
+    od.setBoxPosition(al.getHiddenSequences(), hiddenCols);
+    assertFalse(od.isPositionInBox(0, 0));
+    assertTrue(od.isPositionInBox(10, 9));
+    assertFalse(od.isPositionInBox(0, 9));
+    assertFalse(od.isPositionInBox(9, 0));
+    assertFalse(od.isPositionInBox(75, 20));
+
+    assertTrue(od.isPositionInBox(47, 6));
+    assertTrue(od.isPositionInBox(48, 6));
+    assertTrue(od.isPositionInBox(47, 9));
+    assertFalse(od.isPositionInBox(47, 10));
+
+    // hide sequences in box area
+    // extends area where a point is considered to be in the box
+    hideSequences(1, 3);
+    ColumnSelection cs = new ColumnSelection();
+    hiddenCols.revealAllHiddenColumns(cs);
+    od.setBoxPosition(al.getHiddenSequences(), hiddenCols);
+    assertFalse(od.isPositionInBox(0, 0));
+    assertTrue(od.isPositionInBox(10, 9));
+    assertFalse(od.isPositionInBox(0, 9));
+    assertFalse(od.isPositionInBox(9, 0));
+    assertFalse(od.isPositionInBox(75, 20));
+
+    assertTrue(od.isPositionInBox(47, 6));
+    assertFalse(od.isPositionInBox(48, 6));
+    assertTrue(od.isPositionInBox(47, 9));
+    assertTrue(od.isPositionInBox(47, 10));
+  }
+
+  /**
+   * Test the dragging functionality
+   */
+  @Test(groups = { "Functional" })
+  public void testDragging()
+  {
+    od.updateViewportFromMouse(0, 0, al.getHiddenSequences(), hiddenCols);
+    od.setDragPoint(4, 16, al.getHiddenSequences(), hiddenCols);
+    od.adjustViewportFromMouse(20, 22, al.getHiddenSequences(), hiddenCols);
+
+    // updates require an OverviewPanel to exist which it doesn't here
+    // so call setBoxPosition() as it would be called by the AlignmentPanel
+    // normally
+    od.setBoxPosition(al.getHiddenSequences(), hiddenCols);
+
+    // corner moves 16 (20-4) right and 6 (22-16) up
+    assertEquals(od.getBoxX(), 16);
+    assertEquals(od.getBoxY(), 6);
+
+    // hide columns - box moves drag distance + hidden cols, vertically makes no
+    // difference
+    hiddenCols.hideColumns(1, 4);
+    od.updateViewportFromMouse(0, 0, al.getHiddenSequences(), hiddenCols);
+    od.setDragPoint(4, 16, al.getHiddenSequences(), hiddenCols);
+    od.adjustViewportFromMouse(20, 22, al.getHiddenSequences(), hiddenCols);
+    od.setBoxPosition(al.getHiddenSequences(), hiddenCols);
+
+    // corner moves 16 (20-4) + hiddenCols right and 6 (22-16) down
+    assertEquals(od.getBoxX(),
+            16 + Math.round((float) 4 * od.getWidth() / alwidth));
+    assertEquals(od.getBoxY(), 6);
+
+    // hide sequences in box area
+    // makes absolutely no difference
+    hideSequences(1, 3);
+    od.updateViewportFromMouse(0, 0, al.getHiddenSequences(), hiddenCols);
+    od.setDragPoint(4, 16, al.getHiddenSequences(), hiddenCols);
+    od.adjustViewportFromMouse(20, 22, al.getHiddenSequences(), hiddenCols);
+    od.setBoxPosition(al.getHiddenSequences(), hiddenCols);
+
+    // corner moves 16 (20-4) + hiddenCols right and 6 (22-16) + hiddenRows down
+    assertEquals(od.getBoxX(),
+            16 + Math.round((float) 4 * od.getWidth() / alwidth));
+    assertEquals(od.getBoxY(),
+            6 + Math.round((float) 3 * od.getHeight() / alheight));
+  }
+
   /*
    * Move viewport horizontally: startRes + previous width gives new horizontal extent. Vertical extent stays the same.
    */
@@ -993,14 +1080,14 @@ public class OverviewDimensionsShowHiddenTest
   }
   
   /*
-   * Test that the box is positioned with the top left corner at xpos, ypos
+   * Test that the box is positioned with the centre at xpos, ypos
    * and with the original width and height
    */
   private void testBoxIsAtClickPoint(int xpos, int ypos)
   {
     mouseClick(od, xpos, ypos);
-    assertEquals(od.getBoxX(), xpos);
-    assertEquals(od.getBoxY(), ypos);
+    assertEquals(od.getBoxX() + od.getBoxWidth() / 2, xpos);
+    assertEquals(od.getBoxY() + od.getBoxHeight() / 2, ypos);
     assertEquals(od.getBoxWidth(), boxWidth);
     assertEquals(od.getBoxHeight(), boxHeight);
 
@@ -1022,4 +1109,53 @@ public class OverviewDimensionsShowHiddenTest
 
     hiddenRepSequences.put(allseqs[start], theseSeqs);
   }
+
+  /**
+   * Test setting of the box position, when there are hidden rows at the start
+   * of the alignment
+   */
+  @Test(groups = { "Functional" })
+  public void testFromMouseWithHiddenRowsAtStartWrapped()
+  {
+    vpranges.setWrappedMode(true);
+    od.updateViewportFromMouse(0, 0, al.getHiddenSequences(), hiddenCols);
+    assertEquals(od.getBoxX(), 0);
+    assertEquals(od.getBoxY(), 0);
+    assertEquals(od.getBoxHeight(), boxHeight);
+    assertEquals(od.getBoxWidth(), boxWidth);
+    assertEquals(vpranges.getStartRes(), 0);
+    assertEquals(vpranges.getStartSeq(), 0);
+  
+    // hide rows at start and check updated box position is correct
+    // changes boxY but not boxheight
+    int lastHiddenRow = 30;
+    hideSequences(0, lastHiddenRow);
+  
+    od.setBoxPosition(al.getHiddenSequences(), hiddenCols);
+    assertEquals(od.getBoxX(), 0);
+    assertEquals(od.getBoxY(),
+            Math.round((float) (lastHiddenRow + 1)
+                    * od.getSequencesHeight() / alheight));
+    assertEquals(od.getBoxWidth(), boxWidth);
+    assertEquals(od.getBoxHeight(), boxHeight);
+  
+    // click in hidden rows - same result
+    mouseClick(od, 0, 0);
+    assertEquals(od.getBoxX(), 0);
+    int boxY = od.getBoxY();
+    assertEquals(
+            boxY,
+            Math.round((float) (lastHiddenRow + 1)
+                    * od.getSequencesHeight() / alheight));
+    assertEquals(od.getBoxWidth(), boxWidth);
+    assertEquals(od.getBoxHeight(), boxHeight);
+  
+    // click below hidden rows
+    // vertical move of overview box is suppressed in wrapped mode
+    mouseClick(od, 0, 150);
+    assertEquals(od.getBoxX(), 0);
+    assertEquals(od.getBoxY(), boxY); // unchanged
+    assertEquals(od.getBoxWidth(), boxWidth);
+    assertEquals(od.getBoxHeight(), boxHeight);
+  }
 }