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;
26 * Embryonic class which: Supplies and updates viewport properties relating to
27 * position such as: start and end residues and sequences; ideally will serve
28 * hidden columns/rows too. Intention also to support calculations for
29 * positioning, scrolling etc. such as finding the middle of the viewport,
30 * checking for scrolls off screen
32 public class ViewportRanges extends ViewportProperties
34 // start residue of viewport
37 // end residue of viewport
40 // start sequence of viewport
43 // end sequence of viewport
47 private AlignmentI al;
53 * the viewport's alignment
55 public ViewportRanges(AlignmentI alignment)
57 // initial values of viewport settings
59 this.endRes = alignment.getWidth() - 1;
61 this.endSeq = alignment.getHeight() - 1;
66 * Get alignment width in cols, including hidden cols
68 public int getAbsoluteAlignmentWidth()
74 * Get alignment height in rows, including hidden rows
76 public int getAbsoluteAlignmentHeight()
78 return al.getHeight() + al.getHiddenSequences().getSize();
82 * Get alignment width in cols, excluding hidden cols
84 public int getVisibleAlignmentWidth()
86 // TODO need access to hidden columns here
87 return al.getWidth(); // - hidden columns
91 * Get alignment height in rows, excluding hidden rows
93 public int getVisibleAlignmentHeight()
95 return al.getHeight();
99 * Set first residue visible in the viewport
104 public void setStartRes(int res)
106 if (res > al.getWidth() - 1)
108 res = al.getWidth() - 1;
118 * Set last residue visible in the viewport
123 public void setEndRes(int res)
125 if (res >= al.getWidth())
127 res = al.getWidth() - 1;
137 * Set the first sequence visible in the viewport
142 public void setStartSeq(int seq)
144 if (seq > al.getHeight() - 1)
146 seq = al.getHeight() - 1;
156 * Set the last sequence visible in the viewport
161 public void setEndSeq(int seq)
163 if (seq >= al.getHeight())
165 seq = al.getHeight() - 1;
175 * Get start residue of viewport
177 public int getStartRes()
183 * Get end residue of viewport
185 public int getEndRes()
191 * Get start sequence of viewport
193 public int getStartSeq()
199 * Get end sequence of viewport
201 public int getEndSeq()