H key updates
[jalview.git] / src / jalview / gui / 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 package jalview.gui;\r
20 \r
21 import jalview.datamodel.*;\r
22 \r
23 import jalview.jbgui.*;\r
24 \r
25 import jalview.schemes.*;\r
26 \r
27 import java.awt.*;\r
28 import java.awt.event.*;\r
29 import java.awt.print.*;\r
30 \r
31 import java.io.*;\r
32 \r
33 import javax.swing.*;\r
34 \r
35 \r
36 /**\r
37  * DOCUMENT ME!\r
38  *\r
39  * @author $author$\r
40  * @version $Revision$\r
41  */\r
42 public class AlignmentPanel extends GAlignmentPanel\r
43     implements AdjustmentListener, Printable\r
44 {\r
45   public AlignViewport av;\r
46   OverviewPanel overviewPanel;\r
47   SeqPanel seqPanel;\r
48   IdPanel idPanel;\r
49   IdwidthAdjuster idwidthAdjuster;\r
50 \r
51   /** DOCUMENT ME!! */\r
52   public AlignFrame alignFrame;\r
53   ScalePanel scalePanel;\r
54   AnnotationPanel annotationPanel;\r
55   AnnotationLabels alabels;\r
56 \r
57   // this value is set false when selection area being dragged\r
58   boolean fastPaint = true;\r
59   int hextent = 0;\r
60   int vextent = 0;\r
61 \r
62   /**\r
63    * Creates a new AlignmentPanel object.\r
64    *\r
65    * @param af DOCUMENT ME!\r
66    * @param av DOCUMENT ME!\r
67    */\r
68   public AlignmentPanel(AlignFrame af, final AlignViewport av)\r
69   {\r
70     alignFrame = af;\r
71     this.av = av;\r
72     seqPanel = new SeqPanel(av, this);\r
73     idPanel = new IdPanel(av, this);\r
74 \r
75     scalePanel = new ScalePanel(av, this);\r
76 \r
77     idPanelHolder.add(idPanel, BorderLayout.CENTER);\r
78     idwidthAdjuster = new IdwidthAdjuster(this);\r
79     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);\r
80 \r
81     annotationPanel = new AnnotationPanel(this);\r
82     alabels = new AnnotationLabels(this);\r
83 \r
84 \r
85     annotationScroller.setViewportView(annotationPanel);\r
86     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);\r
87 \r
88     fontChanged();\r
89 \r
90     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);\r
91     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);\r
92 \r
93     setScrollValues(0, 0);\r
94 \r
95     adjustAnnotationHeight();\r
96 \r
97     setAnnotationVisible(av.getShowAnnotation());\r
98 \r
99     hscroll.addAdjustmentListener(this);\r
100     vscroll.addAdjustmentListener(this);\r
101 \r
102     af.addKeyListener(new KeyAdapter()\r
103     {\r
104       public void keyPressed(KeyEvent evt)\r
105       {\r
106         if(av.cursorMode\r
107            && evt.getKeyCode()>=KeyEvent.VK_0\r
108            && evt.getKeyCode()<=KeyEvent.VK_9)\r
109         {\r
110           seqPanel.numberPressed(evt.getKeyChar());\r
111         }\r
112 \r
113         switch (evt.getKeyCode())\r
114         {\r
115           case 27: // escape key\r
116             alignFrame.deselectAllSequenceMenuItem_actionPerformed(null);\r
117 \r
118             break;\r
119 \r
120           case KeyEvent.VK_DOWN:\r
121             if(av.cursorMode)\r
122             {\r
123               seqPanel.moveCursor(0,1);\r
124             }\r
125             else\r
126               alignFrame.moveSelectedSequences(false);\r
127             break;\r
128 \r
129           case KeyEvent.VK_UP:\r
130             if (av.cursorMode)\r
131             {\r
132               seqPanel.moveCursor(0,-1);\r
133             }\r
134             else\r
135               alignFrame.moveSelectedSequences(true);\r
136             break;\r
137 \r
138           case KeyEvent.VK_LEFT:\r
139             if(av.cursorMode)\r
140             {\r
141               seqPanel.moveCursor(-1,0);\r
142             }\r
143             break;\r
144 \r
145           case KeyEvent.VK_RIGHT:\r
146             if (av.cursorMode)\r
147             {\r
148               seqPanel.moveCursor(1,0);\r
149             }\r
150             break;\r
151 \r
152           case KeyEvent.VK_SPACE:\r
153             if(av.cursorMode)\r
154             {\r
155               seqPanel.insertGapAtCursor(evt.isControlDown() || evt.isShiftDown());\r
156             }\r
157             break;\r
158 \r
159           case KeyEvent.VK_DELETE:\r
160           case KeyEvent.VK_BACK_SPACE:\r
161             if(!av.cursorMode)\r
162             {\r
163               alignFrame.cut_actionPerformed(null);\r
164             }\r
165             else\r
166               seqPanel.deleteGapAtCursor(evt.isControlDown() || evt.isShiftDown());\r
167 \r
168             break;\r
169 \r
170           case KeyEvent.VK_S:\r
171             if(av.cursorMode)\r
172             {\r
173               seqPanel.setCursorRow();\r
174             }\r
175             break;\r
176           case KeyEvent.VK_C:\r
177             if(av.cursorMode && !evt.isControlDown())\r
178             {\r
179               seqPanel.setCursorColumn();\r
180             }\r
181             break;\r
182           case KeyEvent.VK_P:\r
183             if(av.cursorMode)\r
184             {\r
185               seqPanel.setCursorPosition();\r
186             }\r
187             break;\r
188 \r
189           case KeyEvent.VK_ENTER:\r
190           case KeyEvent.VK_COMMA:\r
191             if(av.cursorMode)\r
192             {\r
193               seqPanel.setCursorRowAndColumn();\r
194             }\r
195             break;\r
196 \r
197           case KeyEvent.VK_Q:\r
198             if(av.cursorMode)\r
199             {\r
200               seqPanel.setSelectionAreaAtCursor(true);\r
201             }\r
202             break;\r
203           case KeyEvent.VK_M:\r
204             if(av.cursorMode)\r
205             {\r
206               seqPanel.setSelectionAreaAtCursor(false);\r
207             }\r
208             break;\r
209 \r
210          case KeyEvent.VK_F2:\r
211            av.cursorMode = ! av.cursorMode;\r
212            alignFrame.statusBar.setText("Keyboard editing mode is "+\r
213                (av.cursorMode ? "on" : "off"));\r
214            if(av.cursorMode)\r
215            {\r
216              seqPanel.seqCanvas.cursorX = av.startRes;\r
217              seqPanel.seqCanvas.cursorY = av.startSeq;\r
218            }\r
219            seqPanel.seqCanvas.repaint();\r
220            break;\r
221 \r
222           case KeyEvent.VK_F1:\r
223             try\r
224             {\r
225               ClassLoader cl = jalview.gui.Desktop.class.getClassLoader();\r
226               java.net.URL url = javax.help.HelpSet.findHelpSet(cl, "help/help");\r
227               javax.help.HelpSet hs = new javax.help.HelpSet(cl, url);\r
228 \r
229               javax.help.HelpBroker hb = hs.createHelpBroker();\r
230               hb.setCurrentID("home");\r
231               hb.setDisplayed(true);\r
232             }\r
233             catch (Exception ex)\r
234             {\r
235               ex.printStackTrace();\r
236             }\r
237             break;\r
238           case KeyEvent.VK_H:\r
239           {\r
240             boolean toggleSeqs = !evt.isControlDown();\r
241             boolean toggleCols = !evt.isShiftDown();\r
242 \r
243             boolean hide = false;\r
244 \r
245             SequenceGroup sg = av.getSelectionGroup();\r
246             if(toggleSeqs)\r
247              {\r
248                if(sg != null && sg.getSize(false) != av.alignment.getHeight())\r
249                {\r
250                  alignFrame.hideSelSequences_actionPerformed(null);\r
251                  hide = true;\r
252                }\r
253                else if (!(toggleCols && av.colSel.getSelected().size() > 0))\r
254                  alignFrame.showAllSeqs_actionPerformed(null);\r
255              }\r
256 \r
257              if (toggleCols)\r
258              {\r
259                if(av.colSel.getSelected().size() > 0)\r
260                {\r
261                  alignFrame.hideSelColumns_actionPerformed(null);\r
262                  if(!toggleSeqs)\r
263                    av.selectionGroup = sg;\r
264                }\r
265                else if(!hide)\r
266                  alignFrame.showAllColumns_actionPerformed(null);\r
267              }\r
268             break;\r
269           }\r
270 \r
271         }\r
272       }\r
273     });\r
274   }\r
275 \r
276   /**\r
277    * DOCUMENT ME!\r
278    */\r
279   public void fontChanged()\r
280   {\r
281     // set idCanvas bufferedImage to null\r
282     // to prevent drawing old image\r
283     FontMetrics fm = getFontMetrics(av.getFont());\r
284 \r
285     scalePanelHolder.setPreferredSize(new Dimension(10,\r
286         av.charHeight + fm.getDescent()));\r
287     idSpaceFillerPanel1.setPreferredSize(new Dimension(10,\r
288         av.charHeight + fm.getDescent()));\r
289 \r
290     idPanel.idCanvas.gg = null;\r
291     seqPanel.seqCanvas.img = null;\r
292     annotationPanel.adjustPanelHeight();\r
293 \r
294     Dimension d = calculateIdWidth();\r
295     d.setSize(d.width + 4, d.height);\r
296     idPanel.idCanvas.setPreferredSize(d);\r
297     hscrollFillerPanel.setPreferredSize(d);\r
298 \r
299     if (av.getWrapAlignment())\r
300     {\r
301       int max = av.alignment.getWidth() /\r
302           seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());\r
303       vscroll.setMaximum(max);\r
304       vscroll.setUnitIncrement(1);\r
305       vscroll.setVisibleAmount(1);\r
306     }\r
307     else\r
308     {\r
309       setScrollValues(av.getStartRes(), av.getStartSeq());\r
310     }\r
311 \r
312     if (overviewPanel != null)\r
313       overviewPanel.setBoxPosition();\r
314 \r
315     repaint();\r
316   }\r
317 \r
318   /**\r
319    * DOCUMENT ME!\r
320    *\r
321    * @return DOCUMENT ME!\r
322    */\r
323   public Dimension calculateIdWidth()\r
324   {\r
325     Container c = new Container();\r
326 \r
327     FontMetrics fm = c.getFontMetrics(av.font);\r
328     AlignmentI al = av.getAlignment();\r
329 \r
330     int i = 0;\r
331     int idWidth = 0;\r
332     String id;\r
333 \r
334     while ( (i < al.getHeight()) && (al.getSequenceAt(i) != null))\r
335     {\r
336       SequenceI s = al.getSequenceAt(i);\r
337 \r
338       id = s.getDisplayId(av.getShowJVSuffix());\r
339 \r
340       if (fm.stringWidth(id) > idWidth)\r
341       {\r
342         idWidth = fm.stringWidth(id);\r
343       }\r
344 \r
345       i++;\r
346     }\r
347 \r
348     // Also check annotation label widths\r
349     i = 0;\r
350 \r
351     if (al.getAlignmentAnnotation() != null)\r
352     {\r
353       fm = c.getFontMetrics(alabels.getFont());\r
354 \r
355       while (i < al.getAlignmentAnnotation().length)\r
356       {\r
357         String label = al.getAlignmentAnnotation()[i].label;\r
358 \r
359         if (fm.stringWidth(label) > idWidth)\r
360         {\r
361           idWidth = fm.stringWidth(label);\r
362         }\r
363 \r
364         i++;\r
365       }\r
366     }\r
367 \r
368     return new Dimension(idWidth, 12);\r
369   }\r
370 \r
371   /**\r
372    * DOCUMENT ME!\r
373    *\r
374    * @param results DOCUMENT ME!\r
375    */\r
376   public void highlightSearchResults(SearchResults results)\r
377   {\r
378     seqPanel.seqCanvas.highlightSearchResults(results);\r
379 \r
380     // do we need to scroll the panel?\r
381     if (results != null)\r
382     {\r
383       SequenceI seq = results.getResultSequence(0);\r
384       int seqIndex = av.alignment.findIndex(seq);\r
385       int start = seq.findIndex(results.getResultStart(0)) - 1;\r
386       int end = seq.findIndex(results.getResultEnd(0)) - 1;\r
387 \r
388       if(!av.wrapAlignment)\r
389       {\r
390         if ( (av.getStartRes() > end)  || (av.getEndRes() < start) ||\r
391            ( (av.getStartSeq() > seqIndex) || (av.getEndSeq() < seqIndex)))\r
392         {\r
393           setScrollValues(start, seqIndex);\r
394         }\r
395       }\r
396       else\r
397       {\r
398         scrollToWrappedVisible(start);\r
399       }\r
400     }\r
401   }\r
402 \r
403   void scrollToWrappedVisible(int res)\r
404   {\r
405     int cwidth = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());\r
406     if( res<=av.getStartRes() || res>=(av.getStartRes()+cwidth) )\r
407     {\r
408       vscroll.setValue(res / cwidth);\r
409       av.startRes = vscroll.getValue() * cwidth;\r
410     }\r
411   }\r
412 \r
413   /**\r
414    * DOCUMENT ME!\r
415    *\r
416    * @return DOCUMENT ME!\r
417    */\r
418   public OverviewPanel getOverviewPanel()\r
419   {\r
420     return overviewPanel;\r
421   }\r
422 \r
423   /**\r
424    * DOCUMENT ME!\r
425    *\r
426    * @param op DOCUMENT ME!\r
427    */\r
428   public void setOverviewPanel(OverviewPanel op)\r
429   {\r
430     overviewPanel = op;\r
431   }\r
432 \r
433   /**\r
434    * DOCUMENT ME!\r
435    *\r
436    * @param b DOCUMENT ME!\r
437    */\r
438   public void setAnnotationVisible(boolean b)\r
439   {\r
440     if (!av.wrapAlignment)\r
441     {\r
442       annotationSpaceFillerHolder.setVisible(b);\r
443       annotationScroller.setVisible(b);\r
444     }\r
445     repaint();\r
446   }\r
447 \r
448   public void adjustAnnotationHeight()\r
449   {\r
450     javax.swing.SwingUtilities.invokeLater(new Runnable()\r
451     {\r
452       public void run()\r
453       {\r
454           while(alignFrame.getHeight()==0)\r
455           {\r
456             Thread.yield();\r
457           }\r
458 \r
459         int height = annotationPanel.adjustPanelHeight();\r
460 \r
461         if (height > alignFrame.getHeight() / 2)\r
462         {\r
463           height = alignFrame.getHeight() / 2;\r
464         }\r
465 \r
466         annotationScroller.setPreferredSize(\r
467             new Dimension(annotationScroller.getWidth(),\r
468                           height));\r
469 \r
470         annotationSpaceFillerHolder.setPreferredSize(new Dimension(\r
471             annotationSpaceFillerHolder.getWidth(),\r
472             height));\r
473 \r
474         annotationPanel.repaint();\r
475       }\r
476     });\r
477   }\r
478 \r
479   /**\r
480    * DOCUMENT ME!\r
481    *\r
482    * @param wrap DOCUMENT ME!\r
483    */\r
484   public void setWrapAlignment(boolean wrap)\r
485   {\r
486     av.startSeq = 0;\r
487     scalePanelHolder.setVisible(!wrap);\r
488     hscroll.setVisible(!wrap);\r
489     idwidthAdjuster.setVisible(!wrap);\r
490 \r
491     if (wrap)\r
492     {\r
493       annotationScroller.setVisible(false);\r
494       annotationSpaceFillerHolder.setVisible(false);\r
495     }\r
496     else if (av.showAnnotation)\r
497     {\r
498       annotationScroller.setVisible(true);\r
499       annotationSpaceFillerHolder.setVisible(true);\r
500     }\r
501 \r
502     idSpaceFillerPanel1.setVisible(!wrap);\r
503 \r
504     repaint();\r
505   }\r
506 \r
507   // return value is true if the scroll is valid\r
508   public boolean scrollUp(boolean up)\r
509   {\r
510     if (up)\r
511     {\r
512       if (vscroll.getValue() < 1)\r
513       {\r
514         return false;\r
515       }\r
516 \r
517       fastPaint = false;\r
518       vscroll.setValue(vscroll.getValue() - 1);\r
519     }\r
520     else\r
521     {\r
522       if ( (vextent + vscroll.getValue()) >= av.getAlignment().getHeight())\r
523       {\r
524         return false;\r
525       }\r
526 \r
527       fastPaint = false;\r
528       vscroll.setValue(vscroll.getValue() + 1);\r
529     }\r
530 \r
531     fastPaint = true;\r
532 \r
533     return true;\r
534   }\r
535 \r
536   /**\r
537    * DOCUMENT ME!\r
538    *\r
539    * @param right DOCUMENT ME!\r
540    *\r
541    * @return DOCUMENT ME!\r
542    */\r
543   public boolean scrollRight(boolean right)\r
544   {\r
545     if (!right)\r
546     {\r
547       if (hscroll.getValue() < 1)\r
548       {\r
549         return false;\r
550       }\r
551 \r
552       fastPaint = false;\r
553       hscroll.setValue(hscroll.getValue() - 1);\r
554     }\r
555     else\r
556     {\r
557       if ( (hextent + hscroll.getValue()) >= av.getAlignment().getWidth())\r
558       {\r
559         return false;\r
560       }\r
561 \r
562       fastPaint = false;\r
563       hscroll.setValue(hscroll.getValue() + 1);\r
564     }\r
565 \r
566     fastPaint = true;\r
567 \r
568     return true;\r
569   }\r
570 \r
571   /**\r
572    * DOCUMENT ME!\r
573    *\r
574    * @param x DOCUMENT ME!\r
575    * @param y DOCUMENT ME!\r
576    */\r
577   public void setScrollValues(int x, int y)\r
578   {\r
579 \r
580     int width = av.alignment.getWidth();\r
581     int height = av.alignment.getHeight();\r
582 \r
583     if(av.hasHiddenColumns)\r
584      width = av.getColumnSelection().findColumnPosition(width);\r
585 \r
586     av.setEndRes( (x + (seqPanel.seqCanvas.getWidth() / av.charWidth)) -1);\r
587 \r
588     hextent = seqPanel.seqCanvas.getWidth() / av.charWidth;\r
589     vextent = seqPanel.seqCanvas.getHeight() / av.charHeight;\r
590 \r
591     if (hextent > width)\r
592     {\r
593       hextent = width;\r
594     }\r
595 \r
596     if (vextent > height)\r
597     {\r
598       vextent = height;\r
599     }\r
600 \r
601     if ( (hextent + x) > width)\r
602     {\r
603       x = width - hextent;\r
604     }\r
605 \r
606     if ( (vextent + y) > height)\r
607     {\r
608       y = height - vextent;\r
609     }\r
610 \r
611     if (y < 0)\r
612     {\r
613       y = 0;\r
614     }\r
615 \r
616     if (x < 0)\r
617     {\r
618       x = 0;\r
619     }\r
620 \r
621     hscroll.setValues(x, hextent, 0, width);\r
622     vscroll.setValues(y, vextent, 0, height);\r
623   }\r
624 \r
625   /**\r
626    * DOCUMENT ME!\r
627    *\r
628    * @param evt DOCUMENT ME!\r
629    */\r
630   public void adjustmentValueChanged(AdjustmentEvent evt)\r
631   {\r
632 \r
633     int oldX = av.getStartRes();\r
634     int oldY = av.getStartSeq();\r
635 \r
636     if (evt.getSource() == hscroll)\r
637     {\r
638       int x = hscroll.getValue();\r
639       av.setStartRes(x);\r
640       av.setEndRes( (x +\r
641                      (seqPanel.seqCanvas.getWidth() / av.getCharWidth())) - 1);\r
642     }\r
643 \r
644     if (evt.getSource() == vscroll)\r
645     {\r
646       int offy = vscroll.getValue();\r
647 \r
648       if (av.getWrapAlignment())\r
649       {\r
650         if(offy>-1)\r
651         {\r
652           int rowSize = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.\r
653               seqCanvas.getWidth());\r
654           av.setStartRes(offy * rowSize);\r
655           av.setEndRes( (offy + 1) * rowSize);\r
656         }\r
657         else\r
658         {\r
659           //This is only called if file loaded is a jar file that\r
660           //was wrapped when saved and user has wrap alignment true\r
661           //as preference setting\r
662           SwingUtilities.invokeLater(new Runnable()\r
663               {\r
664                 public void run()\r
665                 {\r
666                   setScrollValues(av.getStartRes(), av.getStartSeq());\r
667                 }\r
668               });\r
669         }\r
670       }\r
671       else\r
672       {\r
673         av.setStartSeq(offy);\r
674         av.setEndSeq(offy +\r
675                      (seqPanel.seqCanvas.getHeight() / av.getCharHeight()));\r
676       }\r
677     }\r
678 \r
679     if (overviewPanel != null)\r
680     {\r
681       overviewPanel.setBoxPosition();\r
682     }\r
683 \r
684     int scrollX = av.startRes - oldX;\r
685     int scrollY = av.startSeq - oldY;\r
686 \r
687     if (av.getWrapAlignment() || !fastPaint)\r
688     {\r
689       repaint();\r
690     }\r
691     else\r
692     {\r
693       // Make sure we're not trying to draw a panel\r
694       // larger than the visible window\r
695       if(scrollX>av.endRes-av.startRes)\r
696         scrollX = av.endRes-av.startRes;\r
697       else if(scrollX<av.startRes-av.endRes)\r
698         scrollX = av.startRes - av.endRes;\r
699 \r
700       if(scrollX!=0 || scrollY!=0)\r
701       {\r
702         idPanel.idCanvas.fastPaint(scrollY);\r
703         seqPanel.seqCanvas.fastPaint(scrollX,\r
704                                      scrollY);\r
705         scalePanel.repaint();\r
706 \r
707         if (av.getShowAnnotation())\r
708         {\r
709           annotationPanel.fastPaint(scrollX);\r
710         }\r
711       }\r
712     }\r
713   }\r
714 \r
715   /**\r
716    * DOCUMENT ME!\r
717    *\r
718    * @param g DOCUMENT ME!\r
719    */\r
720   public void paintComponent(Graphics g)\r
721   {\r
722     invalidate();\r
723 \r
724     Dimension d = idPanel.idCanvas.getPreferredSize();\r
725     idPanelHolder.setPreferredSize(d);\r
726     hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));\r
727     validate();\r
728 \r
729     if (av.getWrapAlignment())\r
730     {\r
731       int maxwidth = av.alignment.getWidth();\r
732 \r
733       if (av.hasHiddenColumns)\r
734         maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
735 \r
736       int max = maxwidth /\r
737           seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth()) +\r
738           1;\r
739 \r
740 \r
741       vscroll.setMaximum(max);\r
742       vscroll.setUnitIncrement(1);\r
743       vscroll.setVisibleAmount(1);\r
744     }\r
745     else\r
746     {\r
747       setScrollValues(av.getStartRes(), av.getStartSeq());\r
748     }\r
749 \r
750     if( this.getVisibleRect().getBounds() == g.getClipBounds()\r
751         && overviewPanel != null)\r
752         overviewPanel.updateOverviewImage();\r
753 \r
754   }\r
755 \r
756   /**\r
757    * DOCUMENT ME!\r
758    *\r
759    * @param pg DOCUMENT ME!\r
760    * @param pf DOCUMENT ME!\r
761    * @param pi DOCUMENT ME!\r
762    *\r
763    * @return DOCUMENT ME!\r
764    *\r
765    * @throws PrinterException DOCUMENT ME!\r
766    */\r
767   public int print(Graphics pg, PageFormat pf, int pi)\r
768       throws PrinterException\r
769   {\r
770     pg.translate( (int) pf.getImageableX(), (int) pf.getImageableY());\r
771 \r
772     int pwidth = (int) pf.getImageableWidth();\r
773     int pheight = (int) pf.getImageableHeight();\r
774 \r
775     if (av.getWrapAlignment())\r
776     {\r
777       return printWrappedAlignment(pg, pwidth, pheight, pi);\r
778     }\r
779     else\r
780     {\r
781       return printUnwrapped(pg, pwidth, pheight, pi);\r
782     }\r
783   }\r
784 \r
785   /**\r
786    * DOCUMENT ME!\r
787    *\r
788    * @param pg DOCUMENT ME!\r
789    * @param pwidth DOCUMENT ME!\r
790    * @param pheight DOCUMENT ME!\r
791    * @param pi DOCUMENT ME!\r
792    *\r
793    * @return DOCUMENT ME!\r
794    *\r
795    * @throws PrinterException DOCUMENT ME!\r
796    */\r
797   public int printUnwrapped(Graphics pg, int pwidth, int pheight, int pi)\r
798       throws PrinterException\r
799   {\r
800     int idWidth = calculateIdWidth().width + 4;\r
801     FontMetrics fm = getFontMetrics(av.getFont());\r
802     int scaleHeight = av.charHeight + fm.getDescent();\r
803 \r
804     pg.setColor(Color.white);\r
805     pg.fillRect(0, 0, pwidth, pheight);\r
806     pg.setFont(av.getFont());\r
807 \r
808     ////////////////////////////////////\r
809     /// How many sequences and residues can we fit on a printable page?\r
810     int totalRes = (pwidth - idWidth) / av.getCharWidth();\r
811 \r
812     int totalSeq = (int) ( (pheight - scaleHeight) / av.getCharHeight()) -\r
813         1;\r
814 \r
815     int pagesWide = (av.getAlignment().getWidth() / totalRes) + 1;\r
816 \r
817     /////////////////////////////\r
818     /// Only print these sequences and residues on this page\r
819     int startRes;\r
820 \r
821     /////////////////////////////\r
822     /// Only print these sequences and residues on this page\r
823     int endRes;\r
824 \r
825     /////////////////////////////\r
826     /// Only print these sequences and residues on this page\r
827     int startSeq;\r
828 \r
829     /////////////////////////////\r
830     /// Only print these sequences and residues on this page\r
831     int endSeq;\r
832     startRes = (pi % pagesWide) * totalRes;\r
833     endRes = (startRes + totalRes) - 1;\r
834 \r
835     if (endRes > (av.getAlignment().getWidth() - 1))\r
836     {\r
837       endRes = av.getAlignment().getWidth() - 1;\r
838     }\r
839 \r
840     startSeq = (pi / pagesWide) * totalSeq;\r
841     endSeq = startSeq + totalSeq;\r
842 \r
843     if (endSeq > av.getAlignment().getHeight())\r
844     {\r
845       endSeq = av.getAlignment().getHeight();\r
846     }\r
847 \r
848     int pagesHigh = ( (av.alignment.getHeight() / totalSeq) + 1) * pheight;\r
849 \r
850     if (av.showAnnotation)\r
851     {\r
852       pagesHigh += annotationPanel.adjustPanelHeight() + 3;\r
853     }\r
854 \r
855     pagesHigh /= pheight;\r
856 \r
857     if (pi >= (pagesWide * pagesHigh))\r
858     {\r
859       return Printable.NO_SUCH_PAGE;\r
860     }\r
861 \r
862     //draw Scale\r
863     pg.translate(idWidth, 0);\r
864     scalePanel.drawScale(pg, startRes, endRes, pwidth - idWidth, scaleHeight);\r
865     pg.translate( -idWidth, scaleHeight);\r
866 \r
867     ////////////////\r
868     // Draw the ids\r
869     Color currentColor = null;\r
870     Color currentTextColor = null;\r
871 \r
872     pg.setFont(new Font(av.getFont().getName(),\r
873                         Font.ITALIC,\r
874                         av.getFont().getSize()));\r
875     for (int i = startSeq; i < endSeq; i++)\r
876     {\r
877       if ( (av.getSelectionGroup() != null) &&\r
878           av.getSelectionGroup().getSequences(false).contains(\r
879               av.getAlignment().getSequenceAt(i)))\r
880       {\r
881         currentColor = Color.gray;\r
882         currentTextColor = Color.black;\r
883       }\r
884       else\r
885       {\r
886         currentColor = av.getAlignment().getSequenceAt(i).getColor();\r
887         currentTextColor = Color.black;\r
888       }\r
889 \r
890       pg.setColor(currentColor);\r
891       pg.fillRect(0, (i - startSeq) * av.charHeight, idWidth,\r
892                   av.getCharHeight());\r
893 \r
894       pg.setColor(currentTextColor);\r
895 \r
896       String string = av.getAlignment().getSequenceAt(i).getDisplayId\r
897           ( av.getShowJVSuffix());\r
898 \r
899       pg.drawString(string, 0,\r
900                     ( ( (i - startSeq) * av.charHeight) + av.getCharHeight()) -\r
901                     (av.getCharHeight() / 5));\r
902     }\r
903 \r
904     pg.setFont(av.getFont());\r
905 \r
906     // draw main sequence panel\r
907     pg.translate(idWidth, 0);\r
908     seqPanel.seqCanvas.drawPanel(pg, startRes, endRes, startSeq, endSeq, 0);\r
909 \r
910     if (av.showAnnotation && (endSeq == av.alignment.getHeight()))\r
911     {\r
912       pg.translate( -idWidth-3, (endSeq - startSeq) * av.charHeight + 3);\r
913       alabels.drawComponent( (Graphics2D) pg, idWidth);\r
914       pg.translate(idWidth+3, 0);\r
915       annotationPanel.drawComponent( (Graphics2D) pg, startRes, endRes +\r
916                                     1);\r
917     }\r
918 \r
919     return Printable.PAGE_EXISTS;\r
920   }\r
921 \r
922   /**\r
923    * DOCUMENT ME!\r
924    *\r
925    * @param pg DOCUMENT ME!\r
926    * @param pwidth DOCUMENT ME!\r
927    * @param pheight DOCUMENT ME!\r
928    * @param pi DOCUMENT ME!\r
929    *\r
930    * @return DOCUMENT ME!\r
931    *\r
932    * @throws PrinterException DOCUMENT ME!\r
933    */\r
934   public int printWrappedAlignment(Graphics pg, int pwidth, int pheight,\r
935                                    int pi)\r
936       throws PrinterException\r
937   {\r
938 \r
939     int annotationHeight = 0;\r
940     AnnotationLabels labels = null;\r
941     if (av.showAnnotation)\r
942     {\r
943       annotationHeight = annotationPanel.adjustPanelHeight();\r
944       labels = new AnnotationLabels(av);\r
945     }\r
946 \r
947     int hgap = av.charHeight;\r
948     if (av.scaleAboveWrapped)\r
949       hgap += av.charHeight;\r
950 \r
951     int cHeight = av.getAlignment().getHeight() * av.charHeight\r
952         + hgap\r
953         + annotationHeight;\r
954 \r
955     int idWidth = calculateIdWidth().width + 4;\r
956 \r
957     int maxwidth = av.alignment.getWidth();\r
958     if (av.hasHiddenColumns)\r
959       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
960 \r
961 \r
962     int resWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(pwidth -\r
963         idWidth);\r
964 \r
965     int totalHeight = cHeight * (maxwidth / resWidth + 1);\r
966 \r
967     pg.setColor(Color.white);\r
968     pg.fillRect(0, 0, pwidth, pheight);\r
969     pg.setFont(av.getFont());\r
970 \r
971     ////////////////\r
972     // Draw the ids\r
973     pg.setColor(Color.black);\r
974 \r
975     pg.translate(0, -pi * pheight);\r
976 \r
977     pg.setClip(0, pi * pheight, pwidth, pheight);\r
978 \r
979     int ypos = hgap;\r
980     Font italic = new Font(av.getFont().getName(), Font.ITALIC,\r
981                            av.getFont().getSize());\r
982     pg.setFont(italic);\r
983 \r
984     do\r
985     {\r
986       for (int i = 0; i < av.alignment.getHeight(); i++)\r
987       {\r
988         SequenceI s = av.alignment.getSequenceAt(i);\r
989         String string = s.getDisplayId( av.getShowJVSuffix());\r
990 \r
991         pg.drawString(string, 0,\r
992                       ( (i * av.charHeight) + ypos + av.charHeight) -\r
993                       (av.charHeight / 5));\r
994       }\r
995       if (labels != null)\r
996       {\r
997         pg.translate(-3,\r
998                      ypos +\r
999                      (av.getAlignment().getHeight() * av.charHeight));\r
1000 \r
1001         pg.setFont(av.getFont());\r
1002         labels.drawComponent(pg, idWidth);\r
1003         pg.setFont(italic);\r
1004         pg.translate(+3,\r
1005                      -ypos -\r
1006                      (av.getAlignment().getHeight() * av.charHeight));\r
1007       }\r
1008 \r
1009       ypos += cHeight;\r
1010     }\r
1011     while (ypos < totalHeight);\r
1012 \r
1013     pg.translate(idWidth, 0);\r
1014 \r
1015     seqPanel.seqCanvas.drawWrappedPanel(pg, pwidth - idWidth, totalHeight, 0);\r
1016 \r
1017     if ( (pi * pheight) < totalHeight)\r
1018     {\r
1019       return Printable.PAGE_EXISTS;\r
1020 \r
1021     }\r
1022     else\r
1023     {\r
1024       return Printable.NO_SUCH_PAGE;\r
1025     }\r
1026   }\r
1027 \r
1028   void makeAlignmentImage(int type, File file)\r
1029   {\r
1030     int maxwidth = av.alignment.getWidth();\r
1031     if (av.hasHiddenColumns)\r
1032       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);\r
1033 \r
1034     int height = ( (av.alignment.getHeight() + 1) * av.charHeight) + 30;\r
1035     int width = idPanel.getWidth() + (maxwidth * av.charWidth);\r
1036     if (idPanel.getWidth() == 0)\r
1037     {\r
1038       width += calculateIdWidth().getWidth() + 4;\r
1039     }\r
1040 \r
1041     if (av.getWrapAlignment())\r
1042     {\r
1043       height = getWrappedHeight();\r
1044       if (System.getProperty("java.awt.headless") != null\r
1045           && System.getProperty("java.awt.headless").equals("true"))\r
1046       {\r
1047         width = alignFrame.getWidth() - 22;\r
1048       }\r
1049       else\r
1050         width = seqPanel.getWidth() + idPanel.getWidth();\r
1051 \r
1052     }\r
1053     else if (av.getShowAnnotation())\r
1054     {\r
1055       height += annotationPanel.adjustPanelHeight() + 3;\r
1056     }\r
1057 \r
1058     jalview.util.ImageMaker im;\r
1059     if(type==jalview.util.ImageMaker.PNG)\r
1060       im  = new jalview.util.ImageMaker(this,\r
1061                                         jalview.util.ImageMaker.PNG,\r
1062                                         "Create PNG image from alignment",\r
1063                                         width, height, file, null);\r
1064     else\r
1065       im = new jalview.util.ImageMaker(this,\r
1066                                         jalview.util.ImageMaker.EPS,\r
1067                                        "Create EPS file from alignment",\r
1068                                         width, height, file, alignFrame.getTitle() );\r
1069 \r
1070     try\r
1071     {\r
1072       if (av.getWrapAlignment())\r
1073       {\r
1074         if(im.getGraphics()!=null)\r
1075         {\r
1076           printWrappedAlignment(im.getGraphics(), width, height, 0);\r
1077           im.writeImage();\r
1078         }\r
1079       }\r
1080       else\r
1081       {\r
1082         if(im.getGraphics()!=null)\r
1083         {\r
1084           printUnwrapped(im.getGraphics(), width, height, 0);\r
1085           im.writeImage();\r
1086         }\r
1087       }\r
1088     }\r
1089     catch (OutOfMemoryError err)\r
1090     {\r
1091       System.out.println("########################\n"\r
1092                          + "OUT OF MEMORY " + file + "\n"\r
1093                          + "########################");\r
1094 \r
1095       JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
1096                                             "Out of Memory Creating Image!!"\r
1097                                             +\r
1098                                             "\nSee help files for increasing Java Virtual Machine memory."\r
1099                                             , "Out of memory",\r
1100                                             JOptionPane.WARNING_MESSAGE);\r
1101       System.out.println("Create IMAGE: " + err);\r
1102       System.gc();\r
1103 \r
1104     }\r
1105     catch (Exception ex)\r
1106     {\r
1107       ex.printStackTrace();\r
1108     }\r
1109   }\r
1110   /**\r
1111    * DOCUMENT ME!\r
1112    */\r
1113   public void makeEPS(File epsFile)\r
1114   {\r
1115     makeAlignmentImage(jalview.util.ImageMaker.EPS, epsFile);\r
1116   }\r
1117 \r
1118   /**\r
1119    * DOCUMENT ME!\r
1120    */\r
1121   public void makePNG(File pngFile)\r
1122   {\r
1123     makeAlignmentImage(jalview.util.ImageMaker.PNG, pngFile);\r
1124   }\r
1125 \r
1126   public void makePNGImageMap(File imgMapFile, String imageName)\r
1127   {\r
1128     ///////ONLY WORKS WITH NONE WRAPPED ALIGNMENTS\r
1129     //////////////////////////////////////////////\r
1130     int idWidth = calculateIdWidth().width + 4;\r
1131     FontMetrics fm = getFontMetrics(av.getFont());\r
1132     int scaleHeight = av.charHeight + fm.getDescent();\r
1133 \r
1134     // Gen image map\r
1135     //////////////////////////////////\r
1136     if (imgMapFile != null)\r
1137     {\r
1138       try\r
1139       {\r
1140         int s, sSize = av.alignment.getHeight(),\r
1141             res, alwidth = av.alignment.getWidth(), g, gSize, f, fSize, sy;\r
1142         StringBuffer text = new StringBuffer();\r
1143         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));\r
1144         out.println(jalview.io.HTMLOutput.getImageMapHTML());\r
1145         out.println("<img src=\"" + imageName +\r
1146                     "\" border=\"0\" usemap=\"#Map\" >"\r
1147                     + "<map name=\"Map\">");\r
1148 \r
1149         for (s = 0; s < sSize; s++)\r
1150         {\r
1151           sy = s * av.charHeight + scaleHeight;\r
1152 \r
1153           SequenceI seq = av.alignment.getSequenceAt(s);\r
1154           SequenceFeature [] features = seq.getDatasetSequence().getSequenceFeatures();\r
1155           SequenceGroup[] groups = av.alignment.findAllGroups(seq);\r
1156           for(res =0; res<alwidth; res++)\r
1157           {\r
1158             text = new StringBuffer();\r
1159             Object obj = null;\r
1160             if(av.alignment.isNucleotide())\r
1161               obj = ResidueProperties.nucleotideName.get(seq.getCharAt(res)+"" );\r
1162             else\r
1163               obj = ResidueProperties.aa2Triplet.get(\r
1164                     seq.getCharAt(res) + "");\r
1165 \r
1166               if (obj == null)\r
1167                   continue;\r
1168 \r
1169             String triplet = obj.toString();\r
1170             int alIndex = seq.findPosition(res);\r
1171             gSize = groups.length;\r
1172             for (g = 0; g < gSize; g++)\r
1173             {\r
1174               if(text.length()<1)\r
1175               {\r
1176                 text.append("<area shape=\"rect\" coords=\""\r
1177                   + (idWidth + res * av.charWidth) + ","\r
1178                   + sy + ","\r
1179                   + (idWidth + (res + 1) * av.charWidth) + ","\r
1180                   + (av.charHeight + sy) + "\""\r
1181                   + " onMouseOver=\"toolTip('"\r
1182                   + alIndex + " " + triplet );\r
1183               }\r
1184 \r
1185               if(groups[g].getStartRes()<res && groups[g].getEndRes()>res)\r
1186                 text.append("<br><em>" + groups[g].getName() + "</em>");\r
1187             }\r
1188 \r
1189             if (features != null)\r
1190             {\r
1191               if(text.length()<1)\r
1192               {\r
1193                 text.append("<area shape=\"rect\" coords=\""\r
1194                   + (idWidth + res * av.charWidth) + ","\r
1195                   + sy + ","\r
1196                   + (idWidth + (res + 1) * av.charWidth) + ","\r
1197                   + (av.charHeight + sy) + "\""\r
1198                   + " onMouseOver=\"toolTip('"\r
1199                   + alIndex + " " + triplet );\r
1200               }\r
1201                 fSize = features.length;\r
1202                 for (f = 0; f < fSize; f++)\r
1203                 {\r
1204 \r
1205                   if ( (features[f].getBegin() <= seq.findPosition(res)) &&\r
1206                       (features[f].getEnd() >= seq.findPosition(res)))\r
1207                   {\r
1208                     if (features[f].getType().equals("disulfide bond"))\r
1209                     {\r
1210                       if (features[f].getBegin() == seq.findPosition(res)\r
1211                           || features[f].getEnd() == seq.findPosition(res))\r
1212                       {\r
1213                         text.append("<br>disulfide bond " + features[f].getBegin() + ":" +\r
1214                                        features[f].getEnd());\r
1215                       }\r
1216                     }\r
1217                     else\r
1218                     {\r
1219                       text.append("<br>");\r
1220                       text.append(features[f].getType());\r
1221                       if (features[f].getDescription() != null && !features[f].getType().equals(features[f].getDescription()))\r
1222                         text.append(" " + features[f].getDescription());\r
1223 \r
1224                       if (features[f].getValue("status") != null )\r
1225                       {\r
1226                         text.append(" (" + features[f].getValue("status") + ")");\r
1227                       }\r
1228                     }\r
1229                   }\r
1230 \r
1231                 }\r
1232               }\r
1233               if(text.length()>1)\r
1234               {\r
1235                 text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");\r
1236                 out.println(text.toString());\r
1237               }\r
1238             }\r
1239           }\r
1240         out.println("</map></body></html>");\r
1241         out.close();\r
1242 \r
1243       }\r
1244       catch (Exception ex)\r
1245       {\r
1246         ex.printStackTrace();\r
1247       }\r
1248     } ///////////END OF IMAGE MAP\r
1249 \r
1250   }\r
1251 \r
1252   int getWrappedHeight()\r
1253   {\r
1254     int seqPanelWidth = seqPanel.seqCanvas.getWidth();\r
1255 \r
1256     //If headless, seqPanel will have 0 width\r
1257     if (System.getProperty("java.awt.headless") != null\r
1258               && System.getProperty("java.awt.headless").equals("true"))\r
1259     {\r
1260       int idWidth = calculateIdWidth().width + 4;\r
1261       seqPanelWidth = alignFrame.getWidth() - idWidth;\r
1262     }\r
1263 \r
1264     int chunkWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(\r
1265         seqPanelWidth\r
1266           );\r
1267 \r
1268     int hgap = av.charHeight;\r
1269     if (av.scaleAboveWrapped)\r
1270       hgap += av.charHeight;\r
1271 \r
1272     int annotationHeight = 0;\r
1273     if (av.showAnnotation)\r
1274     {\r
1275       annotationHeight = annotationPanel.adjustPanelHeight();\r
1276     }\r
1277 \r
1278     int cHeight = av.getAlignment().getHeight() * av.charHeight\r
1279         + hgap\r
1280         + annotationHeight;\r
1281 \r
1282     int maxwidth = av.alignment.getWidth();\r
1283     if (av.hasHiddenColumns)\r
1284       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
1285 \r
1286 \r
1287     int height = ( (maxwidth / chunkWidth) + 1) * cHeight;\r
1288 \r
1289     return height;\r
1290   }\r
1291 \r
1292   /**\r
1293    * DOCUMENT ME!\r
1294    *\r
1295    * @author $author$\r
1296    * @version $Revision$\r
1297    */\r
1298   class Preview\r
1299       extends JFrame\r
1300   {\r
1301     /**\r
1302      * Creates a new Preview object.\r
1303      *\r
1304      * @param image DOCUMENT ME!\r
1305      */\r
1306     public Preview(Image image)\r
1307     {\r
1308       setResizable(true);\r
1309       setSize(image.getWidth(this), image.getHeight(this));\r
1310       setVisible(true);\r
1311       getContentPane().setLayout(new BorderLayout());\r
1312       getContentPane().add(new PreviewPanel(image), BorderLayout.CENTER);\r
1313       validate();\r
1314       repaint();\r
1315     }\r
1316   }\r
1317 \r
1318   /**\r
1319    * DOCUMENT ME!\r
1320    *\r
1321    * @author $author$\r
1322    * @version $Revision$\r
1323    */\r
1324   class PreviewPanel\r
1325       extends JPanel\r
1326   {\r
1327     Image image;\r
1328 \r
1329     /**\r
1330      * Creates a new PreviewPanel object.\r
1331      *\r
1332      * @param image DOCUMENT ME!\r
1333      */\r
1334     public PreviewPanel(Image image)\r
1335     {\r
1336       this.image = image;\r
1337     }\r
1338 \r
1339     /**\r
1340      * DOCUMENT ME!\r
1341      *\r
1342      * @param g DOCUMENT ME!\r
1343      */\r
1344     public void paintComponent(Graphics g)\r
1345     {\r
1346       if (image != null)\r
1347       {\r
1348         g.drawImage(image, 0, 0, this);\r
1349       }\r
1350       else\r
1351       {\r
1352         System.out.println("DEBUG:image is null");\r
1353       }\r
1354     }\r
1355   }\r
1356 }\r