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