Formatting
[jalview.git] / src / jalview / appletgui / OverviewPanel.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2007 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 \r
20 package jalview.appletgui;\r
21 \r
22 import java.awt.*;\r
23 import java.awt.event.*;\r
24 \r
25 public class OverviewPanel\r
26     extends Panel implements Runnable, MouseMotionListener, MouseListener\r
27 {\r
28   Image miniMe;\r
29   Image offscreen;\r
30   AlignViewport av;\r
31   AlignmentPanel ap;\r
32   float scalew = 1f;\r
33   float scaleh = 1f;\r
34 \r
35   public int width, sequencesHeight;\r
36   int graphHeight = 20;\r
37   int boxX = -1, boxY = -1, boxWidth = -1, boxHeight = -1;\r
38 \r
39   boolean resizing = false;\r
40 \r
41   // Can set different properties in this seqCanvas than\r
42   // main visible SeqCanvas\r
43   SequenceRenderer sr;\r
44   FeatureRenderer fr;\r
45 \r
46   Frame nullFrame;\r
47 \r
48   public OverviewPanel(AlignmentPanel ap)\r
49   {\r
50     this.av = ap.av;\r
51     this.ap = ap;\r
52     setLayout(null);\r
53     nullFrame = new Frame();\r
54     nullFrame.addNotify();\r
55 \r
56     sr = new SequenceRenderer(av);\r
57     sr.graphics = nullFrame.getGraphics();\r
58     sr.renderGaps = false;\r
59     sr.forOverview = true;\r
60     fr = new FeatureRenderer(av);\r
61     fr.overview = true;\r
62 \r
63     // scale the initial size of overviewpanel to shape of alignment\r
64     float initialScale = (float) av.alignment.getWidth() /\r
65         (float) av.alignment.getHeight();\r
66 \r
67     if (av.hconsensus == null)\r
68     {\r
69       graphHeight = 0;\r
70     }\r
71 \r
72     if (av.alignment.getWidth() > av.alignment.getHeight())\r
73     {\r
74       // wider\r
75       width = 400;\r
76       sequencesHeight = (int) (400f / initialScale);\r
77       if (sequencesHeight < 40)\r
78       {\r
79         sequencesHeight = 40;\r
80       }\r
81     }\r
82     else\r
83     {\r
84       // taller\r
85       width = (int) (400f * initialScale);\r
86       sequencesHeight = 300;\r
87       if (width < 120)\r
88       {\r
89         width = 120;\r
90       }\r
91     }\r
92 \r
93     setSize(new Dimension(width, sequencesHeight + graphHeight));\r
94     addComponentListener(new ComponentAdapter()\r
95     {\r
96 \r
97       public void componentResized(ComponentEvent evt)\r
98       {\r
99         if (getSize().width != width ||\r
100             getSize().height != sequencesHeight + graphHeight)\r
101         {\r
102           updateOverviewImage();\r
103         }\r
104       }\r
105     });\r
106 \r
107     addMouseMotionListener(this);\r
108 \r
109     addMouseListener(this);\r
110 \r
111     updateOverviewImage();\r
112 \r
113   }\r
114 \r
115   public void mouseEntered(MouseEvent evt)\r
116   {}\r
117 \r
118   public void mouseExited(MouseEvent evt)\r
119   {}\r
120 \r
121   public void mouseClicked(MouseEvent evt)\r
122   {}\r
123 \r
124   public void mouseMoved(MouseEvent evt)\r
125   {}\r
126 \r
127   public void mousePressed(MouseEvent evt)\r
128   {\r
129     boxX = evt.getX();\r
130     boxY = evt.getY();\r
131     checkValid();\r
132   }\r
133 \r
134   public void mouseReleased(MouseEvent evt)\r
135   {\r
136     boxX = evt.getX();\r
137     boxY = evt.getY();\r
138     checkValid();\r
139   }\r
140 \r
141   public void mouseDragged(MouseEvent evt)\r
142   {\r
143     boxX = evt.getX();\r
144     boxY = evt.getY();\r
145     checkValid();\r
146   }\r
147 \r
148   void checkValid()\r
149   {\r
150     if (boxY < 0)\r
151     {\r
152       boxY = 0;\r
153     }\r
154 \r
155     if (boxY > (sequencesHeight - boxHeight))\r
156     {\r
157       boxY = sequencesHeight - boxHeight + 1;\r
158     }\r
159 \r
160     if (boxX < 0)\r
161     {\r
162       boxX = 0;\r
163     }\r
164 \r
165     if (boxX > (width - boxWidth))\r
166     {\r
167       if (av.hasHiddenColumns)\r
168       {\r
169         //Try smallest possible box\r
170         boxWidth = (int) ( (av.endRes - av.startRes + 1) *\r
171                           av.getCharWidth() * scalew);\r
172       }\r
173       boxX = width - boxWidth;\r
174     }\r
175 \r
176     int col = (int) (boxX / scalew / av.getCharWidth());\r
177     int row = (int) (boxY / scaleh / av.getCharHeight());\r
178 \r
179     if (av.hasHiddenColumns)\r
180     {\r
181       if (!av.getColumnSelection().isVisible(col))\r
182       {\r
183         return;\r
184       }\r
185 \r
186       col = av.getColumnSelection().findColumnPosition(col);\r
187     }\r
188 \r
189     if (av.hasHiddenRows)\r
190     {\r
191       row = av.alignment.getHiddenSequences().findIndexWithoutHiddenSeqs(row);\r
192     }\r
193 \r
194     ap.setScrollValues(col, row);\r
195     ap.repaint();\r
196   }\r
197 \r
198   /**\r
199    * DOCUMENT ME!\r
200    */\r
201   public void updateOverviewImage()\r
202   {\r
203     if (resizing)\r
204     {\r
205       resizeAgain = true;\r
206       return;\r
207     }\r
208 \r
209     if (av.showSequenceFeatures)\r
210     {\r
211       fr.featureGroups = ap.seqPanel.seqCanvas.getFeatureRenderer().\r
212           featureGroups;\r
213       fr.featureColours = ap.seqPanel.seqCanvas.getFeatureRenderer().\r
214           featureColours;\r
215     }\r
216 \r
217     resizing = true;\r
218 \r
219     if ( (getSize().width > 0) && (getSize().height > 0))\r
220     {\r
221       width = getSize().width;\r
222       sequencesHeight = getSize().height - graphHeight;\r
223     }\r
224     setSize(new Dimension(width, sequencesHeight + graphHeight));\r
225 \r
226     Thread thread = new Thread(this);\r
227     thread.start();\r
228     repaint();\r
229   }\r
230 \r
231   // This is set true if the user resizes whilst\r
232   // the overview is being calculated\r
233   boolean resizeAgain = false;\r
234 \r
235   public void run()\r
236   {\r
237     miniMe = null;\r
238     int alwidth = av.alignment.getWidth();\r
239     int alheight = av.alignment.getHeight();\r
240 \r
241     if (av.showSequenceFeatures)\r
242     {\r
243       fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());\r
244     }\r
245 \r
246     if (getSize().width > 0 && getSize().height > 0)\r
247     {\r
248       width = getSize().width;\r
249       sequencesHeight = getSize().height - graphHeight;\r
250     }\r
251 \r
252     setSize(new Dimension(width, sequencesHeight + graphHeight));\r
253 \r
254     int fullsizeWidth = alwidth * av.getCharWidth();\r
255     int fullsizeHeight = alheight * av.getCharHeight();\r
256 \r
257     scalew = (float) width / (float) fullsizeWidth;\r
258     scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
259 \r
260     miniMe = nullFrame.createImage(width, sequencesHeight + graphHeight);\r
261     offscreen = nullFrame.createImage(width, sequencesHeight + graphHeight);\r
262 \r
263     Graphics mg = miniMe.getGraphics();\r
264     float sampleCol = (float) alwidth / (float) width;\r
265     float sampleRow = (float) alheight / (float) sequencesHeight;\r
266 \r
267     int lastcol = 0, lastrow = 0;\r
268     int xstart = 0, ystart = 0;\r
269     Color color = Color.yellow;\r
270     int row, col, sameRow = 0, sameCol = 0;\r
271     jalview.datamodel.SequenceI seq;\r
272     boolean hiddenRow = false;\r
273     for (row = 0; row <= sequencesHeight; row++)\r
274     {\r
275       if ( (int) (row * sampleRow) == lastrow)\r
276       {\r
277         sameRow++;\r
278         continue;\r
279       }\r
280 \r
281       hiddenRow = false;\r
282       if (av.hasHiddenRows)\r
283       {\r
284         seq = av.alignment.getHiddenSequences().getHiddenSequence(lastrow);\r
285         if (seq == null)\r
286         {\r
287           int index =\r
288               av.alignment.getHiddenSequences().findIndexWithoutHiddenSeqs(\r
289               lastrow);\r
290 \r
291           seq = av.alignment.getSequenceAt(index);\r
292         }\r
293         else\r
294         {\r
295           hiddenRow = true;\r
296         }\r
297       }\r
298       else\r
299       {\r
300         seq = av.alignment.getSequenceAt(lastrow);\r
301       }\r
302 \r
303       for (col = 0; col < width; col++)\r
304       {\r
305         if ( (int) (col * sampleCol) == lastcol &&\r
306             (int) (row * sampleRow) == lastrow)\r
307         {\r
308           sameCol++;\r
309           continue;\r
310         }\r
311 \r
312         lastcol = (int) (col * sampleCol);\r
313 \r
314         if (seq.getLength() > lastcol)\r
315         {\r
316           color = sr.getResidueBoxColour(\r
317               seq, lastcol);\r
318 \r
319           if (av.showSequenceFeatures)\r
320           {\r
321             color = fr.findFeatureColour(color, seq, lastcol);\r
322           }\r
323         }\r
324         else\r
325         {\r
326           color = Color.white; //White\r
327         }\r
328 \r
329         if (hiddenRow ||\r
330             (av.hasHiddenColumns && !av.getColumnSelection().isVisible(lastcol)))\r
331         {\r
332           color = color.darker().darker();\r
333         }\r
334 \r
335         mg.setColor(color);\r
336         if (sameCol == 1 && sameRow == 1)\r
337         {\r
338           mg.drawLine(xstart, ystart, xstart, ystart);\r
339         }\r
340         else\r
341         {\r
342           mg.fillRect(xstart, ystart, sameCol, sameRow);\r
343         }\r
344 \r
345         xstart = col;\r
346         sameCol = 1;\r
347       }\r
348       lastrow = (int) (row * sampleRow);\r
349       ystart = row;\r
350       sameRow = 1;\r
351     }\r
352 \r
353     if (av.conservation != null)\r
354     {\r
355       for (col = 0; col < width; col++)\r
356       {\r
357         lastcol = (int) (col * sampleCol);\r
358         {\r
359           mg.translate(col, sequencesHeight);\r
360           ap.annotationPanel.drawGraph(mg, av.conservation,\r
361                                        (int) (sampleCol) + 1,\r
362                                        graphHeight,\r
363                                        (int) (col * sampleCol),\r
364                                        (int) (col * sampleCol) + 1);\r
365           mg.translate( -col, -sequencesHeight);\r
366         }\r
367       }\r
368     }\r
369     System.gc();\r
370 \r
371     resizing = false;\r
372 \r
373     setBoxPosition();\r
374 \r
375     if (resizeAgain)\r
376     {\r
377       resizeAgain = false;\r
378       updateOverviewImage();\r
379     }\r
380   }\r
381 \r
382   public void setBoxPosition()\r
383   {\r
384     int fullsizeWidth = av.alignment.getWidth() * av.getCharWidth();\r
385     int fullsizeHeight = (av.alignment.getHeight()\r
386                           + av.alignment.getHiddenSequences().getSize()) *\r
387         av.getCharHeight();\r
388 \r
389     int startRes = av.getStartRes();\r
390     int endRes = av.getEndRes();\r
391 \r
392     if (av.hasHiddenColumns)\r
393     {\r
394       startRes = av.getColumnSelection().adjustForHiddenColumns(startRes);\r
395       endRes = av.getColumnSelection().adjustForHiddenColumns(endRes);\r
396     }\r
397 \r
398     int startSeq = av.startSeq;\r
399     int endSeq = av.endSeq;\r
400 \r
401     if (av.hasHiddenRows)\r
402     {\r
403       startSeq =\r
404           av.alignment.getHiddenSequences().adjustForHiddenSeqs(startSeq);\r
405 \r
406       endSeq =\r
407           av.alignment.getHiddenSequences().adjustForHiddenSeqs(endSeq);\r
408 \r
409     }\r
410 \r
411     scalew = (float) width / (float) fullsizeWidth;\r
412     scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
413 \r
414     boxX = (int) (startRes * av.getCharWidth() * scalew);\r
415     boxY = (int) (startSeq * av.getCharHeight() * scaleh);\r
416 \r
417     if (av.hasHiddenColumns)\r
418     {\r
419       boxWidth = (int) ( (endRes - startRes + 1) * av.getCharWidth() * scalew);\r
420     }\r
421     else\r
422     {\r
423       boxWidth = (int) ( (endRes - startRes + 1) * av.getCharWidth() * scalew);\r
424     }\r
425 \r
426     boxHeight = (int) ( (endSeq - startSeq) * av.getCharHeight() * scaleh);\r
427 \r
428     repaint();\r
429   }\r
430 \r
431   public void update(Graphics g)\r
432   {\r
433     paint(g);\r
434   }\r
435 \r
436   public void paint(Graphics g)\r
437   {\r
438     Graphics og = offscreen.getGraphics();\r
439     if (miniMe != null)\r
440     {\r
441       og.drawImage(miniMe, 0, 0, this);\r
442       og.setColor(Color.red);\r
443       og.drawRect(boxX, boxY, boxWidth, boxHeight);\r
444       og.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);\r
445       g.drawImage(offscreen, 0, 0, this);\r
446     }\r
447     else\r
448     {\r
449       g.setColor(Color.white);\r
450       g.fillRect(0, 0, getSize().width, getSize().height);\r
451       g.setColor(Color.black);\r
452       g.setFont(new Font("Verdana", Font.BOLD, 15));\r
453       g.drawString("Recalculating", 5, sequencesHeight / 2);\r
454       g.drawString("Overview.....", 5, (sequencesHeight / 2) + 20);\r
455     }\r
456   }\r
457 \r
458 }\r