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