2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.viewmodel;
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.HiddenColumns;
27 * Slightly less embryonic class which: Supplies and updates viewport properties
28 * relating to position such as: start and end residues and sequences; ideally
29 * will serve hidden columns/rows too. Intention also to support calculations
30 * for positioning, scrolling etc. such as finding the middle of the viewport,
31 * checking for scrolls off screen
33 public class ViewportRanges extends ViewportProperties
35 public static final String STARTRES = "startres";
37 public static final String ENDRES = "endres";
39 public static final String STARTSEQ = "startseq";
41 public static final String ENDSEQ = "endseq";
43 private boolean wrappedMode = false;
45 // start residue of viewport
48 // end residue of viewport
51 // start sequence of viewport
54 // end sequence of viewport
58 private AlignmentI al;
64 * the viewport's alignment
66 public ViewportRanges(AlignmentI alignment)
68 // initial values of viewport settings
70 this.endRes = alignment.getWidth() - 1;
72 this.endSeq = alignment.getHeight() - 1;
77 * Get alignment width in cols, including hidden cols
79 public int getAbsoluteAlignmentWidth()
85 * Get alignment height in rows, including hidden rows
87 public int getAbsoluteAlignmentHeight()
89 return al.getHeight() + al.getHiddenSequences().getSize();
93 * Get alignment width in cols, excluding hidden cols
95 public int getVisibleAlignmentWidth()
97 return al.getWidth() - al.getHiddenColumns().getSize();
101 * Get alignment height in rows, excluding hidden rows
103 public int getVisibleAlignmentHeight()
105 return al.getHeight();
109 * Set first residue visible in the viewport, and retain the current width.
110 * Fires a property change event.
115 public void setStartRes(int res)
117 int width = getViewportWidth();
118 setStartEndRes(res, res + width - 1);
122 * Set start and end residues at the same time. This method only fires one
123 * event for the two changes, and should be used in preference to separate
124 * calls to setStartRes and setEndRes.
131 public void setStartEndRes(int start, int end)
133 int oldstartres = this.startRes;
136 * if not wrapped, don't leave white space at the right margin
138 if (!wrappedMode && (start > getVisibleAlignmentWidth() - 1))
140 startRes = Math.max(getVisibleAlignmentWidth() - 1, 0);
151 int oldendres = this.endRes;
156 else if (!wrappedMode && (end > getVisibleAlignmentWidth() - 1))
158 endRes = Math.max(getVisibleAlignmentWidth() - 1, 0);
165 changeSupport.firePropertyChange(STARTRES, oldstartres, startRes);
166 if (oldstartres == startRes)
168 // event won't be fired if start positions are same
169 // fire an event for the end positions in case they changed
170 changeSupport.firePropertyChange(ENDRES, oldendres, endRes);
175 * Set last residue visible in the viewport. Fires a property change event.
180 public void setEndRes(int res)
183 int width = getViewportWidth();
186 * if not wrapped, don't leave white space at the right margin
190 if (startres + width - 1 > getVisibleAlignmentWidth() - 1)
192 startres = getVisibleAlignmentWidth() - width;
195 setStartEndRes(startres - width + 1, startres);
199 * Set the first sequence visible in the viewport, maintaining the height. If
200 * the viewport would extend past the last sequence, sets the viewport so it
201 * sits at the bottom of the alignment. Fires a property change event.
206 public void setStartSeq(int seq)
209 int height = getViewportHeight();
210 if (startseq + height - 1 > getVisibleAlignmentHeight() - 1)
212 startseq = getVisibleAlignmentHeight() - height;
214 setStartEndSeq(startseq, startseq + height - 1);
218 * Set start and end sequences at the same time. The viewport height may
219 * change. This method only fires one event for the two changes, and should be
220 * used in preference to separate calls to setStartSeq and setEndSeq.
227 public void setStartEndSeq(int start, int end)
229 int oldstartseq = this.startSeq;
230 int visibleHeight = getVisibleAlignmentHeight();
231 if (start > visibleHeight - 1)
233 startSeq = Math.max(visibleHeight - 1, 0);
244 int oldendseq = this.endSeq;
245 if (end >= visibleHeight)
247 endSeq = Math.max(visibleHeight - 1, 0);
258 changeSupport.firePropertyChange(STARTSEQ, oldstartseq, startSeq);
259 if (oldstartseq == startSeq)
261 // event won't be fired if start positions are the same
262 // fire in case the end positions changed
263 changeSupport.firePropertyChange(ENDSEQ, oldendseq, endSeq);
268 * Set the last sequence visible in the viewport. Fires a property change
274 public void setEndSeq(int seq)
276 int height = getViewportHeight();
277 setStartEndSeq(seq - height + 1, seq);
281 * Get start residue of viewport
283 public int getStartRes()
289 * Get end residue of viewport
291 public int getEndRes()
297 * Get start sequence of viewport
299 public int getStartSeq()
305 * Get end sequence of viewport
307 public int getEndSeq()
313 * Set viewport width in residues, without changing startRes. Use in
314 * preference to calculating endRes from the width, to avoid out by one
315 * errors! Fires a property change event.
320 public void setViewportWidth(int w)
322 setStartEndRes(startRes, startRes + w - 1);
326 * Set viewport height in residues, without changing startSeq. Use in
327 * preference to calculating endSeq from the height, to avoid out by one
328 * errors! Fires a property change event.
331 * height in sequences
333 public void setViewportHeight(int h)
335 setStartEndSeq(startSeq, startSeq + h - 1);
339 * Set viewport horizontal start position and width. Use in preference to
340 * calculating endRes from the width, to avoid out by one errors! Fires a
341 * property change event.
348 public void setViewportStartAndWidth(int start, int w)
357 * if not wrapped, don't leave white space at the right margin
361 if ((w <= getVisibleAlignmentWidth())
362 && (vpstart + w - 1 > getVisibleAlignmentWidth() - 1))
364 vpstart = getVisibleAlignmentWidth() - w;
368 setStartEndRes(vpstart, vpstart + w - 1);
372 * Set viewport vertical start position and height. Use in preference to
373 * calculating endSeq from the height, to avoid out by one errors! Fires a
374 * property change event.
379 * height in sequences
381 public void setViewportStartAndHeight(int start, int h)
388 else if ((h <= getVisibleAlignmentHeight())
389 && (vpstart + h - 1 > getVisibleAlignmentHeight() - 1))
390 // viewport height is less than the full alignment and we are running off
393 vpstart = getVisibleAlignmentHeight() - h;
395 setStartEndSeq(vpstart, vpstart + h - 1);
399 * Get width of viewport in residues
401 * @return width of viewport
403 public int getViewportWidth()
405 return (endRes - startRes + 1);
409 * Get height of viewport in residues
411 * @return height of viewport
413 public int getViewportHeight()
415 return (endSeq - startSeq + 1);
419 * Scroll the viewport range vertically. Fires a property change event.
422 * true if scrolling up, false if down
424 * @return true if the scroll is valid
426 public boolean scrollUp(boolean up)
435 setStartSeq(startSeq - 1);
439 if (endSeq >= getVisibleAlignmentHeight() - 1)
444 setStartSeq(startSeq + 1);
450 * Scroll the viewport range horizontally. Fires a property change event.
453 * true if scrolling right, false if left
455 * @return true if the scroll is valid
457 public boolean scrollRight(boolean right)
466 setStartRes(startRes - 1);
470 if (endRes >= getVisibleAlignmentWidth() - 1)
475 setStartRes(startRes + 1);
482 * Scroll a wrapped alignment so that the specified residue is visible. Fires
483 * a property change event.
486 * residue position to scroll to
488 public void scrollToWrappedVisible(int res)
490 // get the start residue of the wrapped row which res is in
491 // and set that as our start residue
492 int width = getViewportWidth();
493 setStartRes((res / width) * width);
497 * Scroll so that (x,y) is visible. Fires a property change event.
500 * x position in alignment
502 * y position in alignment
504 public void scrollToVisible(int x, int y)
515 HiddenColumns hidden = al.getHiddenColumns();
516 while (x < hidden.adjustForHiddenColumns(startRes))
518 if (!scrollRight(false))
523 while (x > hidden.adjustForHiddenColumns(endRes))
525 if (!scrollRight(true))
533 * Adjust sequence position for page up. Fires a property change event.
539 setStartRes(Math.max(0, getStartRes() - getViewportWidth()));
543 setViewportStartAndHeight(startSeq - (endSeq - startSeq),
544 getViewportHeight());
549 * Adjust sequence position for page down. Fires a property change event.
551 public void pageDown()
556 * if height is more than width (i.e. not all sequences fit on screen),
557 * increase page down to height
559 int newStart = getStartRes()
560 + Math.max(getViewportHeight(), getViewportWidth());
563 * don't page down beyond end of alignment, or if not all
564 * sequences fit in the visible height
566 if (newStart < getVisibleAlignmentWidth())
568 setStartRes(newStart);
573 setViewportStartAndHeight(endSeq, getViewportHeight());
577 public void setWrappedMode(boolean wrapped)
579 wrappedMode = wrapped;
583 * Answers the vertical scroll position (0..) to set, given the visible column
584 * that is at top left. Note that if called with the total visible width of
585 * the alignment, this gives the maximum cursor scroll value.
589 * viewport width 40 columns (0-39, 40-79, 80-119...)
590 * column 0 returns scroll position 0
591 * columns 0-40 return scroll position 1
592 * columns 41-80 return scroll position 2
596 * @param topLeftColumn
600 public int getWrappedScrollPosition(final int topLeftColumn)
602 int w = getViewportWidth();
605 * visible whole widths
607 int scroll = topLeftColumn / w;
608 scroll += topLeftColumn % w > 0 ? 1 : 0;