Merge branch 'patch/JAL-4345_pae_epas1_doubleclick' into develop
[jalview.git] / src / jalview / gui / IdCanvas.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
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.
11  *  
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.
16  * 
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.
20  */
21 package jalview.gui;
22
23 import java.awt.BorderLayout;
24 import java.awt.Color;
25 import java.awt.Dimension;
26 import java.awt.Font;
27 import java.awt.FontMetrics;
28 import java.awt.Graphics;
29 import java.awt.Graphics2D;
30 import java.awt.RenderingHints;
31 import java.awt.image.BufferedImage;
32 import java.beans.PropertyChangeEvent;
33 import java.util.List;
34
35 import javax.swing.JPanel;
36
37 import jalview.datamodel.SequenceI;
38 import jalview.viewmodel.ViewportListenerI;
39 import jalview.viewmodel.ViewportRanges;
40
41 /**
42  * DOCUMENT ME!
43  * 
44  * @author $author$
45  * @version $Revision$
46  */
47 public class IdCanvas extends JPanel implements ViewportListenerI
48 {
49   protected AlignViewport av;
50
51   protected boolean showScores = true;
52
53   protected int maxIdLength = -1;
54
55   protected String maxIdStr = null;
56
57   BufferedImage image;
58
59   // Graphics2D gg;
60
61   int imgHeight = 0;
62
63   boolean fastPaint = false;
64
65   List<SequenceI> searchResults;
66
67   AnnotationPanel ap;
68
69   private Font idfont;
70
71   /**
72    * Creates a new IdCanvas object.
73    * 
74    * @param av
75    *          DOCUMENT ME!
76    */
77   public IdCanvas(AlignViewport av)
78   {
79     setLayout(new BorderLayout());
80     this.av = av;
81     PaintRefresher.Register(this, av.getSequenceSetId());
82     av.getRanges().addPropertyChangeListener(this);
83   }
84
85   /**
86    * DOCUMENT ME!
87    * 
88    * @param g
89    *          DOCUMENT ME!
90    * @param hiddenRows
91    *          true - check and display hidden row marker if need be
92    * @param s
93    *          DOCUMENT ME!
94    * @param i
95    *          DOCUMENT ME!
96    * @param starty
97    *          DOCUMENT ME!
98    * @param ypos
99    *          DOCUMENT ME!
100    */
101   public void drawIdString(Graphics2D g, boolean hiddenRows, SequenceI s,
102           int i, int starty, int ypos)
103   {
104     int xPos = 0;
105     int panelWidth = getWidth();
106     int charHeight = av.getCharHeight();
107
108     if ((searchResults != null) && searchResults.contains(s))
109     {
110       g.setColor(Color.black);
111       g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
112               charHeight);
113       g.setColor(Color.white);
114     }
115     else if ((av.getSelectionGroup() != null)
116             && av.getSelectionGroup().getSequences(null).contains(s))
117     {
118       g.setColor(Color.lightGray);
119       g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
120               charHeight);
121       g.setColor(Color.white);
122     }
123     else
124     {
125       g.setColor(av.getSequenceColour(s));
126       g.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
127               charHeight);
128       g.setColor(Color.black);
129     }
130
131     if (av.isRightAlignIds())
132     {
133       FontMetrics fm = g.getFontMetrics();
134       xPos = panelWidth
135               - fm.stringWidth(s.getDisplayId(av.getShowJVSuffix())) - 4;
136     }
137
138     g.drawString(s.getDisplayId(av.getShowJVSuffix()), xPos,
139             (((i - starty + 1) * charHeight) + ypos) - (charHeight / 5));
140
141     if (hiddenRows && av.getShowHiddenMarkers())
142     {
143       drawMarker(g, av, i, starty, ypos);
144     }
145
146   }
147
148   /**
149    * DOCUMENT ME!
150    * 
151    * @param vertical
152    *          DOCUMENT ME!
153    */
154   public void fastPaint(int vertical)
155   {
156
157     /*
158      * for now, not attempting fast paint of wrapped ids...
159      */
160     if (image == null || av.getWrapAlignment())
161     {
162       repaint();
163
164       return;
165     }
166
167     ViewportRanges ranges = av.getRanges();
168
169     Graphics2D gg = image.createGraphics();
170     gg.copyArea(0, 0, getWidth(), imgHeight, 0,
171             -vertical * av.getCharHeight());
172
173     int ss = ranges.getStartSeq();
174     int es = ranges.getEndSeq();
175     int transY = 0;
176
177     if (vertical > 0) // scroll down
178     {
179       ss = es - vertical;
180
181       if (ss < ranges.getStartSeq())
182       { // ie scrolling too fast, more than a page at a time
183         ss = ranges.getStartSeq();
184       }
185       else
186       {
187         transY = imgHeight - ((vertical + 1) * av.getCharHeight());
188       }
189     }
190     else if (vertical < 0) // scroll up
191     {
192       es = ss - vertical;
193
194       if (es > ranges.getEndSeq())
195       {
196         es = ranges.getEndSeq();
197       }
198     }
199
200     gg.translate(0, transY);
201
202     drawIds(gg, av, ss, es, searchResults, true, getWidth());
203
204     gg.translate(0, -transY);
205
206     gg.dispose();
207
208     fastPaint = true;
209
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();
214   }
215
216   /**
217    * DOCUMENT ME!
218    * 
219    * @param g
220    *          DOCUMENT ME!
221    */
222   @Override
223   public void paintComponent(Graphics g)
224   {
225     g.setColor(Color.white);
226     g.fillRect(0, 0, getWidth(), getHeight());
227
228     if (fastPaint)
229     {
230       fastPaint = false;
231       g.drawImage(image, 0, 0, this);
232
233       return;
234     }
235
236     int oldHeight = imgHeight;
237
238     imgHeight = getHeight();
239     imgHeight -= (imgHeight % av.getCharHeight());
240
241     if (imgHeight < 1)
242     {
243       return;
244     }
245
246     if (oldHeight != imgHeight || image.getWidth(this) != getWidth())
247     {
248       image = new BufferedImage(getWidth(), imgHeight,
249               BufferedImage.TYPE_INT_RGB);
250     }
251
252     Graphics2D gg = image.createGraphics();
253
254     // Fill in the background
255     gg.setColor(Color.white);
256     gg.fillRect(0, 0, getWidth(), imgHeight);
257
258     drawIds(gg, av, av.getRanges().getStartSeq(),
259             av.getRanges().getEndSeq(), searchResults, true, getWidth());
260
261     gg.dispose();
262
263     g.drawImage(image, 0, 0, this);
264   }
265
266   /**
267    * Draws sequence ids from sequence index startSeq to endSeq (inclusive), with
268    * the font and other display settings configured on the viewport. Ids of
269    * sequences included in the selection are coloured grey, otherwise the
270    * current id colour for the sequence id is used.
271    * 
272    * @param g
273    * @param alignViewport
274    * @param startSeq
275    * @param endSeq
276    * @param selection
277    * @param forGUI
278    *          when false rendering for print
279    * @param panelWidth
280    *          width used to calculate righthand margin - usually
281    *          idCanvas.getWidth()
282    * 
283    */
284   void drawIds(Graphics2D g, AlignViewport alignViewport,
285           final int startSeq, final int endSeq, List<SequenceI> selection,
286           boolean forGUI, int panelWidth)
287   {
288     Font font = alignViewport.getFont();
289     if (alignViewport.isSeqNameItalics())
290     {
291       setIdfont(new Font(font.getName(), Font.ITALIC, font.getSize()));
292     }
293     else
294     {
295       setIdfont(font);
296     }
297
298     g.setFont(getIdfont());
299     FontMetrics fm = g.getFontMetrics();
300
301     if (alignViewport.antiAlias)
302     {
303       g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
304               RenderingHints.VALUE_ANTIALIAS_ON);
305     }
306
307     Color currentColor = Color.white;
308     Color currentTextColor = Color.black;
309
310     boolean hasHiddenRows = alignViewport.hasHiddenRows();
311
312     if (alignViewport.getWrapAlignment())
313     {
314       drawIdsWrapped(g, alignViewport, startSeq, getHeight(),
315               manuallyAdjusted ? panelWidth : -1, forGUI);
316       return;
317     }
318
319     // Now draw the id strings
320     int xPos = 0;
321
322     // Now draw the id strings
323     for (int i = startSeq; i <= endSeq; i++)
324     {
325       SequenceI sequence = alignViewport.getAlignment().getSequenceAt(i);
326
327       if (sequence == null)
328       {
329         continue;
330       }
331
332       if (hasHiddenRows || alignViewport.isDisplayReferenceSeq())
333       {
334         g.setFont(getHiddenFont(sequence, alignViewport));
335         fm = g.getFontMetrics();
336       }
337
338       // Selected sequence colours
339       if (selection != null && selection.contains(sequence))
340       {
341         currentColor = Color.black;
342         currentTextColor = Color.white;
343       }
344       else if ((alignViewport.getSelectionGroup() != null) && alignViewport
345               .getSelectionGroup().getSequences(null).contains(sequence))
346       {
347         currentColor = Color.lightGray;
348         currentTextColor = Color.black;
349       }
350       else
351       {
352         currentColor = alignViewport.getSequenceColour(sequence);
353         currentTextColor = Color.black;
354       }
355
356       g.setColor(currentColor);
357
358       int charHeight = alignViewport.getCharHeight();
359       g.fillRect(0, (i - startSeq) * charHeight, getWidth(), charHeight);
360
361       g.setColor(currentTextColor);
362
363       String string = sequence
364               .getDisplayId(alignViewport.getShowJVSuffix());
365
366       if (alignViewport.isRightAlignIds())
367       {
368         xPos = panelWidth - fm.stringWidth(string) - 4;
369       }
370
371       g.drawString(string, xPos,
372               (((i - startSeq) * charHeight) + charHeight)
373                       - (charHeight / 5));
374
375       if (hasHiddenRows && av.getShowHiddenMarkers())
376       {
377         drawMarker(g, alignViewport, i, startSeq, 0);
378       }
379     }
380   }
381
382   /**
383    * Draws sequence ids, and annotation labels if annotations are shown, in
384    * wrapped mode
385    * 
386    * @param g
387    * @param alignViewport
388    * @param startSeq
389    */
390   void drawIdsWrapped(Graphics2D g, AlignViewport alignViewport,
391           int startSeq, int pageHeight)
392   {
393     drawIdsWrapped(g, alignViewport, startSeq, pageHeight, -1, true);
394   }
395
396   /**
397    * render sequence IDs and annotation labels when wrapped - without GUI junk
398    * 
399    * @param g
400    * @param av2
401    * @param startSeq
402    * @param totalHeight
403    */
404   public void drawIdsWrappedNoGUI(Graphics2D g, AlignViewport av2,
405           int startSeq, int totalHeight)
406   {
407     drawIdsWrapped(g, av2, startSeq, totalHeight, -1, false);
408   }
409
410   public void drawIdsWrapped(Graphics2D g, AlignViewport alignViewport,
411           int startSeq, int pageHeight, int idWidth, boolean forGUI)
412   {
413     int alignmentWidth = alignViewport.getAlignment().getWidth();
414     final int alheight = alignViewport.getAlignment().getHeight();
415
416     /*
417      * assumption: SeqCanvas.calculateWrappedGeometry has been called
418      */
419     SeqCanvas seqCanvas = alignViewport.getAlignPanel()
420             .getSeqPanel().seqCanvas;
421
422     final int charHeight = alignViewport.getCharHeight();
423
424     AnnotationLabels labels = null;
425     if (alignViewport.isShowAnnotation())
426     {
427       // in wrapped mode, no alignPanel reference is available
428       // FIXME: make the renderer not create a new object in wrapped mode
429       // everytime!
430       labels = new AnnotationLabels(alignViewport);
431     }
432
433     ViewportRanges ranges = alignViewport.getRanges();
434
435     int rowSize = ranges.getViewportWidth();
436
437     /*
438      * draw repeating sequence ids until out of sequence data or
439      * out of visible space, whichever comes first
440      */
441     boolean hasHiddenRows = alignViewport.hasHiddenRows();
442     int ypos = seqCanvas.wrappedSpaceAboveAlignment;
443     int rowStartRes = ranges.getStartRes();
444     while ((ypos <= pageHeight) && (rowStartRes < alignmentWidth))
445     {
446       for (int i = startSeq; i < alheight; i++)
447       {
448         SequenceI s = alignViewport.getAlignment().getSequenceAt(i);
449         if (hasHiddenRows || alignViewport.isDisplayReferenceSeq())
450         {
451           g.setFont(getHiddenFont(s, alignViewport));
452         }
453         else
454         {
455           g.setFont(getIdfont());
456         }
457         drawIdString(g, hasHiddenRows, s, i, 0, ypos);
458       }
459
460       if (labels != null && alignViewport.isShowAnnotation())
461       {
462         int getWidth = getWidth();
463         int thisIdWidth = getWidth;
464         g.translate(0, ypos + (alheight * charHeight));
465         if (!isManuallyAdjusted())
466         {
467           int getAnnotationsIdWidth = labels.drawLabels(g, false, -1, false,
468                   forGUI, null, false);
469           thisIdWidth = idWidth < 0 ? getAnnotationsIdWidth : idWidth;
470           if (thisIdWidth > getWidth)
471           {
472             this.setPreferredSize(
473                     new Dimension(thisIdWidth, this.getHeight()));
474             this.repaint();
475             alignViewport.setIdWidth(thisIdWidth);
476           }
477         }
478         labels.drawComponent(g, false, thisIdWidth, forGUI);
479         g.translate(0, -ypos - (alheight * charHeight));
480       }
481
482       ypos += seqCanvas.wrappedRepeatHeightPx;
483       rowStartRes += rowSize;
484     }
485   }
486
487   /**
488    * Draws a marker (a blue right-pointing triangle) between sequences to
489    * indicate hidden sequences.
490    * 
491    * @param g
492    * @param alignViewport
493    * @param seqIndex
494    * @param starty
495    * @param yoffset
496    */
497   void drawMarker(Graphics2D g, AlignViewport alignViewport, int seqIndex,
498           int starty, int yoffset)
499   {
500     SequenceI[] hseqs = alignViewport.getAlignment()
501             .getHiddenSequences().hiddenSequences;
502     // Use this method here instead of calling hiddenSeq adjust
503     // 3 times.
504     int hSize = hseqs.length;
505
506     int hiddenIndex = seqIndex;
507     int lastIndex = seqIndex - 1;
508     int nextIndex = seqIndex + 1;
509
510     for (int j = 0; j < hSize; j++)
511     {
512       if (hseqs[j] != null)
513       {
514         if (j - 1 < hiddenIndex)
515         {
516           hiddenIndex++;
517         }
518         if (j - 1 < lastIndex)
519         {
520           lastIndex++;
521         }
522         if (j - 1 < nextIndex)
523         {
524           nextIndex++;
525         }
526       }
527     }
528
529     /*
530      * are we below or above the hidden sequences?
531      */
532     boolean below = (hiddenIndex > lastIndex + 1);
533     boolean above = (nextIndex > hiddenIndex + 1);
534
535     g.setColor(Color.blue);
536     int charHeight = av.getCharHeight();
537
538     /*
539      * vertices of the triangle, below or above hidden seqs
540      */
541     int[] xPoints = new int[] { getWidth() - charHeight,
542         getWidth() - charHeight, getWidth() };
543     int yShift = seqIndex - starty;
544
545     if (below)
546     {
547       int[] yPoints = new int[] { yShift * charHeight + yoffset,
548           yShift * charHeight + yoffset + charHeight / 4,
549           yShift * charHeight + yoffset };
550       g.fillPolygon(xPoints, yPoints, 3);
551     }
552     if (above)
553     {
554       yShift++;
555       int[] yPoints = new int[] { yShift * charHeight + yoffset,
556           yShift * charHeight + yoffset - charHeight / 4,
557           yShift * charHeight + yoffset };
558       g.fillPolygon(xPoints, yPoints, 3);
559     }
560   }
561
562   /**
563    * Answers the standard sequence id font, or a bold font if the sequence is
564    * set as reference or a hidden group representative
565    * 
566    * @param seq
567    * @param alignViewport
568    * @return
569    */
570   private Font getHiddenFont(SequenceI seq, AlignViewport alignViewport)
571   {
572     if (av.isReferenceSeq(seq) || av.isHiddenRepSequence(seq))
573     {
574       return new Font(av.getFont().getName(), Font.BOLD,
575               av.getFont().getSize());
576     }
577     return getIdfont();
578   }
579
580   /**
581    * DOCUMENT ME!
582    * 
583    * @param list
584    *          DOCUMENT ME!
585    */
586   public void setHighlighted(List<SequenceI> list)
587   {
588     searchResults = list;
589     repaint();
590   }
591
592   public Font getIdfont()
593   {
594     return idfont;
595   }
596
597   public void setIdfont(Font idfont)
598   {
599     this.idfont = idfont;
600   }
601
602   /**
603    * Respond to viewport range changes (e.g. alignment panel was scrolled). Both
604    * scrolling and resizing change viewport ranges. Scrolling changes both start
605    * and end points, but resize only changes end values. Here we only want to
606    * fastpaint on a scroll, with resize using a normal paint, so scroll events
607    * are identified as changes to the horizontal or vertical start value.
608    * <p>
609    * In unwrapped mode, only responds to a vertical scroll, as horizontal scroll
610    * leaves sequence ids unchanged. In wrapped mode, only vertical scroll is
611    * provided, but it generates a change of "startres" which does require an
612    * update here.
613    */
614   @Override
615   public void propertyChange(PropertyChangeEvent evt)
616   {
617     String propertyName = evt.getPropertyName();
618     if (propertyName.equals(ViewportRanges.STARTSEQ)
619             || (av.getWrapAlignment()
620                     && propertyName.equals(ViewportRanges.STARTRES)))
621     {
622       fastPaint((int) evt.getNewValue() - (int) evt.getOldValue());
623     }
624     else if (propertyName.equals(ViewportRanges.STARTRESANDSEQ))
625     {
626       fastPaint(((int[]) evt.getNewValue())[1]
627               - ((int[]) evt.getOldValue())[1]);
628     }
629     else if (propertyName.equals(ViewportRanges.MOVE_VIEWPORT))
630     {
631       repaint();
632     }
633   }
634
635   private boolean manuallyAdjusted = false;
636
637   public boolean isManuallyAdjusted()
638   {
639     return manuallyAdjusted;
640   }
641
642   public void setManuallyAdjusted(boolean b)
643   {
644     manuallyAdjusted = b;
645   }
646
647 }