Wrap alignment with annotations
[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     boolean fastPaint = false;\r
47     int LABEL_WEST;\r
48     int LABEL_EAST;\r
49 \r
50     boolean isOverview = false;\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 (gg == null)\r
188         {\r
189             return;\r
190         }\r
191 \r
192         gg.copyArea(horizontal * av.charWidth,\r
193                     vertical * av.charHeight,\r
194                     imgWidth,\r
195                     imgHeight,\r
196                     -horizontal * av.charWidth,\r
197                     -vertical * av.charHeight);\r
198 \r
199         int sr = av.startRes;\r
200         int er = av.endRes;\r
201         int ss = av.startSeq;\r
202         int es = av.endSeq;\r
203         int transX = 0;\r
204         int transY = 0;\r
205 \r
206         if (horizontal > 0) // scrollbar pulled right, image to the left\r
207         {\r
208             er ++;\r
209             transX = (er - sr - horizontal) * av.charWidth;\r
210             sr = er - horizontal;\r
211         }\r
212         else if (horizontal < 0)\r
213         {\r
214             er = sr - horizontal-1;\r
215         }\r
216         else if (vertical > 0) // scroll down\r
217         {\r
218             ss = es - vertical;\r
219 \r
220             if (ss < av.startSeq)\r
221             { // ie scrolling too fast, more than a page at a time\r
222                 ss = av.startSeq;\r
223             }\r
224             else\r
225             {\r
226                 transY = imgHeight - (vertical * av.charHeight);\r
227             }\r
228         }\r
229         else if (vertical < 0)\r
230         {\r
231             es = ss - vertical;\r
232 \r
233             if (es > av.endSeq)\r
234             {\r
235                 es = av.endSeq;\r
236             }\r
237         }\r
238 \r
239         gg.translate(transX, transY);\r
240         drawPanel(gg, sr, er, ss, es, sr, ss, 0);\r
241         gg.translate(-transX, -transY);\r
242 \r
243         fastPaint = true;\r
244         repaint();\r
245     }\r
246 \r
247     /**\r
248      * Definitions of startx and endx (hopefully):\r
249      * SMJS This is what I'm working towards!\r
250      *   startx is the first residue (starting at 0) to display.\r
251      *   endx   is the last residue to display (starting at 0).\r
252      *   starty is the first sequence to display (starting at 0).\r
253      *   endy   is the last sequence to display (starting at 0).\r
254      * NOTE 1: The av limits are set in setFont in this class and\r
255      * in the adjustment listener in SeqPanel when the scrollbars move.\r
256      */\r
257 \r
258     // Set this to false to force a full panel paint\r
259     public void paintComponent(Graphics g)\r
260     {\r
261         sr.renderGaps(av.renderGaps);\r
262 \r
263         if ((img != null) &&\r
264                 (fastPaint || (getWidth() != g.getClipBounds().width) ||\r
265                 (getHeight() != g.getClipBounds().height)))\r
266         {\r
267             g.drawImage(img, 0, 0, this);\r
268             fastPaint = false;\r
269 \r
270             return;\r
271         }\r
272 \r
273         // this draws the whole of the alignment\r
274         imgWidth = getWidth();\r
275         imgHeight = getHeight();\r
276 \r
277         imgWidth -= (imgWidth % av.charWidth);\r
278         imgHeight -= (imgHeight % av.charHeight);\r
279 \r
280         if ((imgWidth < 1) || (imgHeight < 1))\r
281         {\r
282             return;\r
283         }\r
284 \r
285 \r
286         img = new BufferedImage(imgWidth, imgHeight, BufferedImage.TYPE_INT_RGB);\r
287         gg = (Graphics2D) img.getGraphics();\r
288         gg.setFont(av.getFont());\r
289         gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,\r
290           RenderingHints.VALUE_ANTIALIAS_ON);\r
291 \r
292         gg.setColor(Color.white);\r
293         gg.fillRect(0, 0, imgWidth, imgHeight);\r
294 \r
295 \r
296         if (av.getWrapAlignment())\r
297         {\r
298             drawWrappedPanel(gg, getWidth(), getHeight(), av.startRes);\r
299         }\r
300         else\r
301         {\r
302             drawPanel(gg, av.startRes, av.endRes, av.startSeq, av.endSeq,\r
303                 av.startRes, av.startSeq, 0);\r
304         }\r
305 \r
306         g.drawImage(img, 0, 0, this);\r
307     }\r
308 \r
309     /**\r
310      * DOCUMENT ME!\r
311      *\r
312      * @param cwidth DOCUMENT ME!\r
313      *\r
314      * @return DOCUMENT ME!\r
315      */\r
316     public int getWrappedCanvasWidth(int cwidth)\r
317     {\r
318         FontMetrics fm = getFontMetrics(av.getFont());\r
319 \r
320         LABEL_EAST = 0;\r
321         LABEL_WEST = 0;\r
322 \r
323         if (av.scaleRightWrapped)\r
324         {\r
325             LABEL_EAST = fm.stringWidth(getMask()+"0");\r
326         }\r
327 \r
328         if (av.scaleLeftWrapped)\r
329         {\r
330             LABEL_WEST = fm.stringWidth(getMask());\r
331         }\r
332 \r
333         return (cwidth - LABEL_EAST - LABEL_WEST) / av.charWidth;\r
334     }\r
335 \r
336 \r
337     /**\r
338      * Generates a string of zeroes.\r
339      * @return String\r
340      */\r
341     String getMask()\r
342     {\r
343       String mask = "0";\r
344       for (int i = av.alignment.getWidth(); i > 0; i /= 10)\r
345       {\r
346         mask += "0";\r
347       }\r
348       return mask;\r
349     }\r
350 \r
351     /**\r
352      * DOCUMENT ME!\r
353      *\r
354      * @param g DOCUMENT ME!\r
355      * @param canvasWidth DOCUMENT ME!\r
356      * @param canvasHeight DOCUMENT ME!\r
357      * @param startRes DOCUMENT ME!\r
358      */\r
359     public void drawWrappedPanel(Graphics g, int canvasWidth, int canvasHeight,\r
360         int startRes)\r
361     {\r
362 \r
363         AlignmentI al = av.getAlignment();\r
364 \r
365         FontMetrics fm = getFontMetrics(av.getFont());\r
366 \r
367         int LABEL_EAST = 0;\r
368 \r
369         if (av.scaleRightWrapped)\r
370         {\r
371             LABEL_EAST = fm.stringWidth(getMask()+"0");\r
372         }\r
373 \r
374         int LABEL_WEST = 0;\r
375 \r
376         if (av.scaleLeftWrapped)\r
377         {\r
378             LABEL_WEST = fm.stringWidth(getMask());\r
379         }\r
380 \r
381         int hgap = av.charHeight;\r
382         if(av.scaleAboveWrapped)\r
383           hgap += av.charHeight;\r
384 \r
385         int cWidth = (canvasWidth - LABEL_EAST - LABEL_WEST) / av.charWidth;\r
386         int cHeight = av.getAlignment().getHeight() * av.charHeight;\r
387 \r
388         av.setWrappedWidth(cWidth);\r
389 \r
390         av.endRes = av.startRes + cWidth;\r
391 \r
392 \r
393         int endx = (startRes + cWidth) - 1;\r
394         int ypos = hgap;\r
395 \r
396 \r
397         while ((ypos <= canvasHeight) && (startRes < av.alignment.getWidth()))\r
398         {\r
399             g.setColor(Color.black);\r
400 \r
401             if (av.scaleLeftWrapped)\r
402             {\r
403                 drawWestScale(g, startRes, endx, ypos);\r
404             }\r
405 \r
406             if (av.scaleRightWrapped)\r
407             {\r
408                 g.translate(canvasWidth - LABEL_EAST, 0);\r
409                 drawEastScale(g, startRes, endx, ypos);\r
410                 g.translate(-(canvasWidth - LABEL_EAST), 0);\r
411             }\r
412 \r
413             g.translate(LABEL_WEST, 0);\r
414 \r
415             if (av.scaleAboveWrapped)\r
416             {\r
417                 drawNorthScale(g, startRes, endx, ypos);\r
418             }\r
419 \r
420             // When printing we have an extra clipped region,\r
421             // the Printable page which we need to account for here\r
422             Shape clip = g.getClip();\r
423 \r
424             if (clip == null)\r
425             {\r
426                 g.setClip(0, 0, cWidth * av.charWidth, canvasHeight);\r
427             }\r
428             else\r
429             {\r
430                 g.setClip(0, (int) clip.getBounds().getY(),\r
431                     cWidth * av.charWidth, (int) clip.getBounds().getHeight());\r
432             }\r
433 \r
434             if (av.vconsensus!=null && av.alignment.getWidth() >= av.vconsensus.size())\r
435             {\r
436               endx = av.vconsensus.size() - 2;\r
437             }\r
438 \r
439 \r
440             drawPanel(g, startRes, endx, 0, al.getHeight(), startRes, 0, ypos);\r
441 \r
442             if(av.showAnnotation)\r
443             {\r
444               g.translate(0, cHeight + ypos + 3);\r
445               if(annotations==null)\r
446                 annotations = new AnnotationPanel(av);\r
447 \r
448               annotations.drawComponent( (Graphics2D) g, startRes, endx + 1);\r
449               g.translate(0, -cHeight - ypos);\r
450             }\r
451             g.setClip(clip);\r
452             g.translate(-LABEL_WEST, 0);\r
453 \r
454             ypos += cHeight+getAnnotationHeight()+hgap;\r
455             if(av.showAnnotation)\r
456               ypos -= 3;\r
457 \r
458             startRes += cWidth;\r
459             endx = (startRes + cWidth) - 1;\r
460 \r
461             if (endx > al.getWidth())\r
462             {\r
463                 endx = al.getWidth();\r
464             }\r
465         }\r
466     }\r
467 \r
468     AnnotationPanel annotations;\r
469     int getAnnotationHeight()\r
470     {\r
471       if(!av.showAnnotation)\r
472         return 0;\r
473 \r
474       if(annotations==null)\r
475         annotations = new AnnotationPanel(av);\r
476 \r
477       return annotations.adjustPanelHeight();\r
478     }\r
479 \r
480     /**\r
481      * DOCUMENT ME!\r
482      *\r
483      * @param g1 DOCUMENT ME!\r
484      * @param x1 DOCUMENT ME!\r
485      * @param x2 DOCUMENT ME!\r
486      * @param y1 DOCUMENT ME!\r
487      * @param y2 DOCUMENT ME!\r
488      * @param startx DOCUMENT ME!\r
489      * @param starty DOCUMENT ME!\r
490      * @param offset DOCUMENT ME!\r
491      */\r
492     synchronized public void drawPanel(Graphics g1, int x1, int x2, int y1,\r
493         int y2, int startx, int starty, int offset)\r
494     {\r
495         Graphics2D g = (Graphics2D) g1;\r
496         g.setFont(av.getFont());\r
497 \r
498         SequenceI nextSeq;\r
499 \r
500         /// First draw the sequences\r
501         /////////////////////////////\r
502         for (int i = y1; i < y2; i++)\r
503         {\r
504             nextSeq = av.alignment.getSequenceAt(i);\r
505 \r
506             sr.drawSequence(g, nextSeq, av.alignment.findAllGroups(nextSeq),\r
507                 x1, x2, (x1 - startx) * av.charWidth,\r
508                 offset + ((i - starty) * av.charHeight), av.charWidth,\r
509                 av.charHeight);\r
510 \r
511             if (av.showSequenceFeatures)\r
512             {\r
513                 fr.drawSequence(g, nextSeq,\r
514                     av.alignment.findAllGroups(nextSeq), x1, x2,\r
515                     (x1 - startx) * av.charWidth,\r
516                     offset + ((i - starty) * av.charHeight), av.charWidth,\r
517                     av.charHeight);\r
518             }\r
519         }\r
520 \r
521         //\r
522         /////////////////////////////////////\r
523         // Now outline any areas if necessary\r
524         /////////////////////////////////////\r
525         SequenceGroup group = av.getSelectionGroup();\r
526         java.util.Vector groups = av.alignment.getGroups();\r
527 \r
528         int sx = -1;\r
529         int sy = -1;\r
530         int ex = -1;\r
531         int groupIndex = -1;\r
532 \r
533         if ((group == null) && (groups.size() > 0))\r
534         {\r
535             group = (SequenceGroup) groups.elementAt(0);\r
536             groupIndex = 0;\r
537         }\r
538 \r
539 \r
540         if (group != null && !isOverview)\r
541         {\r
542             do\r
543             {\r
544                 int oldY = -1;\r
545                 int i = 0;\r
546                 boolean inGroup = false;\r
547                 int top = -1;\r
548                 int bottom = -1;\r
549 \r
550                 for (i = y1; i < y2; i++)\r
551                 {\r
552                     sx = (group.getStartRes() - startx) * av.charWidth;\r
553                     sy = offset + ((i - starty) * av.charHeight);\r
554                     ex = (((group.getEndRes() + 1) - group.getStartRes()) * av.charWidth) -\r
555                         1;\r
556 \r
557                     if(sx+ex<0 || sx>imgWidth)\r
558                     {\r
559                       continue;\r
560                     }\r
561 \r
562                     if ( (sx <= (x2-x1)*av.charWidth) &&\r
563                             group.sequences.contains(av.alignment.getSequenceAt(\r
564                                     i)))\r
565                     {\r
566                         if ((bottom == -1) &&\r
567                                 !group.sequences.contains(\r
568                                     av.alignment.getSequenceAt(i + 1)))\r
569                         {\r
570                             bottom = sy + av.charHeight;\r
571                         }\r
572 \r
573                         if (!inGroup)\r
574                         {\r
575                             if (((top == -1) && (i == 0)) ||\r
576                                     !group.sequences.contains(\r
577                                         av.alignment.getSequenceAt(i - 1)))\r
578                             {\r
579                                 top = sy;\r
580                             }\r
581 \r
582                             oldY = sy;\r
583                             inGroup = true;\r
584 \r
585                             if (group == av.getSelectionGroup())\r
586                             {\r
587                                 g.setStroke(new BasicStroke(1,\r
588                                         BasicStroke.CAP_BUTT,\r
589                                         BasicStroke.JOIN_ROUND, 3f,\r
590                                         new float[] { 5f, 3f }, 0f));\r
591                                 g.setColor(Color.RED);\r
592                             }\r
593                             else\r
594                             {\r
595                                 g.setStroke(new BasicStroke());\r
596                                 g.setColor(group.getOutlineColour());\r
597                             }\r
598                         }\r
599                     }\r
600                     else\r
601                     {\r
602                       if (inGroup)\r
603                       {\r
604                         if (sx >= 0 && sx < imgWidth)\r
605                           g.drawLine(sx, oldY, sx, sy);\r
606 \r
607                         if (sx + ex < imgWidth)\r
608                           g.drawLine(sx + ex, oldY, sx + ex, sy);\r
609 \r
610                         if (sx < 0)\r
611                         {\r
612                           ex += sx;\r
613                           sx = 0;\r
614                         }\r
615 \r
616                         if (sx + ex > imgWidth)\r
617                           ex = imgWidth;\r
618 \r
619                         else if (sx + ex >= (x2 - x1 + 1) * av.charWidth)\r
620                           ex = (x2 - x1 + 1) * av.charWidth;\r
621 \r
622                         if (top != -1)\r
623                         {\r
624                           g.drawLine(sx, top, sx + ex, top);\r
625                           top = -1;\r
626                         }\r
627 \r
628                         if (bottom != -1)\r
629                         {\r
630                           g.drawLine(sx, bottom, sx + ex, bottom);\r
631                           bottom = -1;\r
632                         }\r
633 \r
634                         inGroup = false;\r
635                         }\r
636                     }\r
637                 }\r
638 \r
639                 if (inGroup)\r
640                 {\r
641                   sy = offset + ( (i - starty) * av.charHeight);\r
642                   if (sx >= 0 && sx < imgWidth)\r
643                     g.drawLine(sx, oldY, sx, sy);\r
644 \r
645                   if (sx + ex < imgWidth)\r
646                     g.drawLine(sx + ex, oldY, sx + ex, sy);\r
647 \r
648                   if (sx < 0)\r
649                   {\r
650                     ex += sx;\r
651                     sx = 0;\r
652                   }\r
653 \r
654                   if (sx + ex > imgWidth)\r
655                     ex = imgWidth;\r
656                   else if (sx + ex >= (x2 - x1 + 1) * av.charWidth)\r
657                     ex = (x2 - x1 + 1) * av.charWidth;\r
658 \r
659                   if (top != -1)\r
660                   {\r
661                     g.drawLine(sx, top, sx + ex, top);\r
662                     top = -1;\r
663                   }\r
664 \r
665                   if (bottom != -1)\r
666                   {\r
667                     g.drawLine(sx, bottom - 1, sx + ex, bottom - 1);\r
668                     bottom = -1;\r
669                   }\r
670 \r
671                     inGroup = false;\r
672                 }\r
673 \r
674                 groupIndex++;\r
675 \r
676                 if (groupIndex >= groups.size())\r
677                 {\r
678                     break;\r
679                 }\r
680 \r
681                 group = (SequenceGroup) groups.elementAt(groupIndex);\r
682             }\r
683             while (groupIndex < groups.size());\r
684         }\r
685 \r
686         /// Highlight search Results once all sequences have been drawn\r
687         //////////////////////////////////////////////////////////\r
688         if (displaySearch)\r
689         {\r
690             for (int r = 0; r < searchResults.length; r += 3)\r
691             {\r
692                 int searchSeq = searchResults[r];\r
693 \r
694                 if ((searchSeq >= y1) && (searchSeq < y2))\r
695                 {\r
696                     SequenceI seq = av.getAlignment().getSequenceAt(searchSeq);\r
697 \r
698                     int searchStart = seq.findIndex(searchResults[r + 1]) - 1;\r
699                     int searchEnd = seq.findIndex(searchResults[r + 2]) - 1;\r
700 \r
701                     SequenceRenderer ssr = (SequenceRenderer) sr;\r
702 \r
703                     if (searchStart < x1)\r
704                     {\r
705                         searchStart = x1;\r
706                     }\r
707 \r
708                     if (searchEnd > x2)\r
709                     {\r
710                         searchEnd = x2;\r
711                     }\r
712 \r
713                     ssr.drawHighlightedText(seq, searchStart, searchEnd,\r
714                         (searchStart - startx) * av.charWidth,\r
715                         offset + ((searchSeq - starty) * av.charHeight),\r
716                         av.charWidth, av.charHeight);\r
717                 }\r
718             }\r
719         }\r
720     }\r
721 \r
722     /**\r
723      * DOCUMENT ME!\r
724      *\r
725      * @param results DOCUMENT ME!\r
726      */\r
727     public void highlightSearchResults(int[] results)\r
728     {\r
729         // results are in the order sequence, startRes, endRes\r
730         if (results == null)\r
731         {\r
732             displaySearch = false;\r
733         }\r
734         else\r
735         {\r
736             displaySearch = true;\r
737         }\r
738 \r
739         searchResults = results;\r
740 \r
741         repaint();\r
742     }\r
743 }\r