Remove system.outs
[jalview.git] / src / jalview / gui / AlignmentPanel.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2006 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(\r
328       new Font(av.font.getName(), Font.ITALIC, av.font.getSize()));\r
329 \r
330     AlignmentI al = av.getAlignment();\r
331 \r
332     int i = 0;\r
333     int idWidth = 0;\r
334     String id;\r
335 \r
336     while ( (i < al.getHeight()) && (al.getSequenceAt(i) != null))\r
337     {\r
338       SequenceI s = al.getSequenceAt(i);\r
339 \r
340       id = s.getDisplayId(av.getShowJVSuffix());\r
341 \r
342       if (fm.stringWidth(id) > idWidth)\r
343       {\r
344         idWidth = fm.stringWidth(id);\r
345       }\r
346 \r
347       i++;\r
348     }\r
349 \r
350     // Also check annotation label widths\r
351     i = 0;\r
352 \r
353     if (al.getAlignmentAnnotation() != null)\r
354     {\r
355       fm = c.getFontMetrics(alabels.getFont());\r
356 \r
357       while (i < al.getAlignmentAnnotation().length)\r
358       {\r
359         String label = al.getAlignmentAnnotation()[i].label;\r
360 \r
361         if (fm.stringWidth(label) > idWidth)\r
362         {\r
363           idWidth = fm.stringWidth(label);\r
364         }\r
365 \r
366         i++;\r
367       }\r
368     }\r
369 \r
370     return new Dimension(idWidth, 12);\r
371   }\r
372 \r
373   /**\r
374    * DOCUMENT ME!\r
375    *\r
376    * @param results DOCUMENT ME!\r
377    */\r
378   public void highlightSearchResults(SearchResults results)\r
379   {\r
380     seqPanel.seqCanvas.highlightSearchResults(results);\r
381 \r
382     // do we need to scroll the panel?\r
383     if (results != null)\r
384     {\r
385       SequenceI seq = results.getResultSequence(0);\r
386       int seqIndex = av.alignment.findIndex(seq);\r
387       int start = seq.findIndex(results.getResultStart(0)) - 1;\r
388       int end = seq.findIndex(results.getResultEnd(0)) - 1;\r
389 \r
390       if(!av.wrapAlignment)\r
391       {\r
392         if ( (av.getStartRes() > end)  || (av.getEndRes() < start) ||\r
393            ( (av.getStartSeq() > seqIndex) || (av.getEndSeq() < seqIndex)))\r
394         {\r
395           setScrollValues(start, seqIndex);\r
396         }\r
397       }\r
398       else\r
399       {\r
400         scrollToWrappedVisible(start);\r
401       }\r
402     }\r
403   }\r
404 \r
405   void scrollToWrappedVisible(int res)\r
406   {\r
407     int cwidth = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());\r
408     if( res<=av.getStartRes() || res>=(av.getStartRes()+cwidth) )\r
409     {\r
410       vscroll.setValue(res / cwidth);\r
411       av.startRes = vscroll.getValue() * cwidth;\r
412     }\r
413   }\r
414 \r
415   /**\r
416    * DOCUMENT ME!\r
417    *\r
418    * @return DOCUMENT ME!\r
419    */\r
420   public OverviewPanel getOverviewPanel()\r
421   {\r
422     return overviewPanel;\r
423   }\r
424 \r
425   /**\r
426    * DOCUMENT ME!\r
427    *\r
428    * @param op DOCUMENT ME!\r
429    */\r
430   public void setOverviewPanel(OverviewPanel op)\r
431   {\r
432     overviewPanel = op;\r
433   }\r
434 \r
435   /**\r
436    * DOCUMENT ME!\r
437    *\r
438    * @param b DOCUMENT ME!\r
439    */\r
440   public void setAnnotationVisible(boolean b)\r
441   {\r
442     if (!av.wrapAlignment)\r
443     {\r
444       annotationSpaceFillerHolder.setVisible(b);\r
445       annotationScroller.setVisible(b);\r
446     }\r
447     repaint();\r
448   }\r
449 \r
450   public void adjustAnnotationHeight()\r
451   {\r
452     javax.swing.SwingUtilities.invokeLater(new Runnable()\r
453     {\r
454       public void run()\r
455       {\r
456           while(alignFrame.getHeight()==0)\r
457           {\r
458             Thread.yield();\r
459           }\r
460 \r
461         int height = annotationPanel.adjustPanelHeight();\r
462 \r
463         if (height > alignFrame.getHeight() / 2)\r
464         {\r
465           height = alignFrame.getHeight() / 2;\r
466         }\r
467 \r
468         annotationScroller.setPreferredSize(\r
469             new Dimension(annotationScroller.getWidth(),\r
470                           height));\r
471 \r
472         annotationSpaceFillerHolder.setPreferredSize(new Dimension(\r
473             annotationSpaceFillerHolder.getWidth(),\r
474             height));\r
475 \r
476         annotationPanel.repaint();\r
477         repaint();\r
478       }\r
479     });\r
480   }\r
481 \r
482   /**\r
483    * DOCUMENT ME!\r
484    *\r
485    * @param wrap DOCUMENT ME!\r
486    */\r
487   public void setWrapAlignment(boolean wrap)\r
488   {\r
489     av.startSeq = 0;\r
490     scalePanelHolder.setVisible(!wrap);\r
491     hscroll.setVisible(!wrap);\r
492     idwidthAdjuster.setVisible(!wrap);\r
493 \r
494     if (wrap)\r
495     {\r
496       annotationScroller.setVisible(false);\r
497       annotationSpaceFillerHolder.setVisible(false);\r
498     }\r
499     else if (av.showAnnotation)\r
500     {\r
501       annotationScroller.setVisible(true);\r
502       annotationSpaceFillerHolder.setVisible(true);\r
503     }\r
504 \r
505     idSpaceFillerPanel1.setVisible(!wrap);\r
506 \r
507     repaint();\r
508   }\r
509 \r
510   // return value is true if the scroll is valid\r
511   public boolean scrollUp(boolean up)\r
512   {\r
513     if (up)\r
514     {\r
515       if (vscroll.getValue() < 1)\r
516       {\r
517         return false;\r
518       }\r
519 \r
520       fastPaint = false;\r
521       vscroll.setValue(vscroll.getValue() - 1);\r
522     }\r
523     else\r
524     {\r
525       if ( (vextent + vscroll.getValue()) >= av.getAlignment().getHeight())\r
526       {\r
527         return false;\r
528       }\r
529 \r
530       fastPaint = false;\r
531       vscroll.setValue(vscroll.getValue() + 1);\r
532     }\r
533 \r
534     fastPaint = true;\r
535 \r
536     return true;\r
537   }\r
538 \r
539   /**\r
540    * DOCUMENT ME!\r
541    *\r
542    * @param right DOCUMENT ME!\r
543    *\r
544    * @return DOCUMENT ME!\r
545    */\r
546   public boolean scrollRight(boolean right)\r
547   {\r
548     if (!right)\r
549     {\r
550       if (hscroll.getValue() < 1)\r
551       {\r
552         return false;\r
553       }\r
554 \r
555       fastPaint = false;\r
556       hscroll.setValue(hscroll.getValue() - 1);\r
557     }\r
558     else\r
559     {\r
560       if ( (hextent + hscroll.getValue()) >= av.getAlignment().getWidth())\r
561       {\r
562         return false;\r
563       }\r
564 \r
565       fastPaint = false;\r
566       hscroll.setValue(hscroll.getValue() + 1);\r
567     }\r
568 \r
569     fastPaint = true;\r
570 \r
571     return true;\r
572   }\r
573 \r
574   /**\r
575    * DOCUMENT ME!\r
576    *\r
577    * @param x DOCUMENT ME!\r
578    * @param y DOCUMENT ME!\r
579    */\r
580   public void setScrollValues(int x, int y)\r
581   {\r
582 \r
583     int width = av.alignment.getWidth();\r
584     int height = av.alignment.getHeight();\r
585 \r
586     if(av.hasHiddenColumns)\r
587      width = av.getColumnSelection().findColumnPosition(width);\r
588 \r
589     av.setEndRes( (x + (seqPanel.seqCanvas.getWidth() / av.charWidth)) -1);\r
590 \r
591     hextent = seqPanel.seqCanvas.getWidth() / av.charWidth;\r
592     vextent = seqPanel.seqCanvas.getHeight() / av.charHeight;\r
593 \r
594     if (hextent > width)\r
595     {\r
596       hextent = width;\r
597     }\r
598 \r
599     if (vextent > height)\r
600     {\r
601       vextent = height;\r
602     }\r
603 \r
604     if ( (hextent + x) > width)\r
605     {\r
606       x = width - hextent;\r
607     }\r
608 \r
609     if ( (vextent + y) > height)\r
610     {\r
611       y = height - vextent;\r
612     }\r
613 \r
614     if (y < 0)\r
615     {\r
616       y = 0;\r
617     }\r
618 \r
619     if (x < 0)\r
620     {\r
621       x = 0;\r
622     }\r
623 \r
624     hscroll.setValues(x, hextent, 0, width);\r
625     vscroll.setValues(y, vextent, 0, height);\r
626   }\r
627 \r
628   /**\r
629    * DOCUMENT ME!\r
630    *\r
631    * @param evt DOCUMENT ME!\r
632    */\r
633   public void adjustmentValueChanged(AdjustmentEvent evt)\r
634   {\r
635 \r
636     int oldX = av.getStartRes();\r
637     int oldY = av.getStartSeq();\r
638 \r
639     if (evt.getSource() == hscroll)\r
640     {\r
641       int x = hscroll.getValue();\r
642       av.setStartRes(x);\r
643       av.setEndRes( (x +\r
644                      (seqPanel.seqCanvas.getWidth() / av.getCharWidth())) - 1);\r
645     }\r
646 \r
647     if (evt.getSource() == vscroll)\r
648     {\r
649       int offy = vscroll.getValue();\r
650 \r
651       if (av.getWrapAlignment())\r
652       {\r
653         if(offy>-1)\r
654         {\r
655           int rowSize = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.\r
656               seqCanvas.getWidth());\r
657           av.setStartRes(offy * rowSize);\r
658           av.setEndRes( (offy + 1) * rowSize);\r
659         }\r
660         else\r
661         {\r
662           //This is only called if file loaded is a jar file that\r
663           //was wrapped when saved and user has wrap alignment true\r
664           //as preference setting\r
665           SwingUtilities.invokeLater(new Runnable()\r
666               {\r
667                 public void run()\r
668                 {\r
669                   setScrollValues(av.getStartRes(), av.getStartSeq());\r
670                 }\r
671               });\r
672         }\r
673       }\r
674       else\r
675       {\r
676         av.setStartSeq(offy);\r
677         av.setEndSeq(offy +\r
678                      (seqPanel.seqCanvas.getHeight() / av.getCharHeight()));\r
679       }\r
680     }\r
681 \r
682     if (overviewPanel != null)\r
683     {\r
684       overviewPanel.setBoxPosition();\r
685     }\r
686 \r
687     int scrollX = av.startRes - oldX;\r
688     int scrollY = av.startSeq - oldY;\r
689 \r
690     if (av.getWrapAlignment() || !fastPaint)\r
691     {\r
692       repaint();\r
693     }\r
694     else\r
695     {\r
696       // Make sure we're not trying to draw a panel\r
697       // larger than the visible window\r
698       if(scrollX>av.endRes-av.startRes)\r
699         scrollX = av.endRes-av.startRes;\r
700       else if(scrollX<av.startRes-av.endRes)\r
701         scrollX = av.startRes - av.endRes;\r
702 \r
703       if(scrollX!=0 || scrollY!=0)\r
704       {\r
705         idPanel.idCanvas.fastPaint(scrollY);\r
706         seqPanel.seqCanvas.fastPaint(scrollX,\r
707                                      scrollY);\r
708         scalePanel.repaint();\r
709 \r
710         if (av.getShowAnnotation())\r
711         {\r
712           annotationPanel.fastPaint(scrollX);\r
713         }\r
714       }\r
715     }\r
716   }\r
717 \r
718   /**\r
719    * DOCUMENT ME!\r
720    *\r
721    * @param g DOCUMENT ME!\r
722    */\r
723   public void paintComponent(Graphics g)\r
724   {\r
725     invalidate();\r
726 \r
727     Dimension d = idPanel.idCanvas.getPreferredSize();\r
728     idPanelHolder.setPreferredSize(d);\r
729     hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));\r
730     validate();\r
731 \r
732     if (av.getWrapAlignment())\r
733     {\r
734       int maxwidth = av.alignment.getWidth();\r
735 \r
736       if (av.hasHiddenColumns)\r
737         maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
738 \r
739       int max = maxwidth /\r
740           seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth()) +\r
741           1;\r
742 \r
743 \r
744       vscroll.setMaximum(max);\r
745       vscroll.setUnitIncrement(1);\r
746       vscroll.setVisibleAmount(1);\r
747     }\r
748     else\r
749     {\r
750       setScrollValues(av.getStartRes(), av.getStartSeq());\r
751     }\r
752 \r
753     if( this.getVisibleRect().getBounds() == g.getClipBounds()\r
754         && overviewPanel != null)\r
755         overviewPanel.updateOverviewImage();\r
756 \r
757   }\r
758 \r
759   /**\r
760    * DOCUMENT ME!\r
761    *\r
762    * @param pg DOCUMENT ME!\r
763    * @param pf DOCUMENT ME!\r
764    * @param pi DOCUMENT ME!\r
765    *\r
766    * @return DOCUMENT ME!\r
767    *\r
768    * @throws PrinterException DOCUMENT ME!\r
769    */\r
770   public int print(Graphics pg, PageFormat pf, int pi)\r
771       throws PrinterException\r
772   {\r
773     pg.translate( (int) pf.getImageableX(), (int) pf.getImageableY());\r
774 \r
775     int pwidth = (int) pf.getImageableWidth();\r
776     int pheight = (int) pf.getImageableHeight();\r
777 \r
778     if (av.getWrapAlignment())\r
779     {\r
780       return printWrappedAlignment(pg, pwidth, pheight, pi);\r
781     }\r
782     else\r
783     {\r
784       return printUnwrapped(pg, pwidth, pheight, pi);\r
785     }\r
786   }\r
787 \r
788   /**\r
789    * DOCUMENT ME!\r
790    *\r
791    * @param pg DOCUMENT ME!\r
792    * @param pwidth DOCUMENT ME!\r
793    * @param pheight DOCUMENT ME!\r
794    * @param pi DOCUMENT ME!\r
795    *\r
796    * @return DOCUMENT ME!\r
797    *\r
798    * @throws PrinterException DOCUMENT ME!\r
799    */\r
800   public int printUnwrapped(Graphics pg, int pwidth, int pheight, int pi)\r
801       throws PrinterException\r
802   {\r
803     int idWidth = getVisibleIdWidth();\r
804     FontMetrics fm = getFontMetrics(av.getFont());\r
805     int scaleHeight = av.charHeight + fm.getDescent();\r
806 \r
807     pg.setColor(Color.white);\r
808     pg.fillRect(0, 0, pwidth, pheight);\r
809     pg.setFont(av.getFont());\r
810 \r
811     ////////////////////////////////////\r
812     /// How many sequences and residues can we fit on a printable page?\r
813     int totalRes = (pwidth - idWidth) / av.getCharWidth();\r
814 \r
815     int totalSeq = (int) ( (pheight - scaleHeight) / av.getCharHeight()) -\r
816         1;\r
817 \r
818     int pagesWide = (av.getAlignment().getWidth() / totalRes) + 1;\r
819 \r
820     /////////////////////////////\r
821     /// Only print these sequences and residues on this page\r
822     int startRes;\r
823 \r
824     /////////////////////////////\r
825     /// Only print these sequences and residues on this page\r
826     int endRes;\r
827 \r
828     /////////////////////////////\r
829     /// Only print these sequences and residues on this page\r
830     int startSeq;\r
831 \r
832     /////////////////////////////\r
833     /// Only print these sequences and residues on this page\r
834     int endSeq;\r
835     startRes = (pi % pagesWide) * totalRes;\r
836     endRes = (startRes + totalRes) - 1;\r
837 \r
838     if (endRes > (av.getAlignment().getWidth() - 1))\r
839     {\r
840       endRes = av.getAlignment().getWidth() - 1;\r
841     }\r
842 \r
843     startSeq = (pi / pagesWide) * totalSeq;\r
844     endSeq = startSeq + totalSeq;\r
845 \r
846     if (endSeq > av.getAlignment().getHeight())\r
847     {\r
848       endSeq = av.getAlignment().getHeight();\r
849     }\r
850 \r
851     int pagesHigh = ( (av.alignment.getHeight() / totalSeq) + 1) * pheight;\r
852 \r
853     if (av.showAnnotation)\r
854     {\r
855       pagesHigh += annotationPanel.adjustPanelHeight() + 3;\r
856     }\r
857 \r
858     pagesHigh /= pheight;\r
859 \r
860     if (pi >= (pagesWide * pagesHigh))\r
861     {\r
862       return Printable.NO_SUCH_PAGE;\r
863     }\r
864 \r
865     //draw Scale\r
866     pg.translate(idWidth, 0);\r
867     scalePanel.drawScale(pg, startRes, endRes, pwidth - idWidth, scaleHeight);\r
868     pg.translate( -idWidth, scaleHeight);\r
869 \r
870     ////////////////\r
871     // Draw the ids\r
872     Color currentColor = null;\r
873     Color currentTextColor = null;\r
874 \r
875     pg.setFont(new Font(av.getFont().getName(),\r
876                         Font.ITALIC,\r
877                         av.getFont().getSize()));\r
878     for (int i = startSeq; i < endSeq; i++)\r
879     {\r
880       if ( (av.getSelectionGroup() != null) &&\r
881           av.getSelectionGroup().getSequences(false).contains(\r
882               av.getAlignment().getSequenceAt(i)))\r
883       {\r
884         currentColor = Color.gray;\r
885         currentTextColor = Color.black;\r
886       }\r
887       else\r
888       {\r
889         currentColor = av.getAlignment().getSequenceAt(i).getColor();\r
890         currentTextColor = Color.black;\r
891       }\r
892 \r
893       pg.setColor(currentColor);\r
894       pg.fillRect(0, (i - startSeq) * av.charHeight, idWidth,\r
895                   av.getCharHeight());\r
896 \r
897       pg.setColor(currentTextColor);\r
898 \r
899       String string = av.getAlignment().getSequenceAt(i).getDisplayId\r
900           ( av.getShowJVSuffix());\r
901 \r
902       pg.drawString(string, 0,\r
903                     ( ( (i - startSeq) * av.charHeight) + av.getCharHeight()) -\r
904                     (av.getCharHeight() / 5));\r
905     }\r
906 \r
907     pg.setFont(av.getFont());\r
908 \r
909     // draw main sequence panel\r
910     pg.translate(idWidth, 0);\r
911     seqPanel.seqCanvas.drawPanel(pg, startRes, endRes, startSeq, endSeq, 0);\r
912 \r
913     if (av.showAnnotation && (endSeq == av.alignment.getHeight()))\r
914     {\r
915       pg.translate( -idWidth-3, (endSeq - startSeq) * av.charHeight + 3);\r
916       alabels.drawComponent( (Graphics2D) pg, idWidth);\r
917       pg.translate(idWidth+3, 0);\r
918       annotationPanel.drawComponent( (Graphics2D) pg, startRes, endRes +\r
919                                     1);\r
920     }\r
921 \r
922     return Printable.PAGE_EXISTS;\r
923   }\r
924 \r
925   /**\r
926    * DOCUMENT ME!\r
927    *\r
928    * @param pg DOCUMENT ME!\r
929    * @param pwidth DOCUMENT ME!\r
930    * @param pheight DOCUMENT ME!\r
931    * @param pi DOCUMENT ME!\r
932    *\r
933    * @return DOCUMENT ME!\r
934    *\r
935    * @throws PrinterException DOCUMENT ME!\r
936    */\r
937   public int printWrappedAlignment(Graphics pg, int pwidth, int pheight,\r
938                                    int pi)\r
939       throws PrinterException\r
940   {\r
941 \r
942     int annotationHeight = 0;\r
943     AnnotationLabels labels = null;\r
944     if (av.showAnnotation)\r
945     {\r
946       annotationHeight = annotationPanel.adjustPanelHeight();\r
947       labels = new AnnotationLabels(av);\r
948     }\r
949 \r
950     int hgap = av.charHeight;\r
951     if (av.scaleAboveWrapped)\r
952       hgap += av.charHeight;\r
953 \r
954     int cHeight = av.getAlignment().getHeight() * av.charHeight\r
955         + hgap\r
956         + annotationHeight;\r
957 \r
958     int idWidth = getVisibleIdWidth();\r
959 \r
960     int maxwidth = av.alignment.getWidth();\r
961     if (av.hasHiddenColumns)\r
962       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
963 \r
964 \r
965     int resWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(pwidth -\r
966         idWidth);\r
967 \r
968     int totalHeight = cHeight * (maxwidth / resWidth + 1);\r
969 \r
970     pg.setColor(Color.white);\r
971     pg.fillRect(0, 0, pwidth, pheight);\r
972     pg.setFont(av.getFont());\r
973 \r
974     ////////////////\r
975     // Draw the ids\r
976     pg.setColor(Color.black);\r
977 \r
978     pg.translate(0, -pi * pheight);\r
979 \r
980     pg.setClip(0, pi * pheight, pwidth, pheight);\r
981 \r
982     int ypos = hgap;\r
983     Font italic = new Font(av.getFont().getName(), Font.ITALIC,\r
984                            av.getFont().getSize());\r
985     pg.setFont(italic);\r
986 \r
987     do\r
988     {\r
989       for (int i = 0; i < av.alignment.getHeight(); i++)\r
990       {\r
991         SequenceI s = av.alignment.getSequenceAt(i);\r
992         String string = s.getDisplayId( av.getShowJVSuffix());\r
993 \r
994         pg.drawString(string, 0,\r
995                       ( (i * av.charHeight) + ypos + av.charHeight) -\r
996                       (av.charHeight / 5));\r
997       }\r
998       if (labels != null)\r
999       {\r
1000         pg.translate(-3,\r
1001                      ypos +\r
1002                      (av.getAlignment().getHeight() * av.charHeight));\r
1003 \r
1004         pg.setFont(av.getFont());\r
1005         labels.drawComponent(pg, idWidth);\r
1006         pg.setFont(italic);\r
1007         pg.translate(+3,\r
1008                      -ypos -\r
1009                      (av.getAlignment().getHeight() * av.charHeight));\r
1010       }\r
1011 \r
1012       ypos += cHeight;\r
1013     }\r
1014     while (ypos < totalHeight);\r
1015 \r
1016     pg.translate(idWidth, 0);\r
1017 \r
1018     seqPanel.seqCanvas.drawWrappedPanel(pg, pwidth - idWidth, totalHeight, 0);\r
1019 \r
1020     if ( (pi * pheight) < totalHeight)\r
1021     {\r
1022       return Printable.PAGE_EXISTS;\r
1023 \r
1024     }\r
1025     else\r
1026     {\r
1027       return Printable.NO_SUCH_PAGE;\r
1028     }\r
1029   }\r
1030 \r
1031   int getVisibleIdWidth()\r
1032   {\r
1033     return\r
1034         idPanel.getWidth() > 0 ? idPanel.getWidth() :\r
1035         calculateIdWidth().width + 4;\r
1036   }\r
1037 \r
1038   void makeAlignmentImage(int type, File file)\r
1039   {\r
1040     int maxwidth = av.alignment.getWidth();\r
1041     if (av.hasHiddenColumns)\r
1042       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);\r
1043 \r
1044     int height = ( (av.alignment.getHeight() + 1) * av.charHeight) + 30;\r
1045     int width = getVisibleIdWidth() + (maxwidth * av.charWidth);\r
1046 \r
1047     if (av.getWrapAlignment())\r
1048     {\r
1049       height = getWrappedHeight();\r
1050       if (System.getProperty("java.awt.headless") != null\r
1051           && System.getProperty("java.awt.headless").equals("true"))\r
1052       {\r
1053         width = alignFrame.getWidth() - 22;\r
1054       }\r
1055       else\r
1056         width = seqPanel.getWidth() + getVisibleIdWidth();\r
1057 \r
1058     }\r
1059     else if (av.getShowAnnotation())\r
1060     {\r
1061       height += annotationPanel.adjustPanelHeight() + 3;\r
1062     }\r
1063 \r
1064     jalview.util.ImageMaker im;\r
1065     if(type==jalview.util.ImageMaker.PNG)\r
1066       im  = new jalview.util.ImageMaker(this,\r
1067                                         jalview.util.ImageMaker.PNG,\r
1068                                         "Create PNG image from alignment",\r
1069                                         width, height, file, null);\r
1070     else\r
1071       im = new jalview.util.ImageMaker(this,\r
1072                                         jalview.util.ImageMaker.EPS,\r
1073                                        "Create EPS file from alignment",\r
1074                                         width, height, file, alignFrame.getTitle() );\r
1075 \r
1076     try\r
1077     {\r
1078       if (av.getWrapAlignment())\r
1079       {\r
1080         if(im.getGraphics()!=null)\r
1081         {\r
1082           printWrappedAlignment(im.getGraphics(), width, height, 0);\r
1083           im.writeImage();\r
1084         }\r
1085       }\r
1086       else\r
1087       {\r
1088         if(im.getGraphics()!=null)\r
1089         {\r
1090           printUnwrapped(im.getGraphics(), width, height, 0);\r
1091           im.writeImage();\r
1092         }\r
1093       }\r
1094     }\r
1095     catch (OutOfMemoryError err)\r
1096     {\r
1097       System.out.println("########################\n"\r
1098                          + "OUT OF MEMORY " + file + "\n"\r
1099                          + "########################");\r
1100 \r
1101       JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
1102                                             "Out of Memory Creating Image!!"\r
1103                                             +\r
1104                                             "\nSee help files for increasing Java Virtual Machine memory."\r
1105                                             , "Out of memory",\r
1106                                             JOptionPane.WARNING_MESSAGE);\r
1107       System.out.println("Create IMAGE: " + err);\r
1108       System.gc();\r
1109 \r
1110     }\r
1111     catch (Exception ex)\r
1112     {\r
1113       ex.printStackTrace();\r
1114     }\r
1115   }\r
1116   /**\r
1117    * DOCUMENT ME!\r
1118    */\r
1119   public void makeEPS(File epsFile)\r
1120   {\r
1121     makeAlignmentImage(jalview.util.ImageMaker.EPS, epsFile);\r
1122   }\r
1123 \r
1124   /**\r
1125    * DOCUMENT ME!\r
1126    */\r
1127   public void makePNG(File pngFile)\r
1128   {\r
1129     makeAlignmentImage(jalview.util.ImageMaker.PNG, pngFile);\r
1130   }\r
1131 \r
1132   public void makePNGImageMap(File imgMapFile, String imageName)\r
1133   {\r
1134     ///////ONLY WORKS WITH NONE WRAPPED ALIGNMENTS\r
1135     //////////////////////////////////////////////\r
1136     int idWidth = getVisibleIdWidth();\r
1137     FontMetrics fm = getFontMetrics(av.getFont());\r
1138     int scaleHeight = av.charHeight + fm.getDescent();\r
1139 \r
1140     // Gen image map\r
1141     //////////////////////////////////\r
1142     if (imgMapFile != null)\r
1143     {\r
1144       try\r
1145       {\r
1146         int s, sSize = av.alignment.getHeight(),\r
1147             res, alwidth = av.alignment.getWidth(), g, gSize, f, fSize, sy;\r
1148         StringBuffer text = new StringBuffer();\r
1149         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));\r
1150         out.println(jalview.io.HTMLOutput.getImageMapHTML());\r
1151         out.println("<img src=\"" + imageName +\r
1152                     "\" border=\"0\" usemap=\"#Map\" >"\r
1153                     + "<map name=\"Map\">");\r
1154 \r
1155         for (s = 0; s < sSize; s++)\r
1156         {\r
1157           sy = s * av.charHeight + scaleHeight;\r
1158 \r
1159           SequenceI seq = av.alignment.getSequenceAt(s);\r
1160           SequenceFeature [] features = seq.getDatasetSequence().getSequenceFeatures();\r
1161           SequenceGroup[] groups = av.alignment.findAllGroups(seq);\r
1162           for(res =0; res<alwidth; res++)\r
1163           {\r
1164             text = new StringBuffer();\r
1165             Object obj = null;\r
1166             if(av.alignment.isNucleotide())\r
1167               obj = ResidueProperties.nucleotideName.get(seq.getCharAt(res)+"" );\r
1168             else\r
1169               obj = ResidueProperties.aa2Triplet.get(\r
1170                     seq.getCharAt(res) + "");\r
1171 \r
1172               if (obj == null)\r
1173                   continue;\r
1174 \r
1175             String triplet = obj.toString();\r
1176             int alIndex = seq.findPosition(res);\r
1177             gSize = groups.length;\r
1178             for (g = 0; g < gSize; g++)\r
1179             {\r
1180               if(text.length()<1)\r
1181               {\r
1182                 text.append("<area shape=\"rect\" coords=\""\r
1183                   + (idWidth + res * av.charWidth) + ","\r
1184                   + sy + ","\r
1185                   + (idWidth + (res + 1) * av.charWidth) + ","\r
1186                   + (av.charHeight + sy) + "\""\r
1187                   + " onMouseOver=\"toolTip('"\r
1188                   + alIndex + " " + triplet );\r
1189               }\r
1190 \r
1191               if(groups[g].getStartRes()<res && groups[g].getEndRes()>res)\r
1192                 text.append("<br><em>" + groups[g].getName() + "</em>");\r
1193             }\r
1194 \r
1195             if (features != null)\r
1196             {\r
1197               if(text.length()<1)\r
1198               {\r
1199                 text.append("<area shape=\"rect\" coords=\""\r
1200                   + (idWidth + res * av.charWidth) + ","\r
1201                   + sy + ","\r
1202                   + (idWidth + (res + 1) * av.charWidth) + ","\r
1203                   + (av.charHeight + sy) + "\""\r
1204                   + " onMouseOver=\"toolTip('"\r
1205                   + alIndex + " " + triplet );\r
1206               }\r
1207                 fSize = features.length;\r
1208                 for (f = 0; f < fSize; f++)\r
1209                 {\r
1210 \r
1211                   if ( (features[f].getBegin() <= seq.findPosition(res)) &&\r
1212                       (features[f].getEnd() >= seq.findPosition(res)))\r
1213                   {\r
1214                     if (features[f].getType().equals("disulfide bond"))\r
1215                     {\r
1216                       if (features[f].getBegin() == seq.findPosition(res)\r
1217                           || features[f].getEnd() == seq.findPosition(res))\r
1218                       {\r
1219                         text.append("<br>disulfide bond " + features[f].getBegin() + ":" +\r
1220                                        features[f].getEnd());\r
1221                       }\r
1222                     }\r
1223                     else\r
1224                     {\r
1225                       text.append("<br>");\r
1226                       text.append(features[f].getType());\r
1227                       if (features[f].getDescription() != null && !features[f].getType().equals(features[f].getDescription()))\r
1228                         text.append(" " + features[f].getDescription());\r
1229 \r
1230                       if (features[f].getValue("status") != null )\r
1231                       {\r
1232                         text.append(" (" + features[f].getValue("status") + ")");\r
1233                       }\r
1234                     }\r
1235                   }\r
1236 \r
1237                 }\r
1238               }\r
1239               if(text.length()>1)\r
1240               {\r
1241                 text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");\r
1242                 out.println(text.toString());\r
1243               }\r
1244             }\r
1245           }\r
1246         out.println("</map></body></html>");\r
1247         out.close();\r
1248 \r
1249       }\r
1250       catch (Exception ex)\r
1251       {\r
1252         ex.printStackTrace();\r
1253       }\r
1254     } ///////////END OF IMAGE MAP\r
1255 \r
1256   }\r
1257 \r
1258   int getWrappedHeight()\r
1259   {\r
1260     int seqPanelWidth = seqPanel.seqCanvas.getWidth();\r
1261 \r
1262     //If headless, seqPanel will have 0 width\r
1263     if (System.getProperty("java.awt.headless") != null\r
1264               && System.getProperty("java.awt.headless").equals("true"))\r
1265     {\r
1266       seqPanelWidth = alignFrame.getWidth() - getVisibleIdWidth();\r
1267     }\r
1268 \r
1269     int chunkWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(\r
1270         seqPanelWidth\r
1271           );\r
1272 \r
1273     int hgap = av.charHeight;\r
1274     if (av.scaleAboveWrapped)\r
1275       hgap += av.charHeight;\r
1276 \r
1277     int annotationHeight = 0;\r
1278     if (av.showAnnotation)\r
1279     {\r
1280       annotationHeight = annotationPanel.adjustPanelHeight();\r
1281     }\r
1282 \r
1283     int cHeight = av.getAlignment().getHeight() * av.charHeight\r
1284         + hgap\r
1285         + annotationHeight;\r
1286 \r
1287     int maxwidth = av.alignment.getWidth();\r
1288     if (av.hasHiddenColumns)\r
1289       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
1290 \r
1291 \r
1292     int height = ( (maxwidth / chunkWidth) + 1) * cHeight;\r
1293 \r
1294     return height;\r
1295   }\r
1296 \r
1297   /**\r
1298    * DOCUMENT ME!\r
1299    *\r
1300    * @author $author$\r
1301    * @version $Revision$\r
1302    */\r
1303   class Preview\r
1304       extends JFrame\r
1305   {\r
1306     /**\r
1307      * Creates a new Preview object.\r
1308      *\r
1309      * @param image DOCUMENT ME!\r
1310      */\r
1311     public Preview(Image image)\r
1312     {\r
1313       setResizable(true);\r
1314       setSize(image.getWidth(this), image.getHeight(this));\r
1315       setVisible(true);\r
1316       getContentPane().setLayout(new BorderLayout());\r
1317       getContentPane().add(new PreviewPanel(image), BorderLayout.CENTER);\r
1318       validate();\r
1319       repaint();\r
1320     }\r
1321   }\r
1322 \r
1323   /**\r
1324    * DOCUMENT ME!\r
1325    *\r
1326    * @author $author$\r
1327    * @version $Revision$\r
1328    */\r
1329   class PreviewPanel\r
1330       extends JPanel\r
1331   {\r
1332     Image image;\r
1333 \r
1334     /**\r
1335      * Creates a new PreviewPanel object.\r
1336      *\r
1337      * @param image DOCUMENT ME!\r
1338      */\r
1339     public PreviewPanel(Image image)\r
1340     {\r
1341       this.image = image;\r
1342     }\r
1343 \r
1344     /**\r
1345      * DOCUMENT ME!\r
1346      *\r
1347      * @param g DOCUMENT ME!\r
1348      */\r
1349     public void paintComponent(Graphics g)\r
1350     {\r
1351       if (image != null)\r
1352       {\r
1353         g.drawImage(image, 0, 0, this);\r
1354       }\r
1355       else\r
1356       {\r
1357         System.out.println("DEBUG:image is null");\r
1358       }\r
1359     }\r
1360   }\r
1361 }\r