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