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