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.
23 import jalview.datamodel.SequenceI;
24 import jalview.viewmodel.ViewportListenerI;
25 import jalview.viewmodel.ViewportRanges;
27 import java.awt.BorderLayout;
28 import java.awt.Color;
30 import java.awt.FontMetrics;
31 import java.awt.Graphics;
32 import java.awt.Graphics2D;
33 import java.awt.RenderingHints;
34 import java.awt.image.BufferedImage;
35 import java.beans.PropertyChangeEvent;
36 import java.util.List;
38 import javax.swing.JPanel;
46 public class IdCanvas extends JPanel implements ViewportListenerI
48 protected AlignViewport av;
50 protected boolean showScores = true;
52 protected int maxIdLength = -1;
54 protected String maxIdStr = null;
62 private boolean fastPaint = false;
64 List<SequenceI> searchResults;
71 * Creates a new IdCanvas object.
76 public IdCanvas(AlignViewport av)
78 setLayout(new BorderLayout());
80 PaintRefresher.Register(this, av.getSequenceSetId());
81 av.getRanges().addPropertyChangeListener(this);
90 * true - check and display hidden row marker if need be
100 public void drawIdString(Graphics2D g, boolean hiddenRows, SequenceI s,
101 int i, int starty, int ypos)
104 int panelWidth = getWidth();
105 int charHeight = av.getCharHeight();
107 if ((searchResults != null) && searchResults.contains(s))
109 g.setColor(Color.black);
110 g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
112 g.setColor(Color.white);
114 else if ((av.getSelectionGroup() != null)
115 && av.getSelectionGroup().getSequences(null).contains(s))
117 g.setColor(Color.lightGray);
118 g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
120 g.setColor(Color.white);
124 g.setColor(av.getSequenceColour(s));
125 g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
127 g.setColor(Color.black);
130 if (av.isRightAlignIds())
132 FontMetrics fm = g.getFontMetrics();
134 - fm.stringWidth(s.getDisplayId(av.getShowJVSuffix())) - 4;
137 g.drawString(s.getDisplayId(av.getShowJVSuffix()), xPos,
138 (((i - starty + 1) * charHeight) + ypos) - (charHeight / 5));
140 // JAL-3253-applet was just hiddenRows here. ccfc48e (gmungoc) added getShowHiddenMarkers test
141 if (hiddenRows && av.getShowHiddenMarkers())
143 drawMarker(g, av, i, starty, ypos);
154 public void fastPaint(int vertical)
158 * for now, not attempting fast paint of wrapped ids...
160 if (image == null || av.getWrapAlignment())
167 ViewportRanges ranges = av.getRanges();
169 Graphics2D gg = image.createGraphics();
170 gg.copyArea(0, 0, getWidth(), imgHeight, 0,
171 -vertical * av.getCharHeight());
173 int ss = ranges.getStartSeq();
174 int es = ranges.getEndSeq();
177 if (vertical > 0) // scroll down
181 if (ss < ranges.getStartSeq())
182 { // ie scrolling too fast, more than a page at a time
183 ss = ranges.getStartSeq();
187 transY = imgHeight - ((vertical + 1) * av.getCharHeight());
190 else if (vertical < 0) // scroll up
194 if (es > ranges.getEndSeq())
196 es = ranges.getEndSeq();
200 gg.translate(0, transY);
202 drawIds(gg, av, ss, es, searchResults);
204 gg.translate(0, -transY);
210 // Call repaint on alignment panel so that repaints from other alignment
211 // panel components can be aggregated. Otherwise performance of the overview
212 // window and others may be adversely affected.
213 av.getAlignPanel().repaint();
223 public void paintComponent(Graphics g)
225 if (av.getAlignPanel().getHoldRepaint())
230 g.setColor(Color.white);
231 g.fillRect(0, 0, getWidth(), getHeight());
236 g.drawImage(image, 0, 0, this);
241 int oldHeight = imgHeight;
243 imgHeight = getHeight();
244 imgHeight -= (imgHeight % av.getCharHeight());
251 if (oldHeight != imgHeight || image.getWidth(this) != getWidth())
253 image = new BufferedImage(getWidth(), imgHeight,
254 BufferedImage.TYPE_INT_RGB);
257 Graphics2D gg = image.createGraphics();
259 // Fill in the background
260 gg.setColor(Color.white);
261 gg.fillRect(0, 0, getWidth(), imgHeight);
263 drawIds(gg, av, av.getRanges().getStartSeq(), av.getRanges().getEndSeq(), searchResults);
267 g.drawImage(image, 0, 0, this);
271 * Draws sequence ids from sequence index startSeq to endSeq (inclusive), with
272 * the font and other display settings configured on the viewport. Ids of
273 * sequences included in the selection are coloured grey, otherwise the
274 * current id colour for the sequence id is used.
277 * @param alignViewport
282 void drawIds(Graphics2D g, AlignViewport alignViewport, final int startSeq,
283 final int endSeq, List<SequenceI> selection)
285 Font font = alignViewport.getFont();
286 if (alignViewport.isSeqNameItalics())
288 setIdfont(new Font(font.getName(), Font.ITALIC,
296 g.setFont(getIdfont());
297 FontMetrics fm = g.getFontMetrics();
299 if (alignViewport.antiAlias)
301 g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
302 RenderingHints.VALUE_ANTIALIAS_ON);
305 Color currentColor = Color.white;
306 Color currentTextColor = Color.black;
308 boolean hasHiddenRows = alignViewport.hasHiddenRows();
310 if (alignViewport.getWrapAlignment())
312 drawIdsWrapped(g, alignViewport, startSeq, getHeight());
316 // Now draw the id strings
317 int panelWidth = getWidth();
320 // Now draw the id strings
321 for (int i = startSeq; i <= endSeq; i++)
323 SequenceI sequence = alignViewport.getAlignment().getSequenceAt(i);
325 if (sequence == null)
330 if (hasHiddenRows || alignViewport.isDisplayReferenceSeq())
332 g.setFont(getHiddenFont(sequence, alignViewport));
335 // Selected sequence colours
336 if (selection != null && selection.contains(sequence))
338 currentColor = Color.black;
339 currentTextColor = Color.white;
341 else if ((alignViewport.getSelectionGroup() != null) && alignViewport
342 .getSelectionGroup().getSequences(null).contains(sequence))
344 currentColor = Color.lightGray;
345 currentTextColor = Color.black;
349 currentColor = alignViewport.getSequenceColour(sequence);
350 currentTextColor = Color.black;
353 g.setColor(currentColor);
355 int charHeight = alignViewport.getCharHeight();
356 g.fillRect(0, (i - startSeq) * charHeight,
357 getWidth(), charHeight);
359 g.setColor(currentTextColor);
361 String string = sequence
362 .getDisplayId(alignViewport.getShowJVSuffix());
364 if (alignViewport.isRightAlignIds())
366 xPos = panelWidth - fm.stringWidth(string) - 4;
369 g.drawString(string, xPos, (((i - startSeq) * charHeight) + charHeight)
372 if (hasHiddenRows && av.getShowHiddenMarkers())
374 drawMarker(g, alignViewport, i, startSeq, 0);
380 * Draws sequence ids, and annotation labels if annotations are shown, in
384 * @param alignViewport
387 void drawIdsWrapped(Graphics2D g, AlignViewport alignViewport,
388 int startSeq, int pageHeight)
390 int alignmentWidth = alignViewport.getAlignment().getWidth();
391 final int alheight = alignViewport.getAlignment().getHeight();
394 // int annotationHeight = 0;
397 * assumption: SeqCanvas.calculateWrappedGeometry has been called
399 * was based on the fact that SeqCanvas was added as a child prior to IdCanvas,
400 * and children are processed in order of addition.
402 * It's probably fine. But...
405 SeqCanvas seqCanvas = alignViewport.getAlignPanel()
406 .getSeqPanel().seqCanvas;
407 // ...better: let's call it now
408 seqCanvas.calculateWrappedGeometry();
410 final int charHeight = alignViewport.getCharHeight();
412 AnnotationLabels labels = null;
413 if (alignViewport.isShowAnnotation())
415 // BH when was ap == null?
418 ap = new AnnotationPanel(alignViewport);
420 // annotationHeight = ap.adjustPanelHeight();
421 labels = new AnnotationLabels(alignViewport);
424 // int hgap = charHeight;
425 // if (alignViewport.getScaleAboveWrapped())
427 // hgap += charHeight;
431 // * height of alignment + gap + annotations (if shown)
433 // int cHeight = alheight * charHeight + hgap
434 // + annotationHeight;
436 ViewportRanges ranges = alignViewport.getRanges();
438 int rowSize = ranges.getViewportWidth();
441 * draw repeating sequence ids until out of sequence data or
442 * out of visible space, whichever comes first
444 boolean hasHiddenRows = alignViewport.hasHiddenRows();
445 int ypos = seqCanvas.wrappedSpaceAboveAlignment;
446 int rowStartRes = ranges.getStartRes();
447 while ((ypos <= pageHeight) && (rowStartRes < alignmentWidth))
449 for (int i = startSeq; i < alheight; i++)
451 SequenceI s = alignViewport.getAlignment().getSequenceAt(i);
452 if (hasHiddenRows || alignViewport.isDisplayReferenceSeq())
454 g.setFont(getHiddenFont(s, alignViewport));
458 g.setFont(getIdfont());
460 drawIdString(g, hasHiddenRows, s, i, 0, ypos);
463 if (labels != null && alignViewport.isShowAnnotation())
465 g.translate(0, ypos + (alheight * charHeight));
466 labels.drawComponent(g, getWidth());
467 g.translate(0, -ypos - (alheight * charHeight));
470 ypos += seqCanvas.wrappedRepeatHeightPx;
471 rowStartRes += rowSize;
476 * Draws a marker (a blue right-pointing triangle) between sequences to
477 * indicate hidden sequences.
480 * @param alignViewport
485 void drawMarker(Graphics2D g, AlignViewport alignViewport, int seqIndex, int starty, int yoffset)
487 SequenceI[] hseqs = alignViewport.getAlignment()
488 .getHiddenSequences().hiddenSequences;
489 // Use this method here instead of calling hiddenSeq adjust
491 int hSize = hseqs.length;
493 int hiddenIndex = seqIndex;
494 int lastIndex = seqIndex - 1;
495 int nextIndex = seqIndex + 1;
497 for (int j = 0; j < hSize; j++)
499 if (hseqs[j] != null)
501 if (j - 1 < hiddenIndex)
505 if (j - 1 < lastIndex)
509 if (j - 1 < nextIndex)
517 * are we below or above the hidden sequences?
519 boolean below = (hiddenIndex > lastIndex + 1);
520 boolean above = (nextIndex > hiddenIndex + 1);
522 g.setColor(Color.blue);
523 int charHeight = av.getCharHeight();
526 * vertices of the triangle, below or above hidden seqs
528 int[] xPoints = new int[]
529 { getWidth() - charHeight,
530 getWidth() - charHeight, getWidth() };
531 int yShift = seqIndex - starty;
535 int[] yPoints = new int[] { yShift * charHeight + yoffset,
536 yShift * charHeight + yoffset + charHeight / 4,
537 yShift * charHeight + yoffset };
538 g.fillPolygon(xPoints, yPoints, 3);
543 int[] yPoints = new int[] { yShift * charHeight + yoffset,
544 yShift * charHeight + yoffset - charHeight / 4,
545 yShift * charHeight + yoffset };
546 g.fillPolygon(xPoints, yPoints, 3);
551 * Answers the standard sequence id font, or a bold font if the sequence is
552 * set as reference or a hidden group representative
555 * @param alignViewport
558 private Font getHiddenFont(SequenceI seq, AlignViewport alignViewport)
560 if (av.isReferenceSeq(seq) || av.isHiddenRepSequence(seq))
562 return new Font(av.getFont().getName(), Font.BOLD,
563 av.getFont().getSize());
574 public void setHighlighted(List<SequenceI> list)
576 searchResults = list;
580 public Font getIdfont()
585 public void setIdfont(Font idfont)
587 this.idfont = idfont;
591 * Respond to viewport range changes (e.g. alignment panel was scrolled). Both
592 * scrolling and resizing change viewport ranges. Scrolling changes both start
593 * and end points, but resize only changes end values. Here we only want to
594 * fastpaint on a scroll, with resize using a normal paint, so scroll events
595 * are identified as changes to the horizontal or vertical start value.
597 * In unwrapped mode, only responds to a vertical scroll, as horizontal scroll
598 * leaves sequence ids unchanged. In wrapped mode, only vertical scroll is
599 * provided, but it generates a change of "startres" which does require an
603 public void propertyChange(PropertyChangeEvent evt)
605 String propertyName = evt.getPropertyName();
606 switch (propertyName)
608 case ViewportRanges.STARTSEQ:
609 fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
611 case ViewportRanges.STARTRES:
612 if (av.getWrapAlignment())
614 fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
617 case ViewportRanges.STARTRESANDSEQ:
618 fastPaint(((int[]) evt.getNewValue())[1]
619 - ((int[]) evt.getOldValue())[1]);
621 case ViewportRanges.MOVE_VIEWPORT:
629 * Clears the flag that allows a 'fast paint' on the next repaint, so
630 * requiring a full repaint
632 public void setNoFastPaint()