Null sequence check
[jalview.git] / src / jalview / gui / OverviewPanel.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 java.awt.*;\r
22 import java.awt.event.*;\r
23 import java.awt.image.*;\r
24 \r
25 import javax.swing.*;\r
26 \r
27 \r
28 /**\r
29  * DOCUMENT ME!\r
30  *\r
31  * @author $author$\r
32  * @version $Revision$\r
33  */\r
34 public class OverviewPanel extends JPanel implements Runnable\r
35 {\r
36     BufferedImage miniMe;\r
37     AlignViewport av;\r
38     AlignmentPanel ap;\r
39     float scalew = 1f;\r
40     float scaleh = 1f;\r
41     int width;\r
42     int sequencesHeight;\r
43     int graphHeight = 20;\r
44     int boxX = -1;\r
45     int boxY = -1;\r
46     int boxWidth = -1;\r
47     int boxHeight = -1;\r
48     boolean resizing = false;\r
49 \r
50     // Can set different properties in this seqCanvas than\r
51     // main visible SeqCanvas\r
52     SequenceRenderer sr;\r
53     FeatureRenderer fr;\r
54 \r
55     /**\r
56      * Creates a new OverviewPanel object.\r
57      *\r
58      * @param ap DOCUMENT ME!\r
59      */\r
60     public OverviewPanel(AlignmentPanel ap)\r
61     {\r
62         this.av = ap.av;\r
63         this.ap = ap;\r
64         setLayout(null);\r
65 \r
66         sr = new SequenceRenderer(av);\r
67         sr.renderGaps( false );\r
68         fr = new FeatureRenderer(av);\r
69         fr.transparency = ap.seqPanel.seqCanvas.getFeatureRenderer().transparency;\r
70         fr.featuresDisplayed = ap.seqPanel.seqCanvas.getFeatureRenderer().featuresDisplayed;\r
71 \r
72         // scale the initial size of overviewpanel to shape of alignment\r
73         float initialScale = (float) av.alignment.getWidth() / (float) av.alignment.getHeight();\r
74 \r
75         if(av.conservation==null)\r
76           graphHeight = 0;\r
77 \r
78 \r
79         if (av.alignment.getWidth() > av.alignment.getHeight())\r
80         {\r
81             // wider\r
82             width = 400;\r
83             sequencesHeight = (int) (400f / initialScale);\r
84             if(sequencesHeight<40)\r
85               sequencesHeight = 40;\r
86         }\r
87         else\r
88         {\r
89             // taller\r
90             width = (int) (400f * initialScale);\r
91             sequencesHeight = 300;\r
92 \r
93             if (width < 120)\r
94             {\r
95                 width = 120;\r
96             }\r
97         }\r
98 \r
99         addComponentListener(new ComponentAdapter()\r
100             {\r
101                 public void componentResized(ComponentEvent evt)\r
102                 {\r
103                     if ((getWidth() != width) ||\r
104                             (getHeight() != (sequencesHeight + graphHeight)))\r
105                     {\r
106                         updateOverviewImage();\r
107                     }\r
108                 }\r
109             });\r
110 \r
111         addMouseMotionListener(new MouseMotionAdapter()\r
112             {\r
113                 public void mouseDragged(MouseEvent evt)\r
114                 {\r
115                   if(!av.wrapAlignment)\r
116                     doMouseDragged(evt);\r
117                 }\r
118             });\r
119 \r
120         addMouseListener(new MouseAdapter()\r
121             {\r
122                 public void mousePressed(MouseEvent evt)\r
123                 {\r
124                   if(!av.wrapAlignment)\r
125                     doMousePressed(evt);\r
126                 }\r
127 \r
128                 public void mouseReleased(MouseEvent evt)\r
129                 {\r
130                   if(!av.wrapAlignment)\r
131                     doMouseReleased(evt);\r
132                 }\r
133             });\r
134 \r
135         updateOverviewImage();\r
136     }\r
137 \r
138     /**\r
139      * DOCUMENT ME!\r
140      *\r
141      * @param evt DOCUMENT ME!\r
142      */\r
143     public void doMousePressed(MouseEvent evt)\r
144     {\r
145         boxX = evt.getX();\r
146         boxY = evt.getY();\r
147 \r
148         checkValid();\r
149         repaint();\r
150     }\r
151 \r
152     /**\r
153      * DOCUMENT ME!\r
154      *\r
155      * @param evt DOCUMENT ME!\r
156      */\r
157     public void doMouseReleased(MouseEvent evt)\r
158     {\r
159         boxX = evt.getX();\r
160         boxY = evt.getY();\r
161         checkValid();\r
162 \r
163         ap.setScrollValues((int) (boxX / scalew / av.getCharWidth()),\r
164                 (int) (boxY / scaleh / av.getCharHeight()));\r
165     }\r
166 \r
167     /**\r
168      * DOCUMENT ME!\r
169      *\r
170      * @param evt DOCUMENT ME!\r
171      */\r
172     public void doMouseDragged(MouseEvent evt)\r
173     {\r
174         boxX = evt.getX();\r
175         boxY = evt.getY();\r
176         checkValid();\r
177 \r
178         ap.setScrollValues( (int) (boxX / scalew / av.getCharWidth()),\r
179                            (int) (boxY / scaleh / av.getCharHeight()));\r
180        repaint();\r
181     }\r
182 \r
183     /**\r
184      * DOCUMENT ME!\r
185      */\r
186     void checkValid()\r
187     {\r
188         if (boxY < 0)\r
189         {\r
190             boxY = 0;\r
191         }\r
192 \r
193         if (boxY > (sequencesHeight - boxHeight))\r
194         {\r
195             boxY = sequencesHeight - boxHeight + 1;\r
196         }\r
197 \r
198         if (boxX < 0)\r
199         {\r
200             boxX = 0;\r
201         }\r
202 \r
203         if (boxX > (width - boxWidth))\r
204         {\r
205             boxX = width - boxWidth;\r
206         }\r
207     }\r
208 \r
209     /**\r
210      * DOCUMENT ME!\r
211      */\r
212     public void updateOverviewImage()\r
213     {\r
214         if (resizing)\r
215         {\r
216             resizeAgain = true;\r
217             return;\r
218         }\r
219 \r
220         resizing = true;\r
221 \r
222         if ( (getWidth() > 0) && (getHeight() > 0))\r
223         {\r
224           width = getWidth();\r
225           sequencesHeight = getHeight() - graphHeight;\r
226         }\r
227 \r
228         setPreferredSize(new Dimension(width, sequencesHeight + graphHeight));\r
229         setBoxPosition();\r
230 \r
231         Thread thread = new Thread(this);\r
232         thread.start();\r
233         repaint();\r
234     }\r
235 \r
236     // This is set true if the user resizes whilst\r
237     // the overview is being calculated\r
238     boolean resizeAgain = false;\r
239 \r
240     /**\r
241      * DOCUMENT ME!\r
242      */\r
243     public void run()\r
244     {\r
245         miniMe = null;\r
246 \r
247         int alwidth = av.alignment.getWidth();\r
248         int alheight = av.alignment.getHeight();\r
249 \r
250         setPreferredSize(new Dimension(width, sequencesHeight + graphHeight));\r
251 \r
252         int fullsizeWidth = alwidth * av.getCharWidth();\r
253         int fullsizeHeight = alheight * av.getCharHeight();\r
254 \r
255         scalew = (float) width / (float) fullsizeWidth;\r
256         scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
257 \r
258         miniMe = new BufferedImage(width, sequencesHeight + graphHeight,\r
259                 BufferedImage.TYPE_INT_RGB);\r
260 \r
261 \r
262         Graphics mg = miniMe.getGraphics();\r
263         mg.setColor(Color.orange);\r
264         mg.fillRect(0,0,width, miniMe.getHeight());\r
265 \r
266         float sampleCol = (float) alwidth / (float) width;\r
267         float sampleRow = (float) alheight / (float) sequencesHeight;\r
268 \r
269         int lastcol=-1, lastrow=-1;\r
270         Color color = Color.white;\r
271         for (int col = 0; col < width; col++)\r
272         {\r
273           for (int row = 0; row < sequencesHeight; row++)\r
274           {\r
275             if((int)(col*sampleCol) == lastcol && (int)(row*sampleRow)==lastrow)\r
276             {\r
277               miniMe.setRGB(col,row,color.getRGB());\r
278               continue;\r
279             }\r
280 \r
281             lastrow = (int)(row*sampleRow);\r
282             lastcol = (int)(col*sampleCol);\r
283 \r
284             if(av.alignment.getSequenceAt(lastrow).getLength()>lastcol)\r
285             {\r
286              color = sr.getResidueBoxColour(\r
287                 av.alignment.getSequenceAt(lastrow), lastcol);\r
288 \r
289              if(av.showSequenceFeatures)\r
290                   color = fr.findFeatureColour(color,  av.alignment.getSequenceAt(lastrow),\r
291                                                        lastcol);\r
292             }\r
293 \r
294             miniMe.setRGB(col,row,color.getRGB());\r
295 \r
296             if (av.conservation != null)\r
297             {\r
298               mg.translate(col, sequencesHeight);\r
299               ap.annotationPanel.drawGraph(mg, av.conservation,\r
300                                            (int) (sampleCol) + 1,\r
301                                            graphHeight,\r
302                                            (int) (col * sampleCol),\r
303                                            (int) (col * sampleCol) + 1);\r
304               mg.translate(-col, -sequencesHeight);\r
305             }\r
306           }\r
307         }\r
308 \r
309         System.gc();\r
310 \r
311         resizing = false;\r
312 \r
313         setBoxPosition();\r
314 \r
315         if(resizeAgain)\r
316         {\r
317           resizeAgain = false;\r
318           updateOverviewImage();\r
319         }\r
320     }\r
321 \r
322     /**\r
323      * DOCUMENT ME!\r
324      */\r
325     public void setBoxPosition()\r
326     {\r
327       int fullsizeWidth = av.alignment.getWidth() * av.getCharWidth();\r
328       int fullsizeHeight = av.alignment.getHeight() * av.getCharHeight();\r
329 \r
330       scalew = (float) width / (float) fullsizeWidth;\r
331       scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
332 \r
333         boxX = (int) (av.getStartRes() * av.getCharWidth() * scalew);\r
334         boxY = (int) (av.getStartSeq() * av.getCharHeight() * scaleh);\r
335         boxWidth = (int) ((av.getEndRes() - av.getStartRes() + 1) * av.getCharWidth() * scalew);\r
336         boxHeight = (int) (av.getEndSeq() * av.getCharHeight() * scaleh) -\r
337             boxY;\r
338         repaint();\r
339     }\r
340 \r
341     /**\r
342      * DOCUMENT ME!\r
343      *\r
344      * @param g DOCUMENT ME!\r
345      */\r
346     public void paintComponent(Graphics g)\r
347     {\r
348         if (miniMe != null && !resizing)\r
349         {\r
350           g.drawImage(miniMe, 0, 0, this);\r
351         }\r
352         else\r
353         {\r
354           g.setColor(Color.white);\r
355           g.fillRect(0, 0, getWidth(), getHeight());\r
356           g.setColor(Color.black);\r
357           g.setFont(new Font("Verdana", Font.BOLD, 15));\r
358           g.drawString("Recalculating", 5, sequencesHeight / 2);\r
359           g.drawString("Overview.....", 5, (sequencesHeight / 2) + 20);\r
360         }\r
361 \r
362 \r
363         g.setColor(Color.red);\r
364         g.drawRect(boxX, boxY, boxWidth, boxHeight);\r
365         g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);\r
366 \r
367     }\r
368 }\r