X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fviewmodel%2FViewportRanges.java;h=9f54964e8f7ca4d80c763988a09c151e0ffa35d3;hb=51ca42a8c4525c6871e3c8ea529b6cb8a59bb10f;hp=ebacab173358ef06c8d4127657810780b9232a9c;hpb=bee47de0371990bf2563e77a57cc750634aabd08;p=jalview.git diff --git a/src/jalview/viewmodel/ViewportRanges.java b/src/jalview/viewmodel/ViewportRanges.java index ebacab1..9f54964 100644 --- a/src/jalview/viewmodel/ViewportRanges.java +++ b/src/jalview/viewmodel/ViewportRanges.java @@ -20,18 +20,31 @@ */ package jalview.viewmodel; -import jalview.api.AlignViewportI; import jalview.datamodel.AlignmentI; +import jalview.datamodel.HiddenColumns; /** - * Slightly less embryonic class which: Supplies and updates viewport properties - * relating to position such as: start and end residues and sequences; ideally - * will serve hidden columns/rows too. Intention also to support calculations - * for positioning, scrolling etc. such as finding the middle of the viewport, - * checking for scrolls off screen + * Supplies and updates viewport properties relating to position such as: start + * and end residues and sequences; ideally will serve hidden columns/rows too. + * Intention also to support calculations for positioning, scrolling etc. such + * as finding the middle of the viewport, checking for scrolls off screen */ public class ViewportRanges extends ViewportProperties { + public static final String STARTRES = "startres"; + + public static final String ENDRES = "endres"; + + public static final String STARTSEQ = "startseq"; + + public static final String ENDSEQ = "endseq"; + + public static final String STARTRESANDSEQ = "startresandseq"; + + public static final String MOVE_VIEWPORT = "move_viewport"; + + private boolean wrappedMode = false; + // start residue of viewport private int startRes; @@ -80,7 +93,24 @@ public class ViewportRanges extends ViewportProperties } /** + * Get alignment width in cols, excluding hidden cols + */ + public int getVisibleAlignmentWidth() + { + return al.getVisibleWidth(); + } + + /** + * Get alignment height in rows, excluding hidden rows + */ + public int getVisibleAlignmentHeight() + { + return al.getHeight(); + } + + /** * Set first residue visible in the viewport, and retain the current width. + * Fires a property change event. * * @param res * residue position @@ -103,10 +133,60 @@ public class ViewportRanges extends ViewportProperties */ public void setStartEndRes(int start, int end) { - int oldres = this.startRes; - if (start > al.getWidth() - 1) + int[] oldvalues = updateStartEndRes(start, end); + int oldstartres = oldvalues[0]; + int oldendres = oldvalues[1]; + + if (oldstartres == startRes && oldendres == endRes) + { + return; // BH 2019.07.27 standard check for no changes + } + + // listeners include: + + // jalview.gui.SeqCanvas[,0,0,568x90,layout=java.awt.BorderLayout,alignmentX=0.0,alignmentY=0.0,border=,flags=9,maximumSize=,minimumSize=,preferredSize=] + // STARTRES, STARTRESANDSEQ + // jalview.gui.IdCanvas[,0,0,112x90,layout=java.awt.BorderLayout,alignmentX=0.0,alignmentY=0.0,border=,flags=9,maximumSize=,minimumSize=,preferredSize=java.awt.Dimension[width=112,height=0]] + // jalview.gui.ScalePanel[,0,0,594x17,layout=java.awt.FlowLayout,alignmentX=0.0,alignmentY=0.0,border=,flags=9,maximumSize=,minimumSize=,preferredSize=] + // jalview.gui.AnnotationPanel[,0,0,0x162,alignmentX=0.0,alignmentY=0.0,border=,flags=9,maximumSize=,minimumSize=,preferredSize=java.awt.Dimension[width=1,height=162]] + // jalview.gui.AlignmentPanel[,0,0,706x133,layout=java.awt.BorderLayout,alignmentX=0.0,alignmentY=0.0,border=,flags=16777225,maximumSize=,minimumSize=,preferredSize=java.awt.Dimension[width=220,height=166]] + // jalview.gui.OverviewPanel[,0,0,543x135,layout=java.awt.BorderLayout,alignmentX=0.0,alignmentY=0.0,border=,flags=9,maximumSize=,minimumSize=,preferredSize=java.awt.Dimension[width=543,height=135]] + + + // "STARTRES" is a misnomer here -- really "STARTORENDRES" + // note that this could be "no change" if the range is just being expanded + changeSupport.firePropertyChange(STARTRES, oldstartres, startRes); + if (oldstartres == startRes) { - startRes = al.getWidth() - 1; + // No listener cares about this + // "ENDRES" is a misnomer here -- really "ENDONLYRES" + // BH 2019.07.27 adds end change check + // fire only if only the end is changed + changeSupport.firePropertyChange(ENDRES, oldendres, endRes); + } + } + + /** + * Update start and end residue values, adjusting for width constraints if + * necessary + * + * @param start + * start residue + * @param end + * end residue + * @return array containing old start and end residue values + */ + private int[] updateStartEndRes(int start, int end) + { + int oldstartres = this.startRes; + + /* + * if not wrapped, don't leave white space at the right margin + */ + int lastColumn = getVisibleAlignmentWidth() - 1; + if (!wrappedMode && (start > lastColumn)) + { + startRes = Math.max(lastColumn, 0); } else if (start < 0) { @@ -117,32 +197,26 @@ public class ViewportRanges extends ViewportProperties startRes = start; } + int oldendres = this.endRes; if (end < 0) { endRes = 0; } + else if (!wrappedMode && (end > lastColumn)) + { + endRes = Math.max(lastColumn, 0); + } else { endRes = end; } - - changeSupport.firePropertyChange("startres", oldres, start); + return new int[] { oldstartres, oldendres }; } /** - * Set last residue visible in the viewport - * - * @param res - * residue position - */ - public void setEndRes(int res) - { - int width = getViewportWidth(); - setStartEndRes(res - width + 1, res); - } - - /** - * Set the first sequence visible in the viewport + * Set the first sequence visible in the viewport, maintaining the height. If + * the viewport would extend past the last sequence, sets the viewport so it + * sits at the bottom of the alignment. Fires a property change event. * * @param seq * sequence position @@ -150,13 +224,19 @@ public class ViewportRanges extends ViewportProperties public void setStartSeq(int seq) { int height = getViewportHeight(); - setStartEndSeq(seq, seq + height - 1); + int startseq = Math.max(seq, getVisibleAlignmentHeight() - height); + // BH 2019.07.27 cosmetic only -- was: + // if (startseq + height - 1 > getVisibleAlignmentHeight() - 1) + // { + // startseq = getVisibleAlignmentHeight() - height; + // } + setStartEndSeq(startseq, startseq + height - 1); } /** - * Set start and end sequences at the same time. This method only fires one - * event for the two changes, and should be used in preference to separate - * calls to setStartSeq and setEndSeq. + * Set start and end sequences at the same time. The viewport height may + * change. This method only fires one event for the two changes, and should be + * used in preference to separate calls to setStartSeq and setEndSeq. * * @param start * the start sequence @@ -165,10 +245,45 @@ public class ViewportRanges extends ViewportProperties */ public void setStartEndSeq(int start, int end) { - int oldseq = this.startSeq; - if (start > al.getHeight() - 1) + // System.out.println("ViewportRange setStartEndSeq " + start + " " + end); + int[] oldvalues = updateStartEndSeq(start, end); + int oldstartseq = oldvalues[0]; + int oldendseq = oldvalues[1]; + + if (oldstartseq == startSeq && oldendseq == endSeq) + { + return; // BH 2019.07.27 standard check for no changes + } + + // "STARTSEQ" is a misnomer here -- really "STARTORENDSEQ" + changeSupport.firePropertyChange(STARTSEQ, oldstartseq, startSeq); + if (oldstartseq == startSeq) { - startSeq = al.getHeight() - 1; + // Note that all listeners ignore this - could be removed, or there is a + // bug. + // "ENDSEQ" is a misnomer here -- really "ENDONLYSEQ" + // additional fire, only if only the end is changed + changeSupport.firePropertyChange(ENDSEQ, oldendseq, endSeq); + } + } + + /** + * Update start and end sequence values, adjusting for height constraints if + * necessary + * + * @param start + * start sequence + * @param end + * end sequence + * @return array containing old start and end sequence values + */ + private int[] updateStartEndSeq(int start, int end) + { + int oldstartseq = this.startSeq; + int visibleHeight = getVisibleAlignmentHeight(); + if (start > visibleHeight - 1) + { + startSeq = Math.max(visibleHeight - 1, 0); } else if (start < 0) { @@ -179,9 +294,10 @@ public class ViewportRanges extends ViewportProperties startSeq = start; } - if (end >= al.getHeight()) + int oldendseq = this.endSeq; + if (end >= visibleHeight) { - endSeq = al.getHeight() - 1; + endSeq = Math.max(visibleHeight - 1, 0); } else if (end < 0) { @@ -191,20 +307,49 @@ public class ViewportRanges extends ViewportProperties { endSeq = end; } - - changeSupport.firePropertyChange("startseq", oldseq, start); + return new int[] { oldstartseq, oldendseq }; } /** - * Set the last sequence visible in the viewport + * Set the last sequence visible in the viewport. Fires a property change + * event. * * @param seq - * sequence position + * sequence position in the range [0, height) */ public void setEndSeq(int seq) { + // BH 2018.04.18 added safety for seq < 0; comment about not being >= height + setStartEndSeq(Math.max(0, seq + 1 - getViewportHeight()), seq); + } + + /** + * 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 + * @param seq + * the start sequence + */ + public void setStartResAndSeq(int res, int seq) + { + // from Overview only + int width = getViewportWidth(); + int[] oldresvalues = updateStartEndRes(res, res + width - 1); + + int startseq = seq; int height = getViewportHeight(); - setStartEndSeq(seq - height + 1, seq); + if (startseq + height - 1 > getVisibleAlignmentHeight() - 1) + { + startseq = getVisibleAlignmentHeight() - height; + } + int[] oldseqvalues = updateStartEndSeq(startseq, startseq + height - 1); + + int[] oldvalues = new int[] { oldresvalues[0], oldseqvalues[0] }; + int[] newvalues = new int[] { startRes, startSeq }; + changeSupport.firePropertyChange(STARTRESANDSEQ, oldvalues, newvalues); } /** @@ -242,7 +387,7 @@ public class ViewportRanges extends ViewportProperties /** * Set viewport width in residues, without changing startRes. Use in * preference to calculating endRes from the width, to avoid out by one - * errors! + * errors! Fires a property change event. * * @param w * width in residues @@ -255,7 +400,7 @@ public class ViewportRanges extends ViewportProperties /** * Set viewport height in residues, without changing startSeq. Use in * preference to calculating endSeq from the height, to avoid out by one - * errors! + * errors! Fires a property change event. * * @param h * height in sequences @@ -267,7 +412,8 @@ public class ViewportRanges extends ViewportProperties /** * Set viewport horizontal start position and width. Use in preference to - * calculating endRes from the width, to avoid out by one errors! + * calculating endRes from the width, to avoid out by one errors! Fires a + * property change event. * * @param start * start residue @@ -276,12 +422,31 @@ public class ViewportRanges extends ViewportProperties */ public void setViewportStartAndWidth(int start, int w) { - setStartEndRes(start, start + w - 1); + int vpstart = start; + if (vpstart < 0) + { + vpstart = 0; + } + + /* + * if not wrapped, don't leave white space at the right margin + */ + if (!wrappedMode) + { + if ((w <= getVisibleAlignmentWidth()) + && (vpstart + w - 1 > getVisibleAlignmentWidth() - 1)) + { + vpstart = getVisibleAlignmentWidth() - w; + } + + } + setStartEndRes(vpstart, vpstart + w - 1); } /** * Set viewport vertical start position and height. Use in preference to - * calculating endSeq from the height, to avoid out by one errors! + * calculating endSeq from the height, to avoid out by one errors! Fires a + * property change event. * * @param start * start sequence @@ -290,7 +455,23 @@ public class ViewportRanges extends ViewportProperties */ public void setViewportStartAndHeight(int start, int h) { - setStartEndSeq(start, start + h - 1); + int vpstart = start; + + int visHeight = getVisibleAlignmentHeight(); + if (vpstart < 0) + { + vpstart = 0; + } + else if (h <= visHeight && vpstart + h > visHeight) + // viewport height is less than the full alignment and we are running off + // the bottom + { + vpstart = visHeight - h; + } + // System.out.println("ViewportRanges setviewportStartAndHeight " + vpstart + // + " " + start + " " + h + " " + getVisibleAlignmentHeight()); + + setStartEndSeq(vpstart, vpstart + h - 1); } /** @@ -314,7 +495,7 @@ public class ViewportRanges extends ViewportProperties } /** - * Scroll the viewport range vertically + * Scroll the viewport range vertically. Fires a property change event. * * @param up * true if scrolling up, false if down @@ -323,29 +504,45 @@ 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 >= al.getHeight() - 1) + if (wrappedMode) { - return false; + pageDown(); + } + else + { + if (endSeq >= getVisibleAlignmentHeight() - 1) + { + return false; + } + setStartSeq(startSeq + 1); } - - setStartSeq(startSeq + 1); } return true; } /** - * Scroll the viewport range horizontally + * Scroll the viewport range horizontally. Fires a property change event. * * @param right * true if scrolling right, false if left @@ -365,7 +562,7 @@ public class ViewportRanges extends ViewportProperties } else { - if (endRes > al.getWidth() - 1) + if (endRes >= getVisibleAlignmentWidth() - 1) { return false; } @@ -377,31 +574,65 @@ public class ViewportRanges extends ViewportProperties } /** - * Scroll a wrapped alignment so that the specified residue is visible + * Scroll a wrapped alignment so that the specified residue is in the first + * repeat of the wrapped view. Fires a property change event. Answers true if + * the startRes changed, else false. * * @param res - * residue position to scroll to + * residue position to scroll to NB visible position not absolute + * alignment position + * @return */ - public void scrollToWrappedVisible(int res) + public boolean scrollToWrappedVisible(int res) { - // get the start residue of the wrapped row which res is in - // and set that as our start residue + int newStartRes = calcWrappedStartResidue(res); + if (newStartRes == startRes) + { + return false; + } + setStartRes(newStartRes); + + return true; + } + + /** + * Calculate wrapped start residue from visible start residue + * + * @param res + * visible start residue + * @return left column of panel res will be located in + */ + private int calcWrappedStartResidue(int res) + { + int oldStartRes = startRes; int width = getViewportWidth(); - setStartRes((res / width) * width); + + boolean up = res < oldStartRes; + int widthsToScroll = Math.abs((res - oldStartRes) / width); + if (up) + { + widthsToScroll++; + } + + int residuesToScroll = width * widthsToScroll; + int newStartRes = up ? oldStartRes - residuesToScroll : oldStartRes + + residuesToScroll; + if (newStartRes < 0) + { + newStartRes = 0; + } + return newStartRes; } /** - * Scroll so that (x,y) is visible + * Scroll so that (x,y) is visible. Fires a property change event. * * @param x - * x position in alignment + * x position in alignment (absolute position) * @param y - * y position in alignment - * @param av - * viewport to be visible in. Here until hidden columns JAL-2388 - * merged, then use alignment to get hidden cols + * y position in alignment (absolute position) */ - public void scrollToVisible(int x, int y, AlignViewportI av) + public void scrollToVisible(int x, int y) { while (y < startSeq) { @@ -411,15 +642,16 @@ public class ViewportRanges extends ViewportProperties { scrollUp(false); } - - while (x < av.getColumnSelection().adjustForHiddenColumns(startRes)) + + HiddenColumns hidden = al.getHiddenColumns(); + while (x < hidden.visibleToAbsoluteColumn(startRes)) { if (!scrollRight(false)) { break; } } - while (x > av.getColumnSelection().adjustForHiddenColumns(endRes)) + while (x > hidden.visibleToAbsoluteColumn(endRes)) { if (!scrollRight(true)) { @@ -428,4 +660,174 @@ public class ViewportRanges extends ViewportProperties } } + /** + * Set the viewport location so that a position is visible. From + * SeqPanel.scrollToVisible(true) only, from AlignFrame keyboard actions + * SeqPanel.scrollCursor[Row(VK_S)/Column(VK_C)/RowAndColumn(VK_ENTER,COMMA)/Position(VK_P)] + * + * + * @param x + * column to be visible: absolute position in alignment + * @param y + * row to be visible: absolute position in alignment + */ + public boolean setViewportLocation(int x, int y) + { + boolean changedLocation = false; + + // convert the x,y location to visible coordinates + int visX = al.getHiddenColumns().absoluteToVisibleColumn(x); + int visY = al.getHiddenSequences().findIndexWithoutHiddenSeqs(y); + + // if (vis_x,vis_y) is already visible don't do anything + if (startRes > visX || visX > endRes + || startSeq > visY && visY > endSeq) + { + int[] old = new int[] { startRes, startSeq }; + int[] newresseq; + if (wrappedMode) + { + int newstartres = calcWrappedStartResidue(visX); + setStartRes(newstartres); + newresseq = new int[] { startRes, startSeq }; + } + else + { + // set the viewport x location to contain vis_x + int newstartres = visX; + int width = getViewportWidth(); + if (newstartres + width - 1 > getVisibleAlignmentWidth() - 1) + { + newstartres = getVisibleAlignmentWidth() - width; + } + updateStartEndRes(newstartres, newstartres + width - 1); + + // set the viewport y location to contain vis_y + int newstartseq = visY; + int height = getViewportHeight(); + if (newstartseq + height - 1 > getVisibleAlignmentHeight() - 1) + { + newstartseq = getVisibleAlignmentHeight() - height; + } + updateStartEndSeq(newstartseq, newstartseq + height - 1); + + 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() + { + if (wrappedMode) + { + setStartRes(Math.max(0, getStartRes() - getViewportWidth())); + } + else + { + setViewportStartAndHeight(startSeq - (endSeq - startSeq), + getViewportHeight()); + } + } + + /** + * Adjust sequence position for page down. Fires a property change event. + */ + public void pageDown() + { + if (wrappedMode) + { + /* + * if height is more than width (i.e. not all sequences fit on screen), + * increase page down to height + */ + int newStart = getStartRes() + + Math.max(getViewportHeight(), getViewportWidth()); + + /* + * don't page down beyond end of alignment, or if not all + * sequences fit in the visible height + */ + if (newStart < getVisibleAlignmentWidth()) + { + setStartRes(newStart); + } + } + else + { + setViewportStartAndHeight(endSeq, getViewportHeight()); + } + } + + public void setWrappedMode(boolean wrapped) + { + wrappedMode = wrapped; + } + + public boolean isWrappedMode() + { + return wrappedMode; + } + + /** + * Answers the vertical scroll position (0..) to set, given the visible column + * that is at top left. + * + * 
+   * Example:
+   *    viewport width 40 columns (0-39, 40-79, 80-119...)
+   *    column 0 returns scroll position 0
+   *    columns 1-40 return scroll position 1
+   *    columns 41-80 return scroll position 2
+   *    etc
+   *
+ * + * @param topLeftColumn + * (0..) + * @return + */ + public int getWrappedScrollPosition(final int topLeftColumn) + { + int w = getViewportWidth(); + + /* + * visible whole widths + */ + int scroll = topLeftColumn / w; + + /* + * add 1 for a part width if there is one + */ + scroll += topLeftColumn % w > 0 ? 1 : 0; + + return scroll; + } + + /** + * Answers the maximum wrapped vertical scroll value, given the column + * position (0..) to show at top left of the visible region. + * + * @param topLeftColumn + * @return + */ + public int getWrappedMaxScroll(int topLeftColumn) + { + int scrollPosition = getWrappedScrollPosition(topLeftColumn); + + /* + * how many more widths could be drawn after this one? + */ + int columnsRemaining = getVisibleAlignmentWidth() - topLeftColumn; + int width = getViewportWidth(); + int widthsRemaining = columnsRemaining / width + + (columnsRemaining % width > 0 ? 1 : 0) - 1; + int maxScroll = scrollPosition + widthsRemaining; + + return maxScroll; + } }