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