Mapping to PDB added
[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       id = s.getDisplayId(av.getShowDBPrefix(), av.getShowJVSuffix());\r
208 \r
209       if (fm.stringWidth(id) > idWidth)\r
210       {\r
211         idWidth = fm.stringWidth(id);\r
212       }\r
213       i++;\r
214     }\r
215 \r
216     // Also check annotation label widths\r
217     i = 0;\r
218     if (al.getAlignmentAnnotation() != null)\r
219     {\r
220       fm = g.getFontMetrics(frame.getFont());\r
221       while (i < al.getAlignmentAnnotation().length)\r
222       {\r
223         String label = al.getAlignmentAnnotation()[i].label;\r
224         if (fm.stringWidth(label) > idWidth)\r
225         {\r
226           idWidth = fm.stringWidth(label);\r
227         }\r
228         i++;\r
229       }\r
230     }\r
231 \r
232     return new Dimension(idWidth, idPanel.idCanvas.getSize().height);\r
233   }\r
234 \r
235   public void highlightSearchResults(int[] results)\r
236   {\r
237     seqPanel.seqCanvas.highlightSearchResults(results);\r
238 \r
239     // do we need to scroll the panel?\r
240     if (results != null)\r
241     {\r
242       SequenceI seq = av.alignment.getSequenceAt(results[0]);\r
243       int start = seq.findIndex(results[1]) - 1;\r
244       int end = seq.findIndex(results[2]) - 1;\r
245       if (av.getStartRes() > start\r
246           || av.getEndRes() < end\r
247           || (av.getStartSeq() > results[0]\r
248               || av.getEndSeq() < results[0]))\r
249       {\r
250         setScrollValues(start, results[0]);\r
251       }\r
252     }\r
253 \r
254   }\r
255 \r
256   public OverviewPanel getOverviewPanel()\r
257   {\r
258     return overviewPanel;\r
259   }\r
260 \r
261   public void setOverviewPanel(OverviewPanel op)\r
262   {\r
263     overviewPanel = op;\r
264   }\r
265 \r
266   public void setAnnotationVisible(boolean b)\r
267   {\r
268     if (!av.wrapAlignment)\r
269     {\r
270       annotationSpaceFillerHolder.setVisible(b);\r
271       annotationScroller.setVisible(b);\r
272     }\r
273     validate();\r
274     repaint();\r
275   }\r
276 \r
277   public void setWrapAlignment(boolean wrap)\r
278   {\r
279     av.startSeq = 0;\r
280     scalePanelHolder.setVisible(!wrap);\r
281     hscroll.setVisible(!wrap);\r
282     idwidthAdjuster.setVisible(!wrap);\r
283 \r
284     if (wrap)\r
285     {\r
286       annotationScroller.setVisible(false);\r
287       annotationSpaceFillerHolder.setVisible(false);\r
288     }\r
289     else if (av.showAnnotation)\r
290     {\r
291       annotationScroller.setVisible(true);\r
292       annotationSpaceFillerHolder.setVisible(true);\r
293     }\r
294 \r
295     idSpaceFillerPanel1.setVisible(!wrap);\r
296 \r
297     validate();\r
298     repaint();\r
299 \r
300   }\r
301 \r
302 \r
303   int hextent = 0;\r
304   int vextent = 0;\r
305 \r
306   // return value is true if the scroll is valid\r
307   public boolean scrollUp(boolean up)\r
308   {\r
309     if (up)\r
310     {\r
311       if (vscroll.getValue() < 1)\r
312       {\r
313         return false;\r
314       }\r
315       fastPaint = false;\r
316       vscroll.setValue(vscroll.getValue() - 1);\r
317     }\r
318     else\r
319     {\r
320       if (vextent + vscroll.getValue() >= av.getAlignment().getHeight())\r
321       {\r
322         return false;\r
323       }\r
324       fastPaint = false;\r
325       vscroll.setValue(vscroll.getValue() + 1);\r
326     }\r
327     fastPaint = true;\r
328     return true;\r
329   }\r
330 \r
331   public boolean scrollRight(boolean right)\r
332   {\r
333 \r
334     if (right)\r
335     {\r
336       if (hscroll.getValue() < 1)\r
337       {\r
338         return false;\r
339       }\r
340       fastPaint = false;\r
341       hscroll.setValue(hscroll.getValue() - 1);\r
342     }\r
343     else\r
344     {\r
345       if (hextent + hscroll.getValue() >= av.getAlignment().getWidth())\r
346       {\r
347         return false;\r
348       }\r
349       fastPaint = false;\r
350       hscroll.setValue(hscroll.getValue() + 1);\r
351     }\r
352     fastPaint = true;\r
353     return true;\r
354   }\r
355 \r
356   public void setScrollValues(int x, int y)\r
357   {\r
358 \r
359     av.setStartRes(x);\r
360     av.setStartSeq(y);\r
361     av.setEndRes(x + seqPanel.seqCanvas.getSize().width / av.getCharWidth() - 1);\r
362 \r
363     hextent = seqPanel.seqCanvas.getSize().width / av.charWidth;\r
364     vextent = seqPanel.seqCanvas.getSize().height / av.charHeight;\r
365 \r
366     if (hextent > av.alignment.getWidth())\r
367     {\r
368       hextent = av.alignment.getWidth();\r
369     }\r
370     if (vextent > av.alignment.getHeight())\r
371     {\r
372       vextent = av.alignment.getHeight();\r
373     }\r
374 \r
375     if (hextent + x > av.getAlignment().getWidth())\r
376     {\r
377       x = av.getAlignment().getWidth() - hextent;\r
378     }\r
379 \r
380     if (vextent + y > av.getAlignment().getHeight())\r
381     {\r
382       y = av.getAlignment().getHeight() - vextent;\r
383     }\r
384 \r
385     if (y < 0)\r
386     {\r
387       y = 0;\r
388     }\r
389 \r
390     if (x < 0)\r
391     {\r
392       x = 0;\r
393     }\r
394 \r
395     int endSeq = y + vextent;\r
396     if (endSeq > av.alignment.getHeight())\r
397     {\r
398       endSeq = av.alignment.getHeight();\r
399     }\r
400 \r
401     av.setEndSeq(endSeq);\r
402     hscroll.setValues(x, hextent, 0, av.getAlignment().getWidth());\r
403     vscroll.setValues(y, vextent, 0, av.getAlignment().getHeight());\r
404 \r
405   }\r
406 \r
407   public void adjustmentValueChanged(AdjustmentEvent evt)\r
408   {\r
409     int oldX = av.getStartRes();\r
410     int oldY = av.getStartSeq();\r
411 \r
412     if (evt.getSource() == hscroll)\r
413     {\r
414       int x = hscroll.getValue();\r
415       av.setStartRes(x);\r
416       av.setEndRes(x + seqPanel.seqCanvas.getSize().width / av.getCharWidth() -\r
417                    1);\r
418     }\r
419 \r
420     if (evt.getSource() == vscroll)\r
421     {\r
422       int offy = vscroll.getValue();\r
423       if (av.getWrapAlignment())\r
424       {\r
425         int rowSize = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.\r
426             seqCanvas.getSize().width);\r
427         av.setStartRes(vscroll.getValue() * rowSize);\r
428         av.setEndRes( (vscroll.getValue() + 1) * rowSize);\r
429       }\r
430       else\r
431       {\r
432         av.setStartSeq(offy);\r
433         av.setEndSeq(offy +\r
434                      seqPanel.seqCanvas.getSize().height / av.getCharHeight());\r
435       }\r
436     }\r
437 \r
438     if (overviewPanel != null)\r
439     {\r
440       overviewPanel.setBoxPosition();\r
441     }\r
442 \r
443     if (av.getWrapAlignment() || !fastPaint || MAC)\r
444     {\r
445       repaint();\r
446     }\r
447     else\r
448     {\r
449       idPanel.idCanvas.fastPaint(av.getStartSeq() - oldY);\r
450       seqPanel.seqCanvas.fastPaint(av.getStartRes() - oldX,\r
451                                    av.getStartSeq() - oldY);\r
452 \r
453       scalePanel.repaint();\r
454       if (av.getShowAnnotation())\r
455       {\r
456         annotationPanel.fastPaint(av.getStartRes() - oldX);\r
457       }\r
458     }\r
459 \r
460   }\r
461 \r
462   public void update(Graphics g)\r
463   {\r
464     paint(g);\r
465   }\r
466 \r
467   public void paint(Graphics g)\r
468   {\r
469     Dimension d = idPanel.idCanvas.getSize();\r
470     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);\r
471     annotationSpaceFillerHolder.setSize(d.width,\r
472                                         annotationPanel.getSize().height);\r
473 \r
474     alabels.setSize(d.width, annotationPanel.getSize().height);\r
475 \r
476     if (av.getWrapAlignment())\r
477     {\r
478       int max = av.alignment.getWidth() /\r
479           seqPanel.seqCanvas.\r
480           getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);\r
481       vscroll.setMaximum(max);\r
482       vscroll.setUnitIncrement(1);\r
483       vscroll.setVisibleAmount(1);\r
484     }\r
485     else\r
486     {\r
487       setScrollValues(av.getStartRes(), av.getStartSeq());\r
488     }\r
489 \r
490     alabels.repaint();\r
491     idPanel.idCanvas.repaint();\r
492     seqPanel.seqCanvas.repaint();\r
493     scalePanel.repaint();\r
494     annotationPanel.repaint();\r
495 \r
496   }\r
497 }\r