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