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