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.appletgui;
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.HiddenColumns;
25 import jalview.datamodel.SearchResultsI;
26 import jalview.datamodel.SequenceGroup;
27 import jalview.datamodel.SequenceI;
28 import jalview.renderer.ScaleRenderer;
29 import jalview.renderer.ScaleRenderer.ScaleMark;
30 import jalview.viewmodel.AlignmentViewport;
31 import jalview.viewmodel.ViewportListenerI;
32 import jalview.viewmodel.ViewportRanges;
34 import java.awt.Color;
35 import java.awt.FontMetrics;
36 import java.awt.Graphics;
37 import java.awt.Image;
38 import java.awt.Panel;
39 import java.beans.PropertyChangeEvent;
40 import java.util.List;
42 public class SeqCanvas extends Panel implements ViewportListenerI
58 boolean fastPaint = false;
64 public SeqCanvas(AlignViewport av)
67 fr = new FeatureRenderer(av);
68 sr = new SequenceRenderer(av);
69 PaintRefresher.Register(this, av.getSequenceSetId());
72 av.getRanges().addPropertyChangeListener(this);
75 int avcharHeight = 0, avcharWidth = 0;
77 private void updateViewport()
79 avcharHeight = av.getCharHeight();
80 avcharWidth = av.getCharWidth();
83 public AlignmentViewport getViewport()
88 public FeatureRenderer getFeatureRenderer()
93 public SequenceRenderer getSequenceRenderer()
98 private void drawNorthScale(Graphics g, int startx, int endx, int ypos)
101 g.setColor(Color.black);
102 for (ScaleMark mark : new ScaleRenderer().calculateMarks(av, startx,
105 int mpos = mark.column; // (i - startx - 1)
110 String mstring = mark.text;
116 g.drawString(mstring, mpos * avcharWidth, ypos
117 - (avcharHeight / 2));
119 g.drawLine((mpos * avcharWidth) + (avcharWidth / 2), (ypos + 2)
120 - (avcharHeight / 2), (mpos * avcharWidth)
121 + (avcharWidth / 2), ypos - 2);
126 private void drawWestScale(Graphics g, int startx, int endx, int ypos)
128 FontMetrics fm = getFontMetrics(av.getFont());
129 ypos += avcharHeight;
130 if (av.hasHiddenColumns())
132 startx = av.getAlignment().getHiddenColumns()
133 .adjustForHiddenColumns(startx);
134 endx = av.getAlignment().getHiddenColumns()
135 .adjustForHiddenColumns(endx);
138 int maxwidth = av.getAlignment().getWidth();
139 if (av.hasHiddenColumns())
141 maxwidth = av.getAlignment().getHiddenColumns()
142 .findColumnPosition(maxwidth) - 1;
146 for (int i = 0; i < av.getAlignment().getHeight(); i++)
148 SequenceI seq = av.getAlignment().getSequenceAt(i);
154 if (jalview.util.Comparison.isGap(seq.getCharAt(index)))
161 value = av.getAlignment().getSequenceAt(i).findPosition(index);
168 int x = LABEL_WEST - fm.stringWidth(String.valueOf(value))
170 g.drawString(value + "", x, (ypos + (i * avcharHeight))
171 - (avcharHeight / 5));
176 private void drawEastScale(Graphics g, int startx, int endx, int ypos)
178 ypos += avcharHeight;
180 if (av.hasHiddenColumns())
182 endx = av.getAlignment().getHiddenColumns()
183 .adjustForHiddenColumns(endx);
188 for (int i = 0; i < av.getAlignment().getHeight(); i++)
190 seq = av.getAlignment().getSequenceAt(i);
194 while (index > startx)
196 if (jalview.util.Comparison.isGap(seq.getCharAt(index)))
203 value = seq.findPosition(index);
210 g.drawString(String.valueOf(value), 0, (ypos + (i * avcharHeight))
211 - (avcharHeight / 5));
218 void fastPaint(int horizontal, int vertical)
220 if (fastPaint || gg == null)
225 ViewportRanges ranges = av.getRanges();
229 // Its possible on certain browsers that the call to fastpaint
230 // is faster than it can paint, so this check here catches
232 if (lastsr + horizontal != ranges.getStartRes())
234 horizontal = ranges.getStartRes() - lastsr;
237 lastsr = ranges.getStartRes();
240 gg.copyArea(horizontal * avcharWidth, vertical * avcharHeight, imgWidth
241 - horizontal * avcharWidth,
242 imgHeight - vertical * avcharHeight, -horizontal * avcharWidth,
243 -vertical * avcharHeight);
245 int sr = ranges.getStartRes(), er = ranges.getEndRes(), ss = ranges
246 .getStartSeq(), es = ranges
247 .getEndSeq(), transX = 0, transY = 0;
249 if (horizontal > 0) // scrollbar pulled right, image to the left
251 transX = (er - sr - horizontal) * avcharWidth;
252 sr = er - horizontal;
254 else if (horizontal < 0)
256 er = sr - horizontal;
259 else if (vertical > 0) // scroll down
262 if (ss < ranges.getStartSeq()) // ie scrolling too fast, more than a page
266 ss = ranges.getStartSeq();
270 transY = imgHeight - ((vertical + 1) * avcharHeight);
273 else if (vertical < 0)
276 if (es > ranges.getEndSeq())
278 es = ranges.getEndSeq();
282 gg.translate(transX, transY);
284 drawPanel(gg, sr, er, ss, es, 0);
285 gg.translate(-transX, -transY);
292 * Definitions of startx and endx (hopefully): SMJS This is what I'm working
293 * towards! startx is the first residue (starting at 0) to display. endx is
294 * the last residue to display (starting at 0). starty is the first sequence
295 * to display (starting at 0). endy is the last sequence to display (starting
296 * at 0). NOTE 1: The av limits are set in setFont in this class and in the
297 * adjustment listener in SeqPanel when the scrollbars move.
300 public void update(Graphics g)
306 public void paint(Graphics g)
310 && (fastPaint || (getSize().width != g.getClipBounds().width) || (getSize().height != g
311 .getClipBounds().height)))
313 g.drawImage(img, 0, 0, this);
320 g.drawImage(img, 0, 0, this);
326 // this draws the whole of the alignment
327 imgWidth = this.getSize().width;
328 imgHeight = this.getSize().height;
330 imgWidth -= imgWidth % avcharWidth;
331 imgHeight -= imgHeight % avcharHeight;
333 if (imgWidth < 1 || imgHeight < 1)
338 if (img == null || imgWidth != img.getWidth(this)
339 || imgHeight != img.getHeight(this))
341 img = createImage(imgWidth, imgHeight);
342 gg = img.getGraphics();
343 gg.setFont(av.getFont());
346 gg.setColor(Color.white);
347 gg.fillRect(0, 0, imgWidth, imgHeight);
349 ViewportRanges ranges = av.getRanges();
351 if (av.getWrapAlignment())
353 drawWrappedPanel(gg, imgWidth, imgHeight, ranges.getStartRes());
357 drawPanel(gg, ranges.getStartRes(), ranges.getEndRes(),
358 ranges.getStartSeq(), ranges.getEndSeq(), 0);
361 g.drawImage(img, 0, 0, this);
365 int LABEL_WEST, LABEL_EAST;
367 public int getWrappedCanvasWidth(int cwidth)
369 cwidth -= cwidth % av.getCharWidth();
371 FontMetrics fm = getFontMetrics(av.getFont());
376 if (av.getScaleRightWrapped())
378 LABEL_EAST = fm.stringWidth(getMask());
381 if (av.getScaleLeftWrapped())
383 LABEL_WEST = fm.stringWidth(getMask());
386 return (cwidth - LABEL_EAST - LABEL_WEST) / av.getCharWidth();
390 * Generates a string of zeroes.
399 AlignmentI alignment = av.getAlignment();
400 for (int i = 0; i < alignment.getHeight(); i++)
402 tmp = alignment.getSequenceAt(i).getEnd();
409 for (int i = maxWidth; i > 0; i /= 10)
416 private void drawWrappedPanel(Graphics g, int canvasWidth,
417 int canvasHeight, int startRes)
419 AlignmentI al = av.getAlignment();
421 FontMetrics fm = getFontMetrics(av.getFont());
426 if (av.getScaleRightWrapped())
428 LABEL_EAST = fm.stringWidth(getMask());
431 if (av.getScaleLeftWrapped())
433 LABEL_WEST = fm.stringWidth(getMask());
436 int hgap = avcharHeight;
437 if (av.getScaleAboveWrapped())
439 hgap += avcharHeight;
442 int cWidth = (canvasWidth - LABEL_EAST - LABEL_WEST) / avcharWidth;
443 int cHeight = av.getAlignment().getHeight() * avcharHeight;
445 av.setWrappedWidth(cWidth);
447 av.getRanges().setViewportStartAndWidth(startRes, cWidth);
452 int maxwidth = av.getAlignment().getWidth();
454 if (av.hasHiddenColumns())
456 maxwidth = av.getAlignment().getHiddenColumns()
457 .findColumnPosition(maxwidth);
460 while ((ypos <= canvasHeight) && (startRes < maxwidth))
462 endx = startRes + cWidth - 1;
469 g.setColor(Color.black);
471 if (av.getScaleLeftWrapped())
473 drawWestScale(g, startRes, endx, ypos);
476 if (av.getScaleRightWrapped())
478 g.translate(canvasWidth - LABEL_EAST, 0);
479 drawEastScale(g, startRes, endx, ypos);
480 g.translate(-(canvasWidth - LABEL_EAST), 0);
483 g.translate(LABEL_WEST, 0);
485 if (av.getScaleAboveWrapped())
487 drawNorthScale(g, startRes, endx, ypos);
489 if (av.hasHiddenColumns() && av.getShowHiddenMarkers())
491 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
492 g.setColor(Color.blue);
494 List<Integer> positions = hidden.findHiddenRegionPositions();
495 for (int pos : positions)
497 res = pos - startRes;
499 if (res < 0 || res > endx - startRes)
504 gg.fillPolygon(new int[] { res * avcharWidth - avcharHeight / 4,
505 res * avcharWidth + avcharHeight / 4, res * avcharWidth },
506 new int[] { ypos - (avcharHeight / 2),
507 ypos - (avcharHeight / 2),
508 ypos - (avcharHeight / 2) + 8 }, 3);
513 if (g.getClip() == null)
515 g.setClip(0, 0, cWidth * avcharWidth, canvasHeight);
518 drawPanel(g, startRes, endx, 0, al.getHeight() - 1, ypos);
521 if (av.isShowAnnotation())
523 g.translate(0, cHeight + ypos + 4);
524 if (annotations == null)
526 annotations = new AnnotationPanel(av);
529 annotations.drawComponent(g, startRes, endx + 1);
530 g.translate(0, -cHeight - ypos - 4);
532 g.translate(-LABEL_WEST, 0);
534 ypos += cHeight + getAnnotationHeight() + hgap;
541 AnnotationPanel annotations;
543 int getAnnotationHeight()
545 if (!av.isShowAnnotation())
550 if (annotations == null)
552 annotations = new AnnotationPanel(av);
555 return annotations.adjustPanelHeight();
558 private void drawPanel(Graphics g1, int startRes, int endRes,
559 int startSeq, int endSeq, int offset)
562 if (!av.hasHiddenColumns())
564 draw(g1, startRes, endRes, startSeq, endSeq, offset);
570 int blockStart = startRes;
571 int blockEnd = endRes;
573 if (av.hasHiddenColumns())
575 HiddenColumns hidden = av.getAlignment().getHiddenColumns();
576 for (int[] region : hidden.getHiddenColumnsCopy())
578 int hideStart = region[0];
579 int hideEnd = region[1];
581 if (hideStart <= blockStart)
583 blockStart += (hideEnd - hideStart) + 1;
587 blockEnd = hideStart - 1;
589 g1.translate(screenY * avcharWidth, 0);
591 draw(g1, blockStart, blockEnd, startSeq, endSeq, offset);
593 if (av.getShowHiddenMarkers())
595 g1.setColor(Color.blue);
596 g1.drawLine((blockEnd - blockStart + 1) * avcharWidth - 1,
597 0 + offset, (blockEnd - blockStart + 1) * avcharWidth
598 - 1, (endSeq - startSeq + 1) * avcharHeight
602 g1.translate(-screenY * avcharWidth, 0);
603 screenY += blockEnd - blockStart + 1;
604 blockStart = hideEnd + 1;
606 if (screenY > (endRes - startRes))
608 // already rendered last block
613 if (screenY <= (endRes - startRes))
615 // remaining visible region to render
616 blockEnd = blockStart + (endRes - startRes) - screenY;
617 g1.translate(screenY * avcharWidth, 0);
618 draw(g1, blockStart, blockEnd, startSeq, endSeq, offset);
620 g1.translate(-screenY * avcharWidth, 0);
626 // int startRes, int endRes, int startSeq, int endSeq, int x, int y,
627 // int x1, int x2, int y1, int y2, int startx, int starty,
628 void draw(Graphics g, int startRes, int endRes, int startSeq, int endSeq,
631 g.setFont(av.getFont());
632 sr.prepare(g, av.isRenderGaps());
636 // / First draw the sequences
637 // ///////////////////////////
638 for (int i = startSeq; i <= endSeq; i++)
640 nextSeq = av.getAlignment().getSequenceAt(i);
647 sr.drawSequence(nextSeq, av.getAlignment().findAllGroups(nextSeq),
648 startRes, endRes, offset + ((i - startSeq) * avcharHeight));
650 if (av.isShowSequenceFeatures())
652 fr.drawSequence(g, nextSeq, startRes, endRes, offset
653 + ((i - startSeq) * avcharHeight), false);
656 // / Highlight search Results once all sequences have been drawn
657 // ////////////////////////////////////////////////////////
658 if (av.hasSearchResults())
660 int[] visibleResults = av.getSearchResults().getResults(nextSeq,
663 if (visibleResults != null)
665 for (int r = 0; r < visibleResults.length; r += 2)
667 sr.drawHighlightedText(nextSeq, visibleResults[r],
668 visibleResults[r + 1], (visibleResults[r] - startRes)
669 * avcharWidth, offset
670 + ((i - startSeq) * avcharHeight));
675 if (av.cursorMode && cursorY == i && cursorX >= startRes
676 && cursorX <= endRes)
678 sr.drawCursor(nextSeq, cursorX, (cursorX - startRes) * avcharWidth,
679 offset + ((i - startSeq) * avcharHeight));
683 if (av.getSelectionGroup() != null
684 || av.getAlignment().getGroups().size() > 0)
686 drawGroupsBoundaries(g, startRes, endRes, startSeq, endSeq, offset);
691 private void drawGroupsBoundaries(Graphics g, int startRes, int endRes,
692 int startSeq, int endSeq, int offset)
695 // ///////////////////////////////////
696 // Now outline any areas if necessary
697 // ///////////////////////////////////
698 SequenceGroup group = av.getSelectionGroup();
705 if ((group == null) && (av.getAlignment().getGroups().size() > 0))
707 group = av.getAlignment().getGroups().get(0);
717 boolean inGroup = false;
720 int alHeight = av.getAlignment().getHeight() - 1;
722 for (i = startSeq; i <= endSeq; i++)
724 sx = (group.getStartRes() - startRes) * avcharWidth;
725 sy = offset + ((i - startSeq) * avcharHeight);
726 ex = (((group.getEndRes() + 1) - group.getStartRes()) * avcharWidth) - 1;
728 if (sx + ex < 0 || sx > imgWidth)
733 if ((sx <= (endRes - startRes) * avcharWidth)
734 && group.getSequences(null).contains(
735 av.getAlignment().getSequenceAt(i)))
738 && (i >= alHeight || !group.getSequences(null)
740 av.getAlignment().getSequenceAt(i + 1))))
742 bottom = sy + avcharHeight;
747 if (((top == -1) && (i == 0))
748 || !group.getSequences(null).contains(
749 av.getAlignment().getSequenceAt(i - 1)))
757 if (group == av.getSelectionGroup())
759 g.setColor(Color.red);
763 g.setColor(group.getOutlineColour());
771 if (sx >= 0 && sx < imgWidth)
773 g.drawLine(sx, oldY, sx, sy);
776 if (sx + ex < imgWidth)
778 g.drawLine(sx + ex, oldY, sx + ex, sy);
787 if (sx + ex > imgWidth)
792 else if (sx + ex >= (endRes - startRes + 1) * avcharWidth)
794 ex = (endRes - startRes + 1) * avcharWidth;
799 g.drawLine(sx, top, sx + ex, top);
805 g.drawLine(sx, bottom, sx + ex, bottom);
816 sy = offset + ((i - startSeq) * avcharHeight);
817 if (sx >= 0 && sx < imgWidth)
819 g.drawLine(sx, oldY, sx, sy);
822 if (sx + ex < imgWidth)
824 g.drawLine(sx + ex, oldY, sx + ex, sy);
833 if (sx + ex > imgWidth)
837 else if (sx + ex >= (endRes - startRes + 1) * avcharWidth)
839 ex = (endRes - startRes + 1) * avcharWidth;
844 g.drawLine(sx, top, sx + ex, top);
850 g.drawLine(sx, bottom - 1, sx + ex, bottom - 1);
859 if (groupIndex >= av.getAlignment().getGroups().size())
864 group = av.getAlignment().getGroups().get(groupIndex);
865 } while (groupIndex < av.getAlignment().getGroups().size());
870 public void highlightSearchResults(SearchResultsI results)
872 av.setSearchResults(results);
877 public void propertyChange(PropertyChangeEvent evt)
879 String eventName = evt.getPropertyName();
881 if (!av.getWrapAlignment())
884 if (eventName.equals(ViewportRanges.STARTRES))
886 // Make sure we're not trying to draw a panel
887 // larger than the visible window
888 ViewportRanges vpRanges = av.getRanges();
889 scrollX = (int) evt.getNewValue() - (int) evt.getOldValue();
890 int range = vpRanges.getEndRes() - vpRanges.getStartRes();
895 else if (scrollX < -range)
901 // Both scrolling and resizing change viewport ranges: scrolling changes
902 // both start and end points, but resize only changes end values.
903 // Here we only want to fastpaint on a scroll, with resize using a normal
904 // paint, so scroll events are identified as changes to the horizontal or
905 // vertical start value.
906 if (eventName.equals(ViewportRanges.STARTRES))
908 // scroll - startres and endres both change
909 fastPaint(scrollX, 0);
911 else if (eventName.equals(ViewportRanges.STARTSEQ))
914 fastPaint(0, (int) evt.getNewValue() - (int) evt.getOldValue());