added placeholder indicators and menu item
[jalview.git] / src / jalview / gui / SeqCanvas.java
1 package jalview.gui;\r
2 \r
3 import java.awt.*;\r
4 import java.awt.image.*;\r
5 import javax.swing.*;\r
6 import jalview.datamodel.*;\r
7 import jalview.analysis.*;\r
8 \r
9 \r
10 public class SeqCanvas extends JComponent\r
11 {\r
12      FeatureRenderer fr;\r
13      SequenceRenderer sr;\r
14     BufferedImage             img;\r
15     Graphics2D          gg;\r
16     int               imgWidth;\r
17     int               imgHeight;\r
18 \r
19     AlignViewport     av;\r
20 \r
21     boolean showScores = false;\r
22     boolean displaySearch = false;\r
23     int [] searchResults = null;\r
24 \r
25     int chunkHeight;\r
26     int chunkWidth;\r
27 \r
28     boolean fastPaint = false;\r
29 \r
30 \r
31     public SeqCanvas(AlignViewport av)\r
32     {\r
33         this.av         = av;\r
34        fr = new FeatureRenderer(av);\r
35        sr = new SequenceRenderer(av);\r
36        setLayout(new BorderLayout());\r
37        PaintRefresher.Register(this);\r
38 \r
39     }\r
40 \r
41   void drawNorthScale(Graphics g, int startx, int endx,int ypos) {\r
42     int scalestartx = startx - startx % 10 + 10;\r
43 \r
44     g.setColor(Color.black);\r
45 \r
46     // NORTH SCALE\r
47     for (int i = scalestartx; i < endx; i += 10)\r
48     {\r
49       String string = String.valueOf(i);\r
50       g.drawString(string, (i - startx - 1) * av.charWidth,\r
51                    ypos - av.charHeight / 2);\r
52 \r
53       g.drawLine( (i - startx - 1) * av.charWidth + av.charWidth / 2,\r
54                  ypos + 2 - av.charHeight / 2,\r
55                  (i - startx - 1) * av.charWidth + av.charWidth / 2, ypos - 2);\r
56 \r
57     }\r
58   }\r
59 \r
60   void drawWestScale(Graphics g, int startx, int endx, int ypos)\r
61   {\r
62     FontMetrics fm = getFontMetrics(av.getFont());\r
63     ypos+= av.charHeight;\r
64       // EAST SCALE\r
65     for (int i = 0; i < av.alignment.getHeight(); i++)\r
66     {\r
67       SequenceI seq = av.alignment.getSequenceAt(i);\r
68       int index = startx;\r
69       int value = -1;\r
70       while (index < endx)\r
71       {\r
72         if (jalview.util.Comparison.isGap(seq.getCharAt(index)))\r
73         {\r
74           index++;\r
75           continue;\r
76         }\r
77 \r
78         value = av.alignment.getSequenceAt(i).findPosition(index);\r
79         break;\r
80       }\r
81       if(value!=-1)\r
82       {\r
83         int x = LABEL_WEST - fm.stringWidth(value+"");\r
84         g.drawString(value + "", x,  ypos +  i*av.charHeight - av.charHeight/5);\r
85       }\r
86     }\r
87   }\r
88 \r
89   void drawEastScale(Graphics g, int startx, int endx, int ypos)\r
90 {\r
91     ypos+= av.charHeight;\r
92     // EAST SCALE\r
93   for (int i = 0; i < av.alignment.getHeight(); i++)\r
94   {\r
95     SequenceI seq = av.alignment.getSequenceAt(i);\r
96     int index = endx;\r
97     int value = -1;\r
98     while (index > startx)\r
99     {\r
100       if (jalview.util.Comparison.isGap(seq.getCharAt(index)))\r
101       {\r
102         index--;\r
103         continue;\r
104       }\r
105 \r
106       value = av.alignment.getSequenceAt(i).findPosition(index);\r
107       break;\r
108     }\r
109     if(value!=-1)\r
110        g.drawString(value + "", 0,  ypos +  i*av.charHeight - av.charHeight/5);\r
111   }\r
112 \r
113 }\r
114 \r
115 \r
116 \r
117 \r
118 \r
119 public void fastPaint(int horizontal, int vertical)\r
120 {\r
121     if (horizontal == 0 && vertical == 0 || gg==null)\r
122       return;\r
123 \r
124     gg.copyArea(0, 0, imgWidth, imgHeight, -horizontal * av.charWidth,\r
125                 -vertical * av.charHeight);\r
126 \r
127     int sr = av.startRes, er = av.endRes, ss = av.startSeq, es = av.endSeq,\r
128         transX = 0, transY = 0;\r
129     if (horizontal > 0) // scrollbar pulled right, image to the left\r
130     {\r
131       transX = (er - sr - horizontal) * av.charWidth;\r
132       sr = er - horizontal;\r
133     }\r
134     else if (horizontal < 0)\r
135       er = sr - horizontal;\r
136 \r
137     else if (vertical > 0) // scroll down\r
138     {\r
139       ss = es - vertical;\r
140       if(ss<av.startSeq) // ie scrolling too fast, more than a page at a time\r
141         ss = av.startSeq;\r
142       else\r
143         transY = imgHeight - vertical * av.charHeight;\r
144     }\r
145     else if (vertical < 0)\r
146     {\r
147       es = ss - vertical;\r
148       if(es > av.endSeq)\r
149         es = av.endSeq;\r
150     }\r
151 \r
152 \r
153     gg.translate(transX, transY);\r
154 \r
155     gg.setColor(Color.white);\r
156     gg.fillRect(0,0, (er-sr+1)*av.charWidth, (es-ss)*av.charHeight);\r
157     drawPanel(gg, sr, er, ss, es, sr, ss, 0);\r
158     gg.translate( -transX, -transY);\r
159 \r
160     fastPaint = true;\r
161     repaint();\r
162 \r
163 }\r
164 \r
165 /**\r
166  * Definitions of startx and endx (hopefully):\r
167  * SMJS This is what I'm working towards!\r
168  *   startx is the first residue (starting at 0) to display.\r
169  *   endx   is the last residue to display (starting at 0).\r
170  *   starty is the first sequence to display (starting at 0).\r
171  *   endy   is the last sequence to display (starting at 0).\r
172  * NOTE 1: The av limits are set in setFont in this class and\r
173  * in the adjustment listener in SeqPanel when the scrollbars move.\r
174  */\r
175 \r
176   public void paintComponent(Graphics g)\r
177   {\r
178     g.setColor(Color.white);\r
179     g.fillRect(0, 0, getWidth(), getHeight());\r
180 \r
181     if (fastPaint)\r
182     {\r
183       g.drawImage(img, 0, 0, this);\r
184       fastPaint = false;\r
185       return;\r
186     }\r
187 \r
188     // this draws the whole of the alignment\r
189       imgWidth  = getWidth();\r
190       imgHeight = getHeight();\r
191 \r
192       imgWidth -= imgWidth%av.charWidth;\r
193       imgHeight-= imgHeight%av.charHeight;\r
194 \r
195       if(imgWidth<1 || imgHeight<1)\r
196         return;\r
197 \r
198       img = new BufferedImage(imgWidth,imgHeight,BufferedImage.TYPE_INT_RGB);\r
199       gg  = (Graphics2D)img.getGraphics();\r
200       gg.setFont(av.getFont());\r
201       gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,RenderingHints.VALUE_ANTIALIAS_ON);\r
202 \r
203       gg.setColor(Color.white);\r
204       gg.fillRect(0,0,imgWidth,imgHeight);\r
205 \r
206     chunkWidth  =   getWrappedCanvasWidth( getWidth() );\r
207     chunkHeight =  (av.getAlignment().getHeight() + 2)*av.charHeight;\r
208 \r
209     av.setChunkHeight(chunkHeight);\r
210     av.setChunkWidth(chunkWidth);\r
211 \r
212 \r
213     if (av.getWrapAlignment())\r
214       drawWrappedPanel(gg, getWidth(), getHeight(), av.startRes);\r
215     else\r
216       drawPanel(gg, av.startRes, av.endRes, av.startSeq, av.endSeq, av.startRes, av.startSeq, 0);\r
217 \r
218     g.drawImage(img, 0, 0, this);\r
219 \r
220   }\r
221 \r
222   int LABEL_WEST, LABEL_EAST;\r
223   public int getWrappedCanvasWidth(int cwidth)\r
224   {\r
225     FontMetrics fm = getFontMetrics(av.getFont());\r
226 \r
227     LABEL_EAST = 0;\r
228     LABEL_WEST = 0;\r
229 \r
230     if(av.scaleRightWrapped)\r
231       LABEL_EAST = fm.stringWidth( av.alignment.getWidth()+"000" );\r
232 \r
233     if(av.scaleLeftWrapped)\r
234       LABEL_WEST = fm.stringWidth( av.alignment.getWidth()+"" );\r
235 \r
236     return  (cwidth - LABEL_EAST -LABEL_WEST)/av.charWidth;\r
237   }\r
238 \r
239   public void drawWrappedPanel(Graphics g, int canvasWidth, int canvasHeight, int startRes)\r
240   {\r
241       AlignmentI al = av.getAlignment();\r
242 \r
243       FontMetrics fm = getFontMetrics(av.getFont());\r
244 \r
245       int LABEL_EAST = 0;\r
246       if(av.scaleRightWrapped)\r
247         LABEL_EAST = fm.stringWidth( al.getWidth()+"000" );\r
248       int LABEL_WEST = 0;\r
249       if(av.scaleLeftWrapped)\r
250         LABEL_WEST = fm.stringWidth(al.getWidth()+"0");\r
251 \r
252 \r
253       int cWidth  =   (canvasWidth - LABEL_EAST -LABEL_WEST)/av.charWidth;\r
254       int cHeight =  (av.getAlignment().getHeight() + 2)*av.charHeight;\r
255 \r
256       av.endRes = av.startRes + cWidth;\r
257 \r
258       int  endx   = startRes+cWidth-1;\r
259       int  ypos  = 2*av.charHeight;\r
260 \r
261       while (ypos <= canvasHeight && startRes<av.alignment.getWidth() )\r
262       {\r
263         g.setColor(Color.black);\r
264 \r
265         if(av.scaleLeftWrapped)\r
266           drawWestScale(g, startRes, endx, ypos);\r
267 \r
268         if(av.scaleRightWrapped)\r
269         {\r
270           g.translate(canvasWidth - LABEL_EAST +av.charWidth, 0);\r
271           drawEastScale(g, startRes, endx, ypos);\r
272           g.translate( - (canvasWidth - LABEL_EAST+av.charWidth), 0);\r
273         }\r
274 \r
275         g.translate(LABEL_WEST,0);\r
276         if(av.scaleAboveWrapped)\r
277           drawNorthScale(g, startRes, endx, ypos);\r
278 \r
279 \r
280         // When printing we have an extra clipped region,\r
281         // the Printable page which we need to account for here\r
282         Shape clip = g.getClip();\r
283         if(clip==null)\r
284           g.setClip(0, 0, cWidth*av.charWidth, canvasHeight);\r
285         else\r
286           g.setClip(0,\r
287                     (int)clip.getBounds().getY(),\r
288                     cWidth*av.charWidth,\r
289                     (int)clip.getBounds().getHeight()\r
290                     );\r
291 \r
292         drawPanel(g, startRes, endx, 0, al.getHeight(), startRes, 0, ypos);\r
293         g.setClip(clip);\r
294         g.translate(-LABEL_WEST,0);\r
295 \r
296         ypos += cHeight;\r
297         startRes += cWidth;\r
298         endx = startRes + cWidth - 1;\r
299 \r
300         if (endx > al.getWidth())\r
301           endx = al.getWidth();\r
302       }\r
303 \r
304   }\r
305 \r
306 \r
307   synchronized public void drawPanel(Graphics g1,int x1,int x2, int y1, int y2,int startx, int starty,int offset) {\r
308 \r
309     Graphics2D g = (Graphics2D)g1;\r
310     g.setFont(av.getFont());\r
311     sr.renderGaps(av.renderGaps);\r
312 \r
313 \r
314     SequenceI nextSeq;\r
315 \r
316     /// First draw the sequences\r
317     /////////////////////////////\r
318     for (int i = y1 ; i < y2 ;i++)\r
319     {\r
320      nextSeq = av.alignment.getSequenceAt(i);\r
321 \r
322      sr.drawSequence(g, nextSeq, av.alignment.findAllGroups( nextSeq ),x1,x2,\r
323                  (x1 - startx) * av.charWidth,\r
324                  offset + AlignmentUtil.getPixelHeight(starty, i, av.charHeight),\r
325                  av.charWidth,av.charHeight);\r
326 \r
327      if(av.showSequenceFeatures)\r
328      {\r
329        fr.drawSequence(g, nextSeq, av.alignment.findAllGroups( nextSeq ), x1, x2,\r
330                        (x1 - startx) * av.charWidth,\r
331                        offset +\r
332                        AlignmentUtil.getPixelHeight(starty, i, av.charHeight),\r
333                        av.charWidth, av.charHeight);\r
334      }\r
335     }\r
336     //\r
337     /////////////////////////////////////\r
338 \r
339     // Now outline any areas if necessary\r
340     /////////////////////////////////////\r
341     SequenceGroup group = av.getSelectionGroup();\r
342     java.util.Vector groups = av.alignment.getGroups();\r
343 \r
344     int sx = -1, sy = -1, ex = -1;\r
345     int groupIndex = -1;\r
346     if (group == null && groups.size() > 0)\r
347     {\r
348       group = (SequenceGroup) groups.elementAt(0);\r
349       groupIndex = 0;\r
350     }\r
351 \r
352     if (group != null)\r
353       do\r
354       {\r
355         int oldY = -1;\r
356         int i = 0;\r
357         boolean inGroup = false;\r
358         int top=-1, bottom =-1;\r
359         for (i = y1; i < y2; i++)\r
360         {\r
361           sx = (group.getStartRes() - startx) * av.charWidth;\r
362           sy = offset + AlignmentUtil.getPixelHeight(starty, i, av.charHeight);\r
363           ex = (group.getEndRes() + 1 - group.getStartRes()) * av.charWidth -1;\r
364 \r
365           if (sx < getWidth()\r
366               && ex > 0\r
367               && group.sequences.contains(av.alignment.getSequenceAt(i)))\r
368           {\r
369             if (bottom == -1 &&\r
370                 !group.sequences.contains(av.alignment.getSequenceAt(i + 1)))\r
371               bottom = sy + av.charHeight ;\r
372 \r
373             if (!inGroup)\r
374             {\r
375               if (top == -1 && i==0 ||\r
376                   !group.sequences.contains(av.alignment.getSequenceAt(i - 1)))\r
377                 top = sy;\r
378 \r
379 \r
380               oldY = sy;\r
381               inGroup = true;\r
382               if (group == av.getSelectionGroup())\r
383               {\r
384                 g.setStroke(new BasicStroke(1, BasicStroke.CAP_BUTT, BasicStroke.JOIN_ROUND, 3f, new float[]{5f,3f}, 0f ));\r
385                 g.setColor(Color.RED);\r
386               }\r
387               else\r
388               {\r
389                 g.setStroke(new BasicStroke());\r
390                 g.setColor(group.getOutlineColour());\r
391               }\r
392             }\r
393           }\r
394           else\r
395           {\r
396             if (inGroup)\r
397             {\r
398               g.drawLine(sx, oldY, sx, sy );\r
399               g.drawLine(sx+ex, oldY, sx+ex, sy );\r
400 \r
401               if (top != -1)\r
402               {\r
403                 g.drawLine(sx, top, sx + ex, top);\r
404                 top =-1;\r
405               }\r
406               if (bottom != -1)\r
407               {\r
408                 g.drawLine(sx, bottom, sx + ex, bottom);\r
409                 bottom = -1;\r
410               }\r
411 \r
412 \r
413               inGroup = false;\r
414             }\r
415           }\r
416         }\r
417 \r
418         if (inGroup)\r
419         {\r
420 \r
421           if(top!=-1)\r
422           {\r
423             g.drawLine(sx, top, sx + ex, top);\r
424             top =-1;\r
425           }\r
426           if(bottom!=-1)\r
427            {\r
428              g.drawLine(sx, bottom-1, sx + ex, bottom-1);\r
429              bottom = -1;\r
430 \r
431            }\r
432           sy = offset + AlignmentUtil.getPixelHeight(starty, i, av.charHeight);\r
433           g.drawLine(sx, oldY, sx, sy );\r
434           g.drawLine(sx+ex, oldY, sx+ex, sy );\r
435           inGroup = false;\r
436         }\r
437         groupIndex++;\r
438         if (groupIndex >= groups.size())\r
439           break;\r
440 \r
441         group = (SequenceGroup) groups.elementAt(groupIndex);\r
442 \r
443       }\r
444       while (groupIndex < groups.size());\r
445 \r
446 \r
447     /// Highlight search Results once all sequences have been drawn\r
448     //////////////////////////////////////////////////////////\r
449     if(displaySearch)\r
450     {\r
451       for(int r=0; r<searchResults.length; r+=3)\r
452       {\r
453         int searchSeq = searchResults[r];\r
454 \r
455         if (searchSeq >= y1 && searchSeq < y2)\r
456         {\r
457           SequenceI seq = av.getAlignment().getSequenceAt(searchSeq);\r
458 \r
459           int searchStart = seq.findIndex( searchResults[r+1] )-1;\r
460           int searchEnd =  seq.findIndex(  searchResults[r+2] )-1;\r
461 \r
462           SequenceRenderer ssr = (SequenceRenderer) sr;\r
463           if(searchStart<x1)\r
464             searchStart = x1;\r
465           if(searchEnd > x2)\r
466             searchEnd = x2;\r
467 \r
468           ssr.drawHighlightedText(seq,\r
469                                   searchStart,\r
470                                   searchEnd,\r
471                                   (searchStart - startx) * av.charWidth,\r
472                                   offset +\r
473                                   AlignmentUtil.getPixelHeight(starty, searchSeq,\r
474               av.charHeight),\r
475                                   av.charWidth,\r
476                                   av.charHeight);\r
477         }\r
478       }\r
479     }\r
480 \r
481   }\r
482 \r
483 \r
484 \r
485   public void highlightSearchResults(int [] results)\r
486   {\r
487     // results are in the order sequence, startRes, endRes\r
488     if(results==null)\r
489       displaySearch = false;\r
490     else\r
491       displaySearch = true;\r
492 \r
493     searchResults = results;\r
494 \r
495     repaint();\r
496   }\r
497 \r
498 \r
499 }\r