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