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