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