Edit and annotate wrapped alignment
[jalview.git] / src / jalview / gui / SeqCanvas.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  *\r
5  * This program is free software; you can redistribute it and/or\r
6  * modify it under the terms of the GNU General Public License\r
7  * as published by the Free Software Foundation; either version 2\r
8  * of the License, or (at your option) any later version.\r
9  *\r
10  * This program is distributed in the hope that it will be useful,\r
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
13  * GNU General Public License for more details.\r
14  *\r
15  * You should have received a copy of the GNU General Public License\r
16  * along with this program; if not, write to the Free Software\r
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
18  */\r
19 package jalview.gui;\r
20 \r
21 import jalview.datamodel.*;\r
22 \r
23 import java.awt.*;\r
24 import java.awt.image.*;\r
25 \r
26 import javax.swing.*;\r
27 \r
28 \r
29 /**\r
30  * DOCUMENT ME!\r
31  *\r
32  * @author $author$\r
33  * @version $Revision$\r
34  */\r
35 public class SeqCanvas extends JComponent\r
36 {\r
37     FeatureRenderer fr;\r
38     SequenceRenderer sr;\r
39     BufferedImage img;\r
40     Graphics2D gg;\r
41     int imgWidth;\r
42     int imgHeight;\r
43     AlignViewport av;\r
44     boolean displaySearch = false;\r
45     int[] searchResults = null;\r
46     int chunkHeight;\r
47     int chunkWidth;\r
48     boolean fastPaint = false;\r
49     int LABEL_WEST;\r
50     int LABEL_EAST;\r
51 \r
52     /**\r
53      * Creates a new SeqCanvas object.\r
54      *\r
55      * @param av DOCUMENT ME!\r
56      */\r
57     public SeqCanvas(AlignViewport av)\r
58     {\r
59         this.av = av;\r
60         fr = new FeatureRenderer(av);\r
61         sr = new SequenceRenderer(av);\r
62         setLayout(new BorderLayout());\r
63         PaintRefresher.Register(this, av.alignment);\r
64         setBackground(Color.white);\r
65     }\r
66 \r
67     /**\r
68      * DOCUMENT ME!\r
69      *\r
70      * @param g DOCUMENT ME!\r
71      * @param startx DOCUMENT ME!\r
72      * @param endx DOCUMENT ME!\r
73      * @param ypos DOCUMENT ME!\r
74      */\r
75     void drawNorthScale(Graphics g, int startx, int endx, int ypos)\r
76     {\r
77         int scalestartx = startx - (startx % 10) + 10;\r
78 \r
79         g.setColor(Color.black);\r
80 \r
81         // NORTH SCALE\r
82         for (int i = scalestartx; i < endx; i += 10)\r
83         {\r
84             String string = String.valueOf(i);\r
85             g.drawString(string, (i - startx - 1) * av.charWidth,\r
86                 ypos - (av.charHeight / 2));\r
87 \r
88             g.drawLine(((i - startx - 1) * av.charWidth) + (av.charWidth / 2),\r
89                 (ypos + 2) - (av.charHeight / 2),\r
90                 ((i - startx - 1) * av.charWidth) + (av.charWidth / 2), ypos -\r
91                 2);\r
92         }\r
93     }\r
94 \r
95     /**\r
96      * DOCUMENT ME!\r
97      *\r
98      * @param g DOCUMENT ME!\r
99      * @param startx DOCUMENT ME!\r
100      * @param endx DOCUMENT ME!\r
101      * @param ypos DOCUMENT ME!\r
102      */\r
103     void drawWestScale(Graphics g, int startx, int endx, int ypos)\r
104     {\r
105         FontMetrics fm = getFontMetrics(av.getFont());\r
106         ypos += av.charHeight;\r
107 \r
108         // EAST SCALE\r
109         for (int i = 0; i < av.alignment.getHeight(); i++)\r
110         {\r
111             SequenceI seq = av.alignment.getSequenceAt(i);\r
112             int index = startx;\r
113             int value = -1;\r
114 \r
115             while (index < endx)\r
116             {\r
117                 if (jalview.util.Comparison.isGap(seq.getCharAt(index)))\r
118                 {\r
119                     index++;\r
120 \r
121                     continue;\r
122                 }\r
123 \r
124                 value = av.alignment.getSequenceAt(i).findPosition(index);\r
125 \r
126                 break;\r
127             }\r
128 \r
129             if (value != -1)\r
130             {\r
131                 int x = LABEL_WEST - fm.stringWidth(String.valueOf(value))-av.charWidth/2;\r
132                 g.drawString(value + "", x,\r
133                     (ypos + (i * av.charHeight)) - (av.charHeight / 5));\r
134             }\r
135         }\r
136     }\r
137 \r
138     /**\r
139      * DOCUMENT ME!\r
140      *\r
141      * @param g DOCUMENT ME!\r
142      * @param startx DOCUMENT ME!\r
143      * @param endx DOCUMENT ME!\r
144      * @param ypos DOCUMENT ME!\r
145      */\r
146     void drawEastScale(Graphics g, int startx, int endx, int ypos)\r
147     {\r
148         ypos += av.charHeight;\r
149 \r
150         // EAST SCALE\r
151         for (int i = 0; i < av.alignment.getHeight(); i++)\r
152         {\r
153             SequenceI seq = av.alignment.getSequenceAt(i);\r
154             int index = endx;\r
155             int value = -1;\r
156 \r
157             while (index > startx)\r
158             {\r
159                 if (jalview.util.Comparison.isGap(seq.getCharAt(index)))\r
160                 {\r
161                     index--;\r
162 \r
163                     continue;\r
164                 }\r
165 \r
166                 value = av.alignment.getSequenceAt(i).findPosition(index);\r
167 \r
168                 break;\r
169             }\r
170 \r
171             if (value != -1)\r
172             {\r
173                 g.drawString(String.valueOf(value), av.charWidth/2,\r
174                     (ypos + (i * av.charHeight)) - (av.charHeight / 5));\r
175             }\r
176         }\r
177     }\r
178 \r
179     /**\r
180      * DOCUMENT ME!\r
181      *\r
182      * @param horizontal DOCUMENT ME!\r
183      * @param vertical DOCUMENT ME!\r
184      */\r
185     public void fastPaint(int horizontal, int vertical)\r
186     {\r
187         if (((horizontal == 0) && (vertical == 0)) || (gg == null))\r
188         {\r
189             return;\r
190         }\r
191 \r
192         gg.copyArea(0, 0, imgWidth, imgHeight, -horizontal * av.charWidth,\r
193             -vertical * av.charHeight);\r
194 \r
195         int sr = av.startRes;\r
196         int er = av.endRes;\r
197         int ss = av.startSeq;\r
198         int es = av.endSeq;\r
199         int transX = 0;\r
200         int transY = 0;\r
201 \r
202         if (horizontal > 0) // scrollbar pulled right, image to the left\r
203         {\r
204             transX = (er - sr - horizontal) * av.charWidth;\r
205             sr = er - horizontal;\r
206         }\r
207         else if (horizontal < 0)\r
208         {\r
209             er = sr - horizontal;\r
210         }\r
211         else if (vertical > 0) // scroll down\r
212         {\r
213             ss = es - vertical;\r
214 \r
215             if (ss < av.startSeq)\r
216             { // ie scrolling too fast, more than a page at a time\r
217                 ss = av.startSeq;\r
218             }\r
219             else\r
220             {\r
221                 transY = imgHeight - (vertical * av.charHeight);\r
222             }\r
223         }\r
224         else if (vertical < 0)\r
225         {\r
226             es = ss - vertical;\r
227 \r
228             if (es > av.endSeq)\r
229             {\r
230                 es = av.endSeq;\r
231             }\r
232         }\r
233 \r
234         gg.translate(transX, transY);\r
235 \r
236         gg.setColor(Color.white);\r
237         gg.fillRect(0, 0, (er - sr + 1) * av.charWidth,\r
238             (es - ss) * av.charHeight);\r
239         drawPanel(gg, sr, er, ss, es, sr, ss, 0);\r
240         gg.translate(-transX, -transY);\r
241 \r
242         fastPaint = true;\r
243         repaint();\r
244     }\r
245 \r
246     /**\r
247      * Definitions of startx and endx (hopefully):\r
248      * SMJS This is what I'm working towards!\r
249      *   startx is the first residue (starting at 0) to display.\r
250      *   endx   is the last residue to display (starting at 0).\r
251      *   starty is the first sequence to display (starting at 0).\r
252      *   endy   is the last sequence to display (starting at 0).\r
253      * NOTE 1: The av limits are set in setFont in this class and\r
254      * in the adjustment listener in SeqPanel when the scrollbars move.\r
255      */\r
256 \r
257     // Set this to false to force a full panel paint\r
258     public void paintComponent(Graphics g)\r
259     {\r
260         if ((img != null) &&\r
261                 (fastPaint || (getWidth() != g.getClipBounds().width) ||\r
262                 (getHeight() != g.getClipBounds().height)))\r
263         {\r
264             g.drawImage(img, 0, 0, this);\r
265             fastPaint = false;\r
266 \r
267             return;\r
268         }\r
269 \r
270         // this draws the whole of the alignment\r
271         imgWidth = getWidth();\r
272         imgHeight = getHeight();\r
273 \r
274         imgWidth -= (imgWidth % av.charWidth);\r
275         imgHeight -= (imgHeight % av.charHeight);\r
276 \r
277         if ((imgWidth < 1) || (imgHeight < 1))\r
278         {\r
279             return;\r
280         }\r
281 \r
282         img = new BufferedImage(imgWidth, imgHeight, BufferedImage.TYPE_INT_RGB);\r
283         gg = (Graphics2D) img.getGraphics();\r
284         gg.setFont(av.getFont());\r
285         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,\r
286             RenderingHints.VALUE_ANTIALIAS_ON);\r
287 \r
288         gg.setColor(Color.white);\r
289         gg.fillRect(0, 0, imgWidth, imgHeight);\r
290 \r
291         chunkWidth = getWrappedCanvasWidth(getWidth());\r
292         chunkHeight = (av.getAlignment().getHeight() + 2) * av.charHeight;\r
293 \r
294         av.setChunkHeight(chunkHeight);\r
295         av.setChunkWidth(chunkWidth);\r
296 \r
297         if (av.getWrapAlignment())\r
298         {\r
299             drawWrappedPanel(gg, getWidth(), getHeight(), av.startRes);\r
300         }\r
301         else\r
302         {\r
303             drawPanel(gg, av.startRes, av.endRes, av.startSeq, av.endSeq,\r
304                 av.startRes, av.startSeq, 0);\r
305         }\r
306 \r
307         g.drawImage(img, 0, 0, this);\r
308     }\r
309 \r
310     /**\r
311      * DOCUMENT ME!\r
312      *\r
313      * @param cwidth DOCUMENT ME!\r
314      *\r
315      * @return DOCUMENT ME!\r
316      */\r
317     public int getWrappedCanvasWidth(int cwidth)\r
318     {\r
319         FontMetrics fm = getFontMetrics(av.getFont());\r
320 \r
321         LABEL_EAST = 0;\r
322         LABEL_WEST = 0;\r
323 \r
324         if (av.scaleRightWrapped)\r
325         {\r
326             LABEL_EAST = fm.stringWidth(getMask()+"0");\r
327         }\r
328 \r
329         if (av.scaleLeftWrapped)\r
330         {\r
331             LABEL_WEST = fm.stringWidth(getMask());\r
332         }\r
333 \r
334         return (cwidth - LABEL_EAST - LABEL_WEST) / av.charWidth;\r
335     }\r
336 \r
337 \r
338     /**\r
339      * Generates a string of zeroes.\r
340      * @return String\r
341      */\r
342     String getMask()\r
343     {\r
344       String mask = "0";\r
345       for (int i = av.alignment.getWidth(); i > 0; i /= 10)\r
346       {\r
347         mask += "0";\r
348       }\r
349       return mask;\r
350     }\r
351 \r
352     /**\r
353      * DOCUMENT ME!\r
354      *\r
355      * @param g DOCUMENT ME!\r
356      * @param canvasWidth DOCUMENT ME!\r
357      * @param canvasHeight DOCUMENT ME!\r
358      * @param startRes DOCUMENT ME!\r
359      */\r
360     public void drawWrappedPanel(Graphics g, int canvasWidth, int canvasHeight,\r
361         int startRes)\r
362     {\r
363 \r
364         AlignmentI al = av.getAlignment();\r
365 \r
366         FontMetrics fm = getFontMetrics(av.getFont());\r
367 \r
368         int LABEL_EAST = 0;\r
369 \r
370         if (av.scaleRightWrapped)\r
371         {\r
372             LABEL_EAST = fm.stringWidth(getMask()+"0");\r
373         }\r
374 \r
375         int LABEL_WEST = 0;\r
376 \r
377         if (av.scaleLeftWrapped)\r
378         {\r
379             LABEL_WEST = fm.stringWidth(getMask());\r
380         }\r
381 \r
382         int cWidth = (canvasWidth - LABEL_EAST - LABEL_WEST) / av.charWidth;\r
383         int cHeight = (av.getAlignment().getHeight() + 2) * av.charHeight;\r
384 \r
385         av.endRes = av.startRes + cWidth;\r
386 \r
387         int endx = (startRes + cWidth) - 1;\r
388         int ypos = 2 * av.charHeight;\r
389 \r
390         while ((ypos <= canvasHeight) && (startRes < av.alignment.getWidth()))\r
391         {\r
392             g.setColor(Color.black);\r
393 \r
394             if (av.scaleLeftWrapped)\r
395             {\r
396                 drawWestScale(g, startRes, endx, ypos);\r
397             }\r
398 \r
399             if (av.scaleRightWrapped)\r
400             {\r
401                 g.translate(canvasWidth - LABEL_EAST, 0);\r
402                 drawEastScale(g, startRes, endx, ypos);\r
403                 g.translate(-(canvasWidth - LABEL_EAST), 0);\r
404             }\r
405 \r
406             g.translate(LABEL_WEST, 0);\r
407 \r
408             if (av.scaleAboveWrapped)\r
409             {\r
410                 drawNorthScale(g, startRes, endx, ypos);\r
411             }\r
412 \r
413             // When printing we have an extra clipped region,\r
414             // the Printable page which we need to account for here\r
415             Shape clip = g.getClip();\r
416 \r
417             if (clip == null)\r
418             {\r
419                 g.setClip(0, 0, cWidth * av.charWidth, canvasHeight);\r
420             }\r
421             else\r
422             {\r
423                 g.setClip(0, (int) clip.getBounds().getY(),\r
424                     cWidth * av.charWidth, (int) clip.getBounds().getHeight());\r
425             }\r
426 \r
427             drawPanel(g, startRes, endx, 0, al.getHeight(), startRes, 0, ypos);\r
428             g.setClip(clip);\r
429             g.translate(-LABEL_WEST, 0);\r
430 \r
431             ypos += cHeight;\r
432             startRes += cWidth;\r
433             endx = (startRes + cWidth) - 1;\r
434 \r
435             if (endx > al.getWidth())\r
436             {\r
437                 endx = al.getWidth();\r
438             }\r
439         }\r
440     }\r
441 \r
442     /**\r
443      * DOCUMENT ME!\r
444      *\r
445      * @param g1 DOCUMENT ME!\r
446      * @param x1 DOCUMENT ME!\r
447      * @param x2 DOCUMENT ME!\r
448      * @param y1 DOCUMENT ME!\r
449      * @param y2 DOCUMENT ME!\r
450      * @param startx DOCUMENT ME!\r
451      * @param starty DOCUMENT ME!\r
452      * @param offset DOCUMENT ME!\r
453      */\r
454     synchronized public void drawPanel(Graphics g1, int x1, int x2, int y1,\r
455         int y2, int startx, int starty, int offset)\r
456     {\r
457         Graphics2D g = (Graphics2D) g1;\r
458         g.setFont(av.getFont());\r
459         sr.renderGaps(av.renderGaps);\r
460 \r
461         SequenceI nextSeq;\r
462 \r
463         /// First draw the sequences\r
464         /////////////////////////////\r
465         for (int i = y1; i < y2; i++)\r
466         {\r
467             nextSeq = av.alignment.getSequenceAt(i);\r
468 \r
469             sr.drawSequence(g, nextSeq, av.alignment.findAllGroups(nextSeq),\r
470                 x1, x2, (x1 - startx) * av.charWidth,\r
471                 offset + ((i - starty) * av.charHeight), av.charWidth,\r
472                 av.charHeight);\r
473 \r
474             if (av.showSequenceFeatures)\r
475             {\r
476                 fr.drawSequence(g, nextSeq,\r
477                     av.alignment.findAllGroups(nextSeq), x1, x2,\r
478                     (x1 - startx) * av.charWidth,\r
479                     offset + ((i - starty) * av.charHeight), av.charWidth,\r
480                     av.charHeight);\r
481             }\r
482         }\r
483 \r
484         //\r
485         /////////////////////////////////////\r
486         // Now outline any areas if necessary\r
487         /////////////////////////////////////\r
488         SequenceGroup group = av.getSelectionGroup();\r
489         java.util.Vector groups = av.alignment.getGroups();\r
490 \r
491         int sx = -1;\r
492         int sy = -1;\r
493         int ex = -1;\r
494         int groupIndex = -1;\r
495 \r
496         if ((group == null) && (groups.size() > 0))\r
497         {\r
498             group = (SequenceGroup) groups.elementAt(0);\r
499             groupIndex = 0;\r
500         }\r
501 \r
502 \r
503         if (group != null)\r
504         {\r
505             do\r
506             {\r
507                 int oldY = -1;\r
508                 int i = 0;\r
509                 boolean inGroup = false;\r
510                 int top = -1;\r
511                 int bottom = -1;\r
512 \r
513                 for (i = y1; i < y2; i++)\r
514                 {\r
515                     sx = (group.getStartRes() - startx) * av.charWidth;\r
516                     sy = offset + ((i - starty) * av.charHeight);\r
517                     ex = (((group.getEndRes() + 1) - group.getStartRes()) * av.charWidth) -\r
518                         1;\r
519 \r
520 \r
521                     if ((sx < (x2-x1)*av.charWidth) &&\r
522                             group.sequences.contains(av.alignment.getSequenceAt(\r
523                                     i)))\r
524                     {\r
525                         if ((bottom == -1) &&\r
526                                 !group.sequences.contains(\r
527                                     av.alignment.getSequenceAt(i + 1)))\r
528                         {\r
529                             bottom = sy + av.charHeight;\r
530                         }\r
531 \r
532                         if (!inGroup)\r
533                         {\r
534                             if (((top == -1) && (i == 0)) ||\r
535                                     !group.sequences.contains(\r
536                                         av.alignment.getSequenceAt(i - 1)))\r
537                             {\r
538                                 top = sy;\r
539                             }\r
540 \r
541                             oldY = sy;\r
542                             inGroup = true;\r
543 \r
544                             if (group == av.getSelectionGroup())\r
545                             {\r
546                                 g.setStroke(new BasicStroke(1,\r
547                                         BasicStroke.CAP_BUTT,\r
548                                         BasicStroke.JOIN_ROUND, 3f,\r
549                                         new float[] { 5f, 3f }, 0f));\r
550                                 g.setColor(Color.RED);\r
551                             }\r
552                             else\r
553                             {\r
554                                 g.setStroke(new BasicStroke());\r
555                                 g.setColor(group.getOutlineColour());\r
556                             }\r
557                         }\r
558                     }\r
559                     else\r
560                     {\r
561                         if (inGroup)\r
562                         {\r
563                             g.drawLine(sx, oldY, sx, sy);\r
564                             g.drawLine(sx + ex, oldY, sx + ex, sy);\r
565 \r
566                             if (top != -1)\r
567                             {\r
568                                 g.drawLine(sx, top, sx + ex, top);\r
569                                 top = -1;\r
570                             }\r
571 \r
572                             if (bottom != -1)\r
573                             {\r
574                                 g.drawLine(sx, bottom, sx + ex, bottom);\r
575                                 bottom = -1;\r
576                             }\r
577 \r
578                             inGroup = false;\r
579                         }\r
580                     }\r
581                 }\r
582 \r
583 \r
584                 if (inGroup)\r
585                 {\r
586                     if (top != -1)\r
587                     {\r
588                         g.drawLine(sx, top, sx + ex, top);\r
589                         top = -1;\r
590                     }\r
591 \r
592                     if (bottom != -1)\r
593                     {\r
594                         g.drawLine(sx, bottom - 1, sx + ex, bottom - 1);\r
595                         bottom = -1;\r
596                     }\r
597 \r
598                     sy = offset + ((i - starty) * av.charHeight);\r
599                     g.drawLine(sx, oldY, sx, sy);\r
600                     g.drawLine(sx + ex, oldY, sx + ex, sy);\r
601                     inGroup = false;\r
602                 }\r
603 \r
604                 groupIndex++;\r
605 \r
606                 if (groupIndex >= groups.size())\r
607                 {\r
608                     break;\r
609                 }\r
610 \r
611                 group = (SequenceGroup) groups.elementAt(groupIndex);\r
612             }\r
613             while (groupIndex < groups.size());\r
614         }\r
615 \r
616         /// Highlight search Results once all sequences have been drawn\r
617         //////////////////////////////////////////////////////////\r
618         if (displaySearch)\r
619         {\r
620             for (int r = 0; r < searchResults.length; r += 3)\r
621             {\r
622                 int searchSeq = searchResults[r];\r
623 \r
624                 if ((searchSeq >= y1) && (searchSeq < y2))\r
625                 {\r
626                     SequenceI seq = av.getAlignment().getSequenceAt(searchSeq);\r
627 \r
628                     int searchStart = seq.findIndex(searchResults[r + 1]) - 1;\r
629                     int searchEnd = seq.findIndex(searchResults[r + 2]) - 1;\r
630 \r
631                     SequenceRenderer ssr = (SequenceRenderer) sr;\r
632 \r
633                     if (searchStart < x1)\r
634                     {\r
635                         searchStart = x1;\r
636                     }\r
637 \r
638                     if (searchEnd > x2)\r
639                     {\r
640                         searchEnd = x2;\r
641                     }\r
642 \r
643                     ssr.drawHighlightedText(seq, searchStart, searchEnd,\r
644                         (searchStart - startx) * av.charWidth,\r
645                         offset + ((searchSeq - starty) * av.charHeight),\r
646                         av.charWidth, av.charHeight);\r
647                 }\r
648             }\r
649         }\r
650     }\r
651 \r
652     /**\r
653      * DOCUMENT ME!\r
654      *\r
655      * @param results DOCUMENT ME!\r
656      */\r
657     public void highlightSearchResults(int[] results)\r
658     {\r
659         // results are in the order sequence, startRes, endRes\r
660         if (results == null)\r
661         {\r
662             displaySearch = false;\r
663         }\r
664         else\r
665         {\r
666             displaySearch = true;\r
667         }\r
668 \r
669         searchResults = results;\r
670 \r
671         repaint();\r
672     }\r
673 }\r