package jalview.viewmodel;
import jalview.datamodel.AlignmentI;
+import jalview.datamodel.HiddenColumns;
/**
- * 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,
+ * 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
*/
public class ViewportRanges extends ViewportProperties
}
/**
+ * Get alignment width in cols, excluding hidden cols
+ */
+ public int getVisibleAlignmentWidth()
+ {
+ return al.getWidth() - al.getHiddenColumns().getSize();
+ }
+
+ /**
+ * 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
setStartEndRes(res, res + width - 1);
}
- public void setStartEndRes(int startres, int endres)
+ /**
+ * Set start and end residues at the same time. This method only fires one
+ * event for the two changes, and should be used in preference to separate
+ * calls to setStartRes and setEndRes.
+ *
+ * @param start
+ * the start residue
+ * @param end
+ * the end residue
+ */
+ public void setStartEndRes(int start, int end)
{
- int oldres = this.startRes;
- if (startres > al.getWidth() - 1)
+ int oldstartres = this.startRes;
+ if (start > getVisibleAlignmentWidth() - 1)
{
- startres = al.getWidth() - 1;
+ startRes = Math.max(getVisibleAlignmentWidth() - 1, 0);
}
- else if (startres < 0)
+ else if (start < 0)
{
- startres = 0;
+ startRes = 0;
+ }
+ else
+ {
+ startRes = start;
}
- this.startRes = startres;
- if (endres < 0)
+ int oldendres = this.endRes;
+ if (end < 0)
+ {
+ endRes = 0;
+ }
+ else if (end > getVisibleAlignmentWidth() - 1)
+ {
+ endRes = Math.max(getVisibleAlignmentWidth() - 1, 0);
+ }
+ else
{
- endres = 0;
+ endRes = end;
}
- this.endRes = endres;
- changeSupport.firePropertyChange("startres", oldres, startres);
+ changeSupport.firePropertyChange("startres", oldstartres, startRes);
+ if (oldstartres == startRes)
+ {
+ // event won't be fired if start positions are same
+ // fire an event for the end positions in case they changed
+ changeSupport.firePropertyChange("endres", oldendres, endRes);
+ }
}
/**
- * Set last residue visible in the viewport
+ * Set last residue visible in the viewport. Fires a property change event.
*
* @param res
* residue position
*/
public void setEndRes(int res)
{
+ int startres = res;
int width = getViewportWidth();
- setStartEndRes(res - width + 1, res);
+ if (startres + width - 1 > getVisibleAlignmentWidth() - 1)
+ {
+ startres = getVisibleAlignmentWidth() - width;
+ }
+ setStartEndRes(startres - width + 1, startres);
}
/**
- * 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
*/
public void setStartSeq(int seq)
{
+ int startseq = seq;
int height = getViewportHeight();
- setStartEndSeq(seq, seq + height - 1);
+ if (startseq + height - 1 > getVisibleAlignmentHeight() - 1)
+ {
+ startseq = getVisibleAlignmentHeight() - height;
+ }
+ setStartEndSeq(startseq, startseq + height - 1);
}
- public void setStartEndSeq(int startseq, int endseq)
+ /**
+ * 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
+ * @param end
+ * the end sequence
+ */
+ public void setStartEndSeq(int start, int end)
{
- int oldseq = this.startSeq;
- if (startseq > al.getHeight() - 1)
+ int oldstartseq = this.startSeq;
+ if (start > getVisibleAlignmentHeight() - 1)
{
- startseq = al.getHeight() - 1;
+ startSeq = Math.max(getVisibleAlignmentHeight() - 1, 0);
}
- else if (startseq < 0)
+ else if (start < 0)
{
- startseq = 0;
+ startSeq = 0;
+ }
+ else
+ {
+ startSeq = start;
}
- this.startSeq = startseq;
- if (endseq >= al.getHeight())
+ int oldendseq = this.endSeq;
+ if (end >= getVisibleAlignmentHeight())
{
- endseq = al.getHeight() - 1;
+ endSeq = Math.max(getVisibleAlignmentHeight() - 1, 0);
}
- else if (endseq < 0)
+ else if (end < 0)
{
- endseq = 0;
+ endSeq = 0;
+ }
+ else
+ {
+ endSeq = end;
+ }
+
+ changeSupport.firePropertyChange("startseq", oldstartseq, startSeq);
+ if (oldstartseq == startSeq)
+ {
+ // event won't be fired if start positions are the same
+ // fire in case the end positions changed
+ changeSupport.firePropertyChange("endseq", oldendseq, endSeq);
}
- this.endSeq = endseq;
- changeSupport.firePropertyChange("startseq", oldseq, startseq);
}
/**
- * 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
}
/**
+ * Set viewport width in residues, without changing startRes. Use in
+ * preference to calculating endRes from the width, to avoid out by one
+ * errors! Fires a property change event.
+ *
+ * @param w
+ * width in residues
+ */
+ public void setViewportWidth(int w)
+ {
+ setStartEndRes(startRes, startRes + w - 1);
+ }
+
+ /**
+ * Set viewport height in residues, without changing startSeq. Use in
+ * preference to calculating endSeq from the height, to avoid out by one
+ * errors! Fires a property change event.
+ *
+ * @param h
+ * height in sequences
+ */
+ public void setViewportHeight(int h)
+ {
+ setStartEndSeq(startSeq, startSeq + h - 1);
+ }
+
+ /**
+ * Set viewport horizontal start position and width. Use in preference to
+ * calculating endRes from the width, to avoid out by one errors! Fires a
+ * property change event.
+ *
+ * @param start
+ * start residue
+ * @param w
+ * width in residues
+ */
+ public void setViewportStartAndWidth(int start, int w)
+ {
+ int vpstart = start;
+ if (vpstart < 0)
+ {
+ vpstart = 0;
+ }
+ else if ((w <= getVisibleAlignmentWidth())
+ && (vpstart + w - 1 > getVisibleAlignmentWidth() - 1))
+ // viewport width is less than the full alignment and we are running off the
+ // RHS edge
+ {
+ 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! Fires a
+ * property change event.
+ *
+ * @param start
+ * start sequence
+ * @param h
+ * height in sequences
+ */
+ public void setViewportStartAndHeight(int start, int h)
+ {
+ int vpstart = start;
+ if (vpstart < 0)
+ {
+ vpstart = 0;
+ }
+ else if ((h <= getVisibleAlignmentHeight())
+ && (vpstart + h - 1 > getVisibleAlignmentHeight() - 1))
+ // viewport height is less than the full alignment and we are running off
+ // the bottom
+ {
+ vpstart = getVisibleAlignmentHeight() - h;
+ }
+ setStartEndSeq(vpstart, vpstart + h - 1);
+ }
+
+ /**
* Get width of viewport in residues
*
* @return width of viewport
*/
public int getViewportWidth()
{
- return (endRes - startRes + 1); // TODO get for wrapped alignments too
+ return (endRes - startRes + 1);
}
/**
return (endSeq - startSeq + 1);
}
- // return value is true if the scroll is valid
+ /**
+ * Scroll the viewport range vertically. Fires a property change event.
+ *
+ * @param up
+ * true if scrolling up, false if down
+ *
+ * @return true if the scroll is valid
+ */
public boolean scrollUp(boolean up)
{
if (up)
}
else
{
- if (endSeq >= al.getHeight() - 1)
+ if (endSeq >= getVisibleAlignmentHeight() - 1)
{
return false;
}
}
/**
- * DOCUMENT ME!
+ * Scroll the viewport range horizontally. Fires a property change event.
*
* @param right
- * DOCUMENT ME!
+ * true if scrolling right, false if left
*
- * @return DOCUMENT ME!
+ * @return true if the scroll is valid
*/
public boolean scrollRight(boolean right)
{
}
else
{
- if (endRes > al.getWidth() - 1)
+ if (endRes >= getVisibleAlignmentWidth() - 1)
{
return false;
}
return true;
}
+ /**
+ * Scroll a wrapped alignment so that the specified residue is visible. Fires
+ * a property change event.
+ *
+ * @param res
+ * residue position to scroll to
+ */
public void scrollToWrappedVisible(int res)
{
- setStartRes(res);
+ // get the start residue of the wrapped row which res is in
+ // and set that as our start residue
+ int width = getViewportWidth();
+ setStartRes((res / width) * width);
}
+ /**
+ * Scroll so that (x,y) is visible. Fires a property change event.
+ *
+ * @param x
+ * x position in alignment
+ * @param y
+ * y position in alignment
+ */
+ public void scrollToVisible(int x, int y)
+ {
+ while (y < startSeq)
+ {
+ scrollUp(true);
+ }
+ while (y > endSeq)
+ {
+ scrollUp(false);
+ }
+
+ HiddenColumns hidden = al.getHiddenColumns();
+ while (x < hidden.adjustForHiddenColumns(startRes))
+ {
+ if (!scrollRight(false))
+ {
+ break;
+ }
+ }
+ while (x > hidden.adjustForHiddenColumns(endRes))
+ {
+ if (!scrollRight(true))
+ {
+ break;
+ }
+ }
+ }
+
+ /**
+ * Adjust sequence position for page up. Fires a property change event.
+ */
+ public void pageUp()
+ {
+ setViewportStartAndHeight(2 * startSeq - endSeq, getViewportHeight());
+ }
+
+ /**
+ * Adjust sequence position for page down. Fires a property change event.
+ */
+ public void pageDown()
+ {
+ setViewportStartAndHeight(endSeq, getViewportHeight());
+ }
}
git://source.jalview.org / jalview.git / blobdiff