7332a1af8368be4f2b1c3c3c4fb12158f1116587
[jalview.git] / src / jalview / appletgui / AlignmentPanel.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 \r
20 package jalview.appletgui;\r
21 \r
22 import java.awt.*;\r
23 import java.awt.event.*;\r
24 \r
25 import jalview.datamodel.*;\r
26 import jalview.jbappletgui.*;\r
27 \r
28 public class AlignmentPanel\r
29     extends GAlignmentPanel implements AdjustmentListener\r
30 {\r
31 \r
32   AlignViewport av;\r
33   OverviewPanel overviewPanel;\r
34   SeqPanel seqPanel;\r
35   IdPanel idPanel;\r
36   IdwidthAdjuster idwidthAdjuster;\r
37   public AlignFrame alignFrame;\r
38   ScalePanel scalePanel;\r
39   AnnotationPanel annotationPanel;\r
40   AnnotationLabels alabels;\r
41 \r
42   // this value is set false when selection area being dragged\r
43   boolean fastPaint = true;\r
44 \r
45   boolean MAC = false;\r
46 \r
47   public AlignmentPanel(AlignFrame af, final AlignViewport av)\r
48   {\r
49     if(System.getProperty("os.name").startsWith("Mac"))\r
50       MAC = true;\r
51 \r
52     alignFrame = af;\r
53     this.av = av;\r
54     seqPanel = new SeqPanel(av, this);\r
55     idPanel = new IdPanel(av, this);\r
56     scalePanel = new ScalePanel(av, this);\r
57     idwidthAdjuster = new IdwidthAdjuster(this);\r
58     annotationPanel = new AnnotationPanel(this);\r
59     alabels = new AnnotationLabels(this);\r
60 \r
61     idPanelHolder.add(idPanel, BorderLayout.CENTER);\r
62     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);\r
63     annotationScroller.add(annotationPanel);\r
64     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);\r
65     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);\r
66     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);\r
67 \r
68     fontChanged();\r
69     setScrollValues(0, 0);\r
70 \r
71     hscroll.addAdjustmentListener(this);\r
72     vscroll.addAdjustmentListener(this);\r
73 \r
74     seqPanel.seqCanvas.addKeyListener(new MyKeyAdapter());\r
75     idPanel.idCanvas.addKeyListener(new MyKeyAdapter());\r
76 \r
77     addComponentListener(new ComponentAdapter()\r
78     {\r
79       public void componentResized(ComponentEvent evt)\r
80       {\r
81         setScrollValues(av.getStartRes(), av.getStartSeq());\r
82         repaint();\r
83       }\r
84     });\r
85 \r
86     Dimension d = calculateIdWidth();\r
87     idPanel.idCanvas.setSize(d);\r
88 \r
89     hscrollFillerPanel.setSize(d.width, annotationPanel.getSize().height);\r
90     annotationScroller.setSize(annotationPanel.getSize());\r
91 \r
92     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);\r
93     annotationSpaceFillerHolder.setSize(d.width,\r
94                                         annotationPanel.getSize().height);\r
95     alabels.setSize(d.width, annotationPanel.getSize().height);\r
96 \r
97   }\r
98 \r
99   class MyKeyAdapter\r
100       extends KeyAdapter\r
101   {\r
102     public void keyPressed(KeyEvent evt)\r
103     {\r
104       // System.out.println(evt.getKeyCode()); log.\r
105       switch (evt.getKeyCode())\r
106       {\r
107         case 27: // escape key\r
108           av.setSelectionGroup(null);\r
109           alignFrame.alignPanel.repaint();\r
110           break;\r
111         case KeyEvent.VK_X:\r
112           if (evt.isControlDown())\r
113           {\r
114             alignFrame.cut_actionPerformed(null);\r
115           }\r
116           break;\r
117         case KeyEvent.VK_C:\r
118           if (evt.isControlDown())\r
119           {\r
120             alignFrame.copy_actionPerformed(null);\r
121           }\r
122           break;\r
123         case KeyEvent.VK_V:\r
124           if (evt.isControlDown())\r
125           {\r
126             alignFrame.paste(true);\r
127           }\r
128           break;\r
129         case KeyEvent.VK_A:\r
130           if (evt.isControlDown())\r
131           {\r
132             alignFrame.selectAllSequenceMenuItem_actionPerformed(null);\r
133           }\r
134           break;\r
135         case KeyEvent.VK_DOWN:\r
136           alignFrame.moveSelectedSequences(false);\r
137           break;\r
138         case KeyEvent.VK_UP:\r
139           alignFrame.moveSelectedSequences(true);\r
140           break;\r
141         case KeyEvent.VK_F:\r
142           if (evt.isControlDown())\r
143           {\r
144             alignFrame.findMenuItem_actionPerformed(null);\r
145           }\r
146           break;\r
147         case KeyEvent.VK_BACK_SPACE:\r
148         case KeyEvent.VK_DELETE:\r
149           alignFrame.cut_actionPerformed(null);\r
150           break;\r
151 \r
152       }\r
153     }\r
154   }\r
155 \r
156   public void fontChanged()\r
157   {\r
158     // set idCanvas bufferedImage to null\r
159     // to prevent drawing old image\r
160     FontMetrics fm = getFontMetrics(av.getFont());\r
161 \r
162     scalePanel.setSize(new Dimension(10, av.charHeight + fm.getDescent()));\r
163     idwidthAdjuster.setSize(new Dimension(10, av.charHeight + fm.getDescent()));\r
164 \r
165     annotationPanel.adjustPanelHeight();\r
166     annotationPanel.repaint();\r
167     Dimension d = calculateIdWidth();\r
168     d.setSize(d.width + 4, seqPanel.seqCanvas.getSize().height);\r
169     idPanel.idCanvas.setSize(d);\r
170     hscrollFillerPanel.setSize(d);\r
171 \r
172     alignFrame.pack();\r
173 \r
174     if(overviewPanel!=null)\r
175           overviewPanel.updateOverviewImage();\r
176   }\r
177 \r
178   public void setIdWidth(int w, int h)\r
179   {\r
180     idPanel.idCanvas.setSize(w, h);\r
181     idPanelHolder.setSize(w, idPanelHolder.getSize().height);\r
182     alabels.setSize(w, alabels.getSize().height);\r
183     validate();\r
184   }\r
185 \r
186   Dimension calculateIdWidth()\r
187   {\r
188     Frame frame = new Frame();\r
189     frame.addNotify();\r
190     Graphics g = frame.getGraphics();\r
191     if (g == null)\r
192     {\r
193       Frame f = new Frame();\r
194       f.addNotify();\r
195       g = f.getGraphics();\r
196     }\r
197 \r
198     FontMetrics fm = g.getFontMetrics(av.font);\r
199     AlignmentI al = av.getAlignment();\r
200 \r
201     int i = 0;\r
202     int idWidth = 0;\r
203     String id;\r
204     while (i < al.getHeight() && al.getSequenceAt(i) != null)\r
205     {\r
206       SequenceI s = al.getSequenceAt(i);\r
207       if (av.getShowFullId())\r
208       {\r
209         id = s.getDisplayId();\r
210       }\r
211       else\r
212       {\r
213         id = s.getName();\r
214       }\r
215 \r
216       if (fm.stringWidth(id) > idWidth)\r
217       {\r
218         idWidth = fm.stringWidth(id);\r
219       }\r
220       i++;\r
221     }\r
222 \r
223     // Also check annotation label widths\r
224     i = 0;\r
225     if (al.getAlignmentAnnotation() != null)\r
226     {\r
227       fm = g.getFontMetrics(frame.getFont());\r
228       while (i < al.getAlignmentAnnotation().length)\r
229       {\r
230         String label = al.getAlignmentAnnotation()[i].label;\r
231         if (fm.stringWidth(label) > idWidth)\r
232         {\r
233           idWidth = fm.stringWidth(label);\r
234         }\r
235         i++;\r
236       }\r
237     }\r
238 \r
239     return new Dimension(idWidth, idPanel.idCanvas.getSize().height);\r
240   }\r
241 \r
242   public void highlightSearchResults(int[] results)\r
243   {\r
244     seqPanel.seqCanvas.highlightSearchResults(results);\r
245 \r
246     // do we need to scroll the panel?\r
247     if (results != null)\r
248     {\r
249       SequenceI seq = av.alignment.getSequenceAt(results[0]);\r
250       int start = seq.findIndex(results[1]) - 1;\r
251       int end = seq.findIndex(results[2]) - 1;\r
252       if (av.getStartRes() > start\r
253           || av.getEndRes() < end\r
254           || (av.getStartSeq() > results[0]\r
255               || av.getEndSeq() < results[0]))\r
256       {\r
257         setScrollValues(start, results[0]);\r
258       }\r
259     }\r
260 \r
261   }\r
262 \r
263   public OverviewPanel getOverviewPanel()\r
264   {\r
265     return overviewPanel;\r
266   }\r
267 \r
268   public void setOverviewPanel(OverviewPanel op)\r
269   {\r
270     overviewPanel = op;\r
271   }\r
272 \r
273   public void setAnnotationVisible(boolean b)\r
274   {\r
275     if (!av.wrapAlignment)\r
276     {\r
277       annotationSpaceFillerHolder.setVisible(b);\r
278       annotationScroller.setVisible(b);\r
279     }\r
280     validate();\r
281     repaint();\r
282   }\r
283 \r
284   public void setWrapAlignment(boolean wrap)\r
285   {\r
286     av.startSeq = 0;\r
287     scalePanelHolder.setVisible(!wrap);\r
288     hscroll.setVisible(!wrap);\r
289     idwidthAdjuster.setVisible(!wrap);\r
290 \r
291     if (wrap)\r
292     {\r
293       annotationScroller.setVisible(false);\r
294       annotationSpaceFillerHolder.setVisible(false);\r
295     }\r
296     else if (av.showAnnotation)\r
297     {\r
298       annotationScroller.setVisible(true);\r
299       annotationSpaceFillerHolder.setVisible(true);\r
300     }\r
301 \r
302     idSpaceFillerPanel1.setVisible(!wrap);\r
303 \r
304     validate();\r
305     repaint();\r
306 \r
307   }\r
308 \r
309 \r
310   int hextent = 0;\r
311   int vextent = 0;\r
312 \r
313   // return value is true if the scroll is valid\r
314   public boolean scrollUp(boolean up)\r
315   {\r
316     if (up)\r
317     {\r
318       if (vscroll.getValue() < 1)\r
319       {\r
320         return false;\r
321       }\r
322       fastPaint = false;\r
323       vscroll.setValue(vscroll.getValue() - 1);\r
324     }\r
325     else\r
326     {\r
327       if (vextent + vscroll.getValue() >= av.getAlignment().getHeight())\r
328       {\r
329         return false;\r
330       }\r
331       fastPaint = false;\r
332       vscroll.setValue(vscroll.getValue() + 1);\r
333     }\r
334     fastPaint = true;\r
335     return true;\r
336   }\r
337 \r
338   public boolean scrollRight(boolean right)\r
339   {\r
340 \r
341     if (right)\r
342     {\r
343       if (hscroll.getValue() < 1)\r
344       {\r
345         return false;\r
346       }\r
347       fastPaint = false;\r
348       hscroll.setValue(hscroll.getValue() - 1);\r
349     }\r
350     else\r
351     {\r
352       if (hextent + hscroll.getValue() >= av.getAlignment().getWidth())\r
353       {\r
354         return false;\r
355       }\r
356       fastPaint = false;\r
357       hscroll.setValue(hscroll.getValue() + 1);\r
358     }\r
359     fastPaint = true;\r
360     return true;\r
361   }\r
362 \r
363   public void setScrollValues(int x, int y)\r
364   {\r
365 \r
366     av.setStartRes(x);\r
367     av.setStartSeq(y);\r
368     av.setEndRes(x + seqPanel.seqCanvas.getSize().width / av.getCharWidth() - 1);\r
369 \r
370     hextent = seqPanel.seqCanvas.getSize().width / av.charWidth;\r
371     vextent = seqPanel.seqCanvas.getSize().height / av.charHeight;\r
372 \r
373     if (hextent > av.alignment.getWidth())\r
374     {\r
375       hextent = av.alignment.getWidth();\r
376     }\r
377     if (vextent > av.alignment.getHeight())\r
378     {\r
379       vextent = av.alignment.getHeight();\r
380     }\r
381 \r
382     if (hextent + x > av.getAlignment().getWidth())\r
383     {\r
384       x = av.getAlignment().getWidth() - hextent;\r
385     }\r
386 \r
387     if (vextent + y > av.getAlignment().getHeight())\r
388     {\r
389       y = av.getAlignment().getHeight() - vextent;\r
390     }\r
391 \r
392     if (y < 0)\r
393     {\r
394       y = 0;\r
395     }\r
396 \r
397     if (x < 0)\r
398     {\r
399       x = 0;\r
400     }\r
401 \r
402     int endSeq = y + vextent;\r
403     if (endSeq > av.alignment.getHeight())\r
404     {\r
405       endSeq = av.alignment.getHeight();\r
406     }\r
407 \r
408     av.setEndSeq(endSeq);\r
409     hscroll.setValues(x, hextent, 0, av.getAlignment().getWidth());\r
410     vscroll.setValues(y, vextent, 0, av.getAlignment().getHeight());\r
411 \r
412   }\r
413 \r
414   public void adjustmentValueChanged(AdjustmentEvent evt)\r
415   {\r
416     int oldX = av.getStartRes();\r
417     int oldY = av.getStartSeq();\r
418 \r
419     if (evt.getSource() == hscroll)\r
420     {\r
421       int x = hscroll.getValue();\r
422       av.setStartRes(x);\r
423       av.setEndRes(x + seqPanel.seqCanvas.getSize().width / av.getCharWidth() -\r
424                    1);\r
425     }\r
426 \r
427     if (evt.getSource() == vscroll)\r
428     {\r
429       int offy = vscroll.getValue();\r
430       if (av.getWrapAlignment())\r
431       {\r
432         int rowSize = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.\r
433             seqCanvas.getSize().width);\r
434         av.setStartRes(vscroll.getValue() * rowSize);\r
435         av.setEndRes( (vscroll.getValue() + 1) * rowSize);\r
436       }\r
437       else\r
438       {\r
439         av.setStartSeq(offy);\r
440         av.setEndSeq(offy +\r
441                      seqPanel.seqCanvas.getSize().height / av.getCharHeight());\r
442       }\r
443     }\r
444 \r
445     if (overviewPanel != null)\r
446     {\r
447       overviewPanel.setBoxPosition();\r
448     }\r
449 \r
450     if (av.getWrapAlignment() || !fastPaint || MAC)\r
451     {\r
452       repaint();\r
453     }\r
454     else\r
455     {\r
456       idPanel.idCanvas.fastPaint(av.getStartSeq() - oldY);\r
457       seqPanel.seqCanvas.fastPaint(av.getStartRes() - oldX,\r
458                                    av.getStartSeq() - oldY);\r
459 \r
460       scalePanel.repaint();\r
461       if (av.getShowAnnotation())\r
462       {\r
463         annotationPanel.fastPaint(av.getStartRes() - oldX);\r
464       }\r
465     }\r
466 \r
467   }\r
468 \r
469   public void update(Graphics g)\r
470   {\r
471     paint(g);\r
472   }\r
473 \r
474   public void paint(Graphics g)\r
475   {\r
476     Dimension d = idPanel.idCanvas.getSize();\r
477     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);\r
478     annotationSpaceFillerHolder.setSize(d.width,\r
479                                         annotationPanel.getSize().height);\r
480 \r
481     alabels.setSize(d.width, annotationPanel.getSize().height);\r
482 \r
483     if (av.getWrapAlignment())\r
484     {\r
485       int max = av.alignment.getWidth() /\r
486           seqPanel.seqCanvas.\r
487           getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);\r
488       vscroll.setMaximum(max);\r
489       vscroll.setUnitIncrement(1);\r
490       vscroll.setVisibleAmount(1);\r
491     }\r
492     else\r
493     {\r
494       setScrollValues(av.getStartRes(), av.getStartSeq());\r
495     }\r
496 \r
497     alabels.repaint();\r
498     idPanel.idCanvas.repaint();\r
499     seqPanel.seqCanvas.repaint();\r
500     scalePanel.repaint();\r
501     annotationPanel.repaint();\r
502 \r
503   }\r
504 }\r