src/jalview/gui/AlignmentPanel.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.gui;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import jalview.jbgui.*;\r
  24 \r
  25 import jalview.schemes.*;\r
  26 \r
  27 import java.awt.*;\r
  28 import java.awt.event.*;\r
  29 import java.awt.print.*;\r
  30 \r
  31 import java.io.*;\r
  32 \r
  33 import javax.swing.*;\r
  34 \r
  35 \r
  36 /**\r
  37  * DOCUMENT ME!\r
  38  *\r
  39  * @author $author$\r
  40  * @version $Revision$\r
  41  */\r
  42 public class AlignmentPanel extends GAlignmentPanel\r
  43     implements AdjustmentListener, Printable\r
  44 {\r
  45   public AlignViewport av;\r
  46   OverviewPanel overviewPanel;\r
  47   SeqPanel seqPanel;\r
  48   IdPanel idPanel;\r
  49   IdwidthAdjuster idwidthAdjuster;\r
  50 \r
  51   /** DOCUMENT ME!! */\r
  52   public AlignFrame alignFrame;\r
  53   ScalePanel scalePanel;\r
  54   AnnotationPanel annotationPanel;\r
  55   AnnotationLabels alabels;\r
  56 \r
  57   // this value is set false when selection area being dragged\r
  58   boolean fastPaint = true;\r
  59   int hextent = 0;\r
  60   int vextent = 0;\r
  61 \r
  62   /**\r
  63    * Creates a new AlignmentPanel object.\r
  64    *\r
  65    * @param af DOCUMENT ME!\r
  66    * @param av DOCUMENT ME!\r
  67    */\r
  68   public AlignmentPanel(AlignFrame af, final AlignViewport av)\r
  69   {\r
  70     alignFrame = af;\r
  71     this.av = av;\r
  72     seqPanel = new SeqPanel(av, this);\r
  73     idPanel = new IdPanel(av, this);\r
  74 \r
  75     scalePanel = new ScalePanel(av, this);\r
  76 \r
  77     idPanelHolder.add(idPanel, BorderLayout.CENTER);\r
  78     idwidthAdjuster = new IdwidthAdjuster(this);\r
  79     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);\r
  80 \r
  81     annotationPanel = new AnnotationPanel(this);\r
  82     alabels = new AnnotationLabels(this);\r
  83 \r
  84 \r
  85     annotationScroller.setViewportView(annotationPanel);\r
  86     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);\r
  87 \r
  88     fontChanged();\r
  89 \r
  90     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);\r
  91     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);\r
  92 \r
  93     setScrollValues(0, 0);\r
  94 \r
  95     adjustAnnotationHeight();\r
  96 \r
  97     setAnnotationVisible(av.getShowAnnotation());\r
  98 \r
  99     hscroll.addAdjustmentListener(this);\r
 100     vscroll.addAdjustmentListener(this);\r
 101 \r
 102     af.addKeyListener(new KeyAdapter()\r
 103     {\r
 104       public void keyPressed(KeyEvent evt)\r
 105       {\r
 106         if(av.cursorMode\r
 107            && evt.getKeyCode()>=KeyEvent.VK_0\r
 108            && evt.getKeyCode()<=KeyEvent.VK_9)\r
 109         {\r
 110           seqPanel.numberPressed(evt.getKeyChar());\r
 111         }\r
 112 \r
 113         switch (evt.getKeyCode())\r
 114         {\r
 115           case 27: // escape key\r
 116             alignFrame.deselectAllSequenceMenuItem_actionPerformed(null);\r
 117 \r
 118             break;\r
 119 \r
 120             case KeyEvent.VK_B:\r
 121               av.getSelectionAsString();\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 && !evt.isControlDown())\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   public void adjustAnnotationHeight()\r
 422   {\r
 423     javax.swing.SwingUtilities.invokeLater(new Runnable()\r
 424     {\r
 425       public void run()\r
 426       {\r
 427           while(alignFrame.getHeight()==0)\r
 428           {\r
 429             Thread.yield();\r
 430           }\r
 431 \r
 432         int height = annotationPanel.adjustPanelHeight();\r
 433 \r
 434         if (height > alignFrame.getHeight() / 2)\r
 435         {\r
 436           height = alignFrame.getHeight() / 2;\r
 437         }\r
 438 \r
 439         annotationScroller.setPreferredSize(\r
 440             new Dimension(annotationScroller.getWidth(),\r
 441                           height));\r
 442 \r
 443         annotationSpaceFillerHolder.setPreferredSize(new Dimension(\r
 444             annotationSpaceFillerHolder.getWidth(),\r
 445             height));\r
 446 \r
 447         annotationPanel.repaint();\r
 448       }\r
 449     });\r
 450   }\r
 451 \r
 452   /**\r
 453    * DOCUMENT ME!\r
 454    *\r
 455    * @param wrap DOCUMENT ME!\r
 456    */\r
 457   public void setWrapAlignment(boolean wrap)\r
 458   {\r
 459     av.startSeq = 0;\r
 460     scalePanelHolder.setVisible(!wrap);\r
 461     hscroll.setVisible(!wrap);\r
 462     idwidthAdjuster.setVisible(!wrap);\r
 463 \r
 464     if (wrap)\r
 465     {\r
 466       annotationScroller.setVisible(false);\r
 467       annotationSpaceFillerHolder.setVisible(false);\r
 468     }\r
 469     else if (av.showAnnotation)\r
 470     {\r
 471       annotationScroller.setVisible(true);\r
 472       annotationSpaceFillerHolder.setVisible(true);\r
 473     }\r
 474 \r
 475     idSpaceFillerPanel1.setVisible(!wrap);\r
 476 \r
 477     repaint();\r
 478   }\r
 479 \r
 480   // return value is true if the scroll is valid\r
 481   public boolean scrollUp(boolean up)\r
 482   {\r
 483     if (up)\r
 484     {\r
 485       if (vscroll.getValue() < 1)\r
 486       {\r
 487         return false;\r
 488       }\r
 489 \r
 490       fastPaint = false;\r
 491       vscroll.setValue(vscroll.getValue() - 1);\r
 492     }\r
 493     else\r
 494     {\r
 495       if ( (vextent + vscroll.getValue()) >= av.getAlignment().getHeight())\r
 496       {\r
 497         return false;\r
 498       }\r
 499 \r
 500       fastPaint = false;\r
 501       vscroll.setValue(vscroll.getValue() + 1);\r
 502     }\r
 503 \r
 504     fastPaint = true;\r
 505 \r
 506     return true;\r
 507   }\r
 508 \r
 509   /**\r
 510    * DOCUMENT ME!\r
 511    *\r
 512    * @param right DOCUMENT ME!\r
 513    *\r
 514    * @return DOCUMENT ME!\r
 515    */\r
 516   public boolean scrollRight(boolean right)\r
 517   {\r
 518     if (!right)\r
 519     {\r
 520       if (hscroll.getValue() < 1)\r
 521       {\r
 522         return false;\r
 523       }\r
 524 \r
 525       fastPaint = false;\r
 526       hscroll.setValue(hscroll.getValue() - 1);\r
 527     }\r
 528     else\r
 529     {\r
 530       if ( (hextent + hscroll.getValue()) >= av.getAlignment().getWidth())\r
 531       {\r
 532         return false;\r
 533       }\r
 534 \r
 535       fastPaint = false;\r
 536       hscroll.setValue(hscroll.getValue() + 1);\r
 537     }\r
 538 \r
 539     fastPaint = true;\r
 540 \r
 541     return true;\r
 542   }\r
 543 \r
 544   /**\r
 545    * DOCUMENT ME!\r
 546    *\r
 547    * @param x DOCUMENT ME!\r
 548    * @param y DOCUMENT ME!\r
 549    */\r
 550   public void setScrollValues(int x, int y)\r
 551   {\r
 552 \r
 553     int width = av.alignment.getWidth();\r
 554     int height = av.alignment.getHeight();\r
 555 \r
 556     if(av.hasHiddenColumns)\r
 557      width = av.getColumnSelection().findColumnPosition(width);\r
 558 \r
 559     av.setEndRes( (x + (seqPanel.seqCanvas.getWidth() / av.charWidth)) -1);\r
 560 \r
 561     hextent = seqPanel.seqCanvas.getWidth() / av.charWidth;\r
 562     vextent = seqPanel.seqCanvas.getHeight() / av.charHeight;\r
 563 \r
 564     if (hextent > width)\r
 565     {\r
 566       hextent = width;\r
 567     }\r
 568 \r
 569     if (vextent > height)\r
 570     {\r
 571       vextent = height;\r
 572     }\r
 573 \r
 574     if ( (hextent + x) > width)\r
 575     {\r
 576       x = width - hextent;\r
 577     }\r
 578 \r
 579     if ( (vextent + y) > height)\r
 580     {\r
 581       y = height - vextent;\r
 582     }\r
 583 \r
 584     if (y < 0)\r
 585     {\r
 586       y = 0;\r
 587     }\r
 588 \r
 589     if (x < 0)\r
 590     {\r
 591       x = 0;\r
 592     }\r
 593 \r
 594     hscroll.setValues(x, hextent, 0, width);\r
 595     vscroll.setValues(y, vextent, 0, height);\r
 596   }\r
 597 \r
 598   /**\r
 599    * DOCUMENT ME!\r
 600    *\r
 601    * @param evt DOCUMENT ME!\r
 602    */\r
 603   public void adjustmentValueChanged(AdjustmentEvent evt)\r
 604   {\r
 605 \r
 606     int oldX = av.getStartRes();\r
 607     int oldY = av.getStartSeq();\r
 608 \r
 609     if (evt.getSource() == hscroll)\r
 610     {\r
 611       int x = hscroll.getValue();\r
 612       av.setStartRes(x);\r
 613       av.setEndRes( (x +\r
 614                      (seqPanel.seqCanvas.getWidth() / av.getCharWidth())) - 1);\r
 615     }\r
 616 \r
 617     if (evt.getSource() == vscroll)\r
 618     {\r
 619       int offy = vscroll.getValue();\r
 620 \r
 621       if (av.getWrapAlignment())\r
 622       {\r
 623         if(offy>-1)\r
 624         {\r
 625           int rowSize = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.\r
 626               seqCanvas.getWidth());\r
 627           av.setStartRes(offy * rowSize);\r
 628           av.setEndRes( (offy + 1) * rowSize);\r
 629         }\r
 630         else\r
 631         {\r
 632           //This is only called if file loaded is a jar file that\r
 633           //was wrapped when saved and user has wrap alignment true\r
 634           //as preference setting\r
 635           SwingUtilities.invokeLater(new Runnable()\r
 636               {\r
 637                 public void run()\r
 638                 {\r
 639                   setScrollValues(av.getStartRes(), av.getStartSeq());\r
 640                 }\r
 641               });\r
 642         }\r
 643       }\r
 644       else\r
 645       {\r
 646         av.setStartSeq(offy);\r
 647         av.setEndSeq(offy +\r
 648                      (seqPanel.seqCanvas.getHeight() / av.getCharHeight()));\r
 649       }\r
 650     }\r
 651 \r
 652     if (overviewPanel != null)\r
 653     {\r
 654       overviewPanel.setBoxPosition();\r
 655     }\r
 656 \r
 657     int scrollX = av.startRes - oldX;\r
 658     int scrollY = av.startSeq - oldY;\r
 659 \r
 660     if (av.getWrapAlignment() || !fastPaint)\r
 661     {\r
 662       repaint();\r
 663     }\r
 664     else\r
 665     {\r
 666       // Make sure we're not trying to draw a panel\r
 667       // larger than the visible window\r
 668       if(scrollX>av.endRes-av.startRes)\r
 669         scrollX = av.endRes-av.startRes;\r
 670       else if(scrollX<av.startRes-av.endRes)\r
 671         scrollX = av.startRes - av.endRes;\r
 672 \r
 673       if(scrollX!=0 || scrollY!=0)\r
 674       {\r
 675         idPanel.idCanvas.fastPaint(scrollY);\r
 676         seqPanel.seqCanvas.fastPaint(scrollX,\r
 677                                      scrollY);\r
 678         scalePanel.repaint();\r
 679 \r
 680         if (av.getShowAnnotation())\r
 681         {\r
 682           annotationPanel.fastPaint(scrollX);\r
 683         }\r
 684       }\r
 685     }\r
 686   }\r
 687 \r
 688   /**\r
 689    * DOCUMENT ME!\r
 690    *\r
 691    * @param g DOCUMENT ME!\r
 692    */\r
 693   public void paintComponent(Graphics g)\r
 694   {\r
 695     invalidate();\r
 696 \r
 697     Dimension d = idPanel.idCanvas.getPreferredSize();\r
 698     idPanelHolder.setPreferredSize(d);\r
 699     hscrollFillerPanel.setPreferredSize(new Dimension(d.width, 12));\r
 700     validate();\r
 701 \r
 702     if (av.getWrapAlignment())\r
 703     {\r
 704       int maxwidth = av.alignment.getWidth();\r
 705 \r
 706       if (av.hasHiddenColumns)\r
 707         maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
 708 \r
 709       int max = maxwidth /\r
 710           seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth()) +\r
 711           1;\r
 712 \r
 713 \r
 714       vscroll.setMaximum(max);\r
 715       vscroll.setUnitIncrement(1);\r
 716       vscroll.setVisibleAmount(1);\r
 717     }\r
 718     else\r
 719     {\r
 720       setScrollValues(av.getStartRes(), av.getStartSeq());\r
 721     }\r
 722 \r
 723     if( this.getVisibleRect().getBounds() == g.getClipBounds()\r
 724         && overviewPanel != null)\r
 725         overviewPanel.updateOverviewImage();\r
 726 \r
 727   }\r
 728 \r
 729   /**\r
 730    * DOCUMENT ME!\r
 731    *\r
 732    * @param pg DOCUMENT ME!\r
 733    * @param pf DOCUMENT ME!\r
 734    * @param pi DOCUMENT ME!\r
 735    *\r
 736    * @return DOCUMENT ME!\r
 737    *\r
 738    * @throws PrinterException DOCUMENT ME!\r
 739    */\r
 740   public int print(Graphics pg, PageFormat pf, int pi)\r
 741       throws PrinterException\r
 742   {\r
 743     pg.translate( (int) pf.getImageableX(), (int) pf.getImageableY());\r
 744 \r
 745     int pwidth = (int) pf.getImageableWidth();\r
 746     int pheight = (int) pf.getImageableHeight();\r
 747 \r
 748     if (av.getWrapAlignment())\r
 749     {\r
 750       return printWrappedAlignment(pg, pwidth, pheight, pi);\r
 751     }\r
 752     else\r
 753     {\r
 754       return printUnwrapped(pg, pwidth, pheight, pi);\r
 755     }\r
 756   }\r
 757 \r
 758   /**\r
 759    * DOCUMENT ME!\r
 760    *\r
 761    * @param pg DOCUMENT ME!\r
 762    * @param pwidth DOCUMENT ME!\r
 763    * @param pheight DOCUMENT ME!\r
 764    * @param pi DOCUMENT ME!\r
 765    *\r
 766    * @return DOCUMENT ME!\r
 767    *\r
 768    * @throws PrinterException DOCUMENT ME!\r
 769    */\r
 770   public int printUnwrapped(Graphics pg, int pwidth, int pheight, int pi)\r
 771       throws PrinterException\r
 772   {\r
 773     int idWidth = calculateIdWidth().width + 4;\r
 774     FontMetrics fm = getFontMetrics(av.getFont());\r
 775     int scaleHeight = av.charHeight + fm.getDescent();\r
 776 \r
 777     pg.setColor(Color.white);\r
 778     pg.fillRect(0, 0, pwidth, pheight);\r
 779     pg.setFont(av.getFont());\r
 780 \r
 781     ////////////////////////////////////\r
 782     /// How many sequences and residues can we fit on a printable page?\r
 783     int totalRes = (pwidth - idWidth) / av.getCharWidth();\r
 784 \r
 785     int totalSeq = (int) ( (pheight - scaleHeight) / av.getCharHeight()) -\r
 786         1;\r
 787 \r
 788     int pagesWide = (av.getAlignment().getWidth() / totalRes) + 1;\r
 789 \r
 790     /////////////////////////////\r
 791     /// Only print these sequences and residues on this page\r
 792     int startRes;\r
 793 \r
 794     /////////////////////////////\r
 795     /// Only print these sequences and residues on this page\r
 796     int endRes;\r
 797 \r
 798     /////////////////////////////\r
 799     /// Only print these sequences and residues on this page\r
 800     int startSeq;\r
 801 \r
 802     /////////////////////////////\r
 803     /// Only print these sequences and residues on this page\r
 804     int endSeq;\r
 805     startRes = (pi % pagesWide) * totalRes;\r
 806     endRes = (startRes + totalRes) - 1;\r
 807 \r
 808     if (endRes > (av.getAlignment().getWidth() - 1))\r
 809     {\r
 810       endRes = av.getAlignment().getWidth() - 1;\r
 811     }\r
 812 \r
 813     startSeq = (pi / pagesWide) * totalSeq;\r
 814     endSeq = startSeq + totalSeq;\r
 815 \r
 816     if (endSeq > av.getAlignment().getHeight())\r
 817     {\r
 818       endSeq = av.getAlignment().getHeight();\r
 819     }\r
 820 \r
 821     int pagesHigh = ( (av.alignment.getHeight() / totalSeq) + 1) * pheight;\r
 822 \r
 823     if (av.showAnnotation)\r
 824     {\r
 825       pagesHigh += annotationPanel.adjustPanelHeight() + 3;\r
 826     }\r
 827 \r
 828     pagesHigh /= pheight;\r
 829 \r
 830     if (pi >= (pagesWide * pagesHigh))\r
 831     {\r
 832       return Printable.NO_SUCH_PAGE;\r
 833     }\r
 834 \r
 835     //draw Scale\r
 836     pg.translate(idWidth, 0);\r
 837     scalePanel.drawScale(pg, startRes, endRes, pwidth - idWidth, scaleHeight);\r
 838     pg.translate( -idWidth, scaleHeight);\r
 839 \r
 840     ////////////////\r
 841     // Draw the ids\r
 842     Color currentColor = null;\r
 843     Color currentTextColor = null;\r
 844 \r
 845     pg.setFont(new Font(av.getFont().getName(),\r
 846                         Font.ITALIC,\r
 847                         av.getFont().getSize()));\r
 848     for (int i = startSeq; i < endSeq; i++)\r
 849     {\r
 850       if ( (av.getSelectionGroup() != null) &&\r
 851           av.getSelectionGroup().getSequences(false).contains(\r
 852               av.getAlignment().getSequenceAt(i)))\r
 853       {\r
 854         currentColor = Color.gray;\r
 855         currentTextColor = Color.black;\r
 856       }\r
 857       else\r
 858       {\r
 859         currentColor = av.getAlignment().getSequenceAt(i).getColor();\r
 860         currentTextColor = Color.black;\r
 861       }\r
 862 \r
 863       pg.setColor(currentColor);\r
 864       pg.fillRect(0, (i - startSeq) * av.charHeight, idWidth,\r
 865                   av.getCharHeight());\r
 866 \r
 867       pg.setColor(currentTextColor);\r
 868 \r
 869       String string = av.getAlignment().getSequenceAt(i).getDisplayId\r
 870           ( av.getShowJVSuffix());\r
 871 \r
 872       pg.drawString(string, 0,\r
 873                     ( ( (i - startSeq) * av.charHeight) + av.getCharHeight()) -\r
 874                     (av.getCharHeight() / 5));\r
 875     }\r
 876 \r
 877     pg.setFont(av.getFont());\r
 878 \r
 879     // draw main sequence panel\r
 880     pg.translate(idWidth, 0);\r
 881     seqPanel.seqCanvas.drawPanel(pg, startRes, endRes, startSeq, endSeq, 0);\r
 882 \r
 883     if (av.showAnnotation && (endSeq == av.alignment.getHeight()))\r
 884     {\r
 885       pg.translate( -idWidth-3, (endSeq - startSeq) * av.charHeight + 3);\r
 886       alabels.drawComponent( (Graphics2D) pg, idWidth);\r
 887       pg.translate(idWidth+3, 0);\r
 888       annotationPanel.drawComponent( (Graphics2D) pg, startRes, endRes +\r
 889                                     1);\r
 890     }\r
 891 \r
 892     return Printable.PAGE_EXISTS;\r
 893   }\r
 894 \r
 895   /**\r
 896    * DOCUMENT ME!\r
 897    *\r
 898    * @param pg DOCUMENT ME!\r
 899    * @param pwidth DOCUMENT ME!\r
 900    * @param pheight DOCUMENT ME!\r
 901    * @param pi DOCUMENT ME!\r
 902    *\r
 903    * @return DOCUMENT ME!\r
 904    *\r
 905    * @throws PrinterException DOCUMENT ME!\r
 906    */\r
 907   public int printWrappedAlignment(Graphics pg, int pwidth, int pheight,\r
 908                                    int pi)\r
 909       throws PrinterException\r
 910   {\r
 911 \r
 912     int annotationHeight = 0;\r
 913     AnnotationLabels labels = null;\r
 914     if (av.showAnnotation)\r
 915     {\r
 916       annotationHeight = annotationPanel.adjustPanelHeight();\r
 917       labels = new AnnotationLabels(av);\r
 918     }\r
 919 \r
 920     int hgap = av.charHeight;\r
 921     if (av.scaleAboveWrapped)\r
 922       hgap += av.charHeight;\r
 923 \r
 924     int cHeight = av.getAlignment().getHeight() * av.charHeight\r
 925         + hgap\r
 926         + annotationHeight;\r
 927 \r
 928     int idWidth = calculateIdWidth().width + 4;\r
 929 \r
 930     int maxwidth = av.alignment.getWidth();\r
 931     if (av.hasHiddenColumns)\r
 932       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
 933 \r
 934 \r
 935     int resWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(pwidth -\r
 936         idWidth);\r
 937 \r
 938     int totalHeight = cHeight * (maxwidth / resWidth + 1);\r
 939 \r
 940     pg.setColor(Color.white);\r
 941     pg.fillRect(0, 0, pwidth, pheight);\r
 942     pg.setFont(av.getFont());\r
 943 \r
 944     ////////////////\r
 945     // Draw the ids\r
 946     pg.setColor(Color.black);\r
 947 \r
 948     pg.translate(0, -pi * pheight);\r
 949 \r
 950     pg.setClip(0, pi * pheight, pwidth, pheight);\r
 951 \r
 952     int ypos = hgap;\r
 953     Font italic = new Font(av.getFont().getName(), Font.ITALIC,\r
 954                            av.getFont().getSize());\r
 955     pg.setFont(italic);\r
 956 \r
 957     do\r
 958     {\r
 959       for (int i = 0; i < av.alignment.getHeight(); i++)\r
 960       {\r
 961         SequenceI s = av.alignment.getSequenceAt(i);\r
 962         String string = s.getDisplayId( av.getShowJVSuffix());\r
 963 \r
 964         pg.drawString(string, 0,\r
 965                       ( (i * av.charHeight) + ypos + av.charHeight) -\r
 966                       (av.charHeight / 5));\r
 967       }\r
 968       if (labels != null)\r
 969       {\r
 970         pg.translate(-3,\r
 971                      ypos +\r
 972                      (av.getAlignment().getHeight() * av.charHeight));\r
 973 \r
 974         pg.setFont(av.getFont());\r
 975         labels.drawComponent(pg, idWidth);\r
 976         pg.setFont(italic);\r
 977         pg.translate(+3,\r
 978                      -ypos -\r
 979                      (av.getAlignment().getHeight() * av.charHeight));\r
 980       }\r
 981 \r
 982       ypos += cHeight;\r
 983     }\r
 984     while (ypos < totalHeight);\r
 985 \r
 986     pg.translate(idWidth, 0);\r
 987 \r
 988     seqPanel.seqCanvas.drawWrappedPanel(pg, pwidth - idWidth, totalHeight, 0);\r
 989 \r
 990     if ( (pi * pheight) < totalHeight)\r
 991     {\r
 992       return Printable.PAGE_EXISTS;\r
 993 \r
 994     }\r
 995     else\r
 996     {\r
 997       return Printable.NO_SUCH_PAGE;\r
 998     }\r
 999   }\r
1000 \r
1001   void makeAlignmentImage(int type, File file)\r
1002   {\r
1003     int maxwidth = av.alignment.getWidth();\r
1004     if (av.hasHiddenColumns)\r
1005       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth);\r
1006 \r
1007     int height = ( (av.alignment.getHeight() + 1) * av.charHeight) + 30;\r
1008     int width = idPanel.getWidth() + (maxwidth * av.charWidth);\r
1009     if (idPanel.getWidth() == 0)\r
1010     {\r
1011       width += calculateIdWidth().getWidth() + 4;\r
1012     }\r
1013 \r
1014     if (av.getWrapAlignment())\r
1015     {\r
1016       height = getWrappedHeight();\r
1017       if (System.getProperty("java.awt.headless") != null\r
1018           && System.getProperty("java.awt.headless").equals("true"))\r
1019       {\r
1020         width = alignFrame.getWidth() - 22;\r
1021       }\r
1022       else\r
1023         width = seqPanel.getWidth() + idPanel.getWidth();\r
1024 \r
1025     }\r
1026     else if (av.getShowAnnotation())\r
1027     {\r
1028       height += annotationPanel.adjustPanelHeight() + 3;\r
1029     }\r
1030 \r
1031     jalview.util.ImageMaker im;\r
1032     if(type==jalview.util.ImageMaker.PNG)\r
1033       im  = new jalview.util.ImageMaker(this,\r
1034                                         jalview.util.ImageMaker.PNG,\r
1035                                         "Create PNG image from alignment",\r
1036                                         width, height, file, null);\r
1037     else\r
1038       im = new jalview.util.ImageMaker(this,\r
1039                                         jalview.util.ImageMaker.EPS,\r
1040                                        "Create EPS file from alignment",\r
1041                                         width, height, file, alignFrame.getTitle() );\r
1042 \r
1043     try\r
1044     {\r
1045       if (av.getWrapAlignment())\r
1046       {\r
1047         if(im.getGraphics()!=null)\r
1048         {\r
1049           printWrappedAlignment(im.getGraphics(), width, height, 0);\r
1050           im.writeImage();\r
1051         }\r
1052       }\r
1053       else\r
1054       {\r
1055         if(im.getGraphics()!=null)\r
1056         {\r
1057           printUnwrapped(im.getGraphics(), width, height, 0);\r
1058           im.writeImage();\r
1059         }\r
1060       }\r
1061     }\r
1062     catch (OutOfMemoryError err)\r
1063     {\r
1064       System.out.println("########################\n"\r
1065                          + "OUT OF MEMORY " + file + "\n"\r
1066                          + "########################");\r
1067 \r
1068       JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
1069                                             "Out of Memory Creating Image!!"\r
1070                                             +\r
1071                                             "\nSee help files for increasing Java Virtual Machine memory."\r
1072                                             , "Out of memory",\r
1073                                             JOptionPane.WARNING_MESSAGE);\r
1074       System.out.println("Create IMAGE: " + err);\r
1075       System.gc();\r
1076 \r
1077     }\r
1078     catch (Exception ex)\r
1079     {\r
1080       ex.printStackTrace();\r
1081     }\r
1082   }\r
1083   /**\r
1084    * DOCUMENT ME!\r
1085    */\r
1086   public void makeEPS(File epsFile)\r
1087   {\r
1088     makeAlignmentImage(jalview.util.ImageMaker.EPS, epsFile);\r
1089   }\r
1090 \r
1091   /**\r
1092    * DOCUMENT ME!\r
1093    */\r
1094   public void makePNG(File pngFile)\r
1095   {\r
1096     makeAlignmentImage(jalview.util.ImageMaker.PNG, pngFile);\r
1097   }\r
1098 \r
1099   public void makePNGImageMap(File imgMapFile, String imageName)\r
1100   {\r
1101     ///////ONLY WORKS WITH NONE WRAPPED ALIGNMENTS\r
1102     //////////////////////////////////////////////\r
1103     int idWidth = calculateIdWidth().width + 4;\r
1104     FontMetrics fm = getFontMetrics(av.getFont());\r
1105     int scaleHeight = av.charHeight + fm.getDescent();\r
1106 \r
1107     // Gen image map\r
1108     //////////////////////////////////\r
1109     if (imgMapFile != null)\r
1110     {\r
1111       try\r
1112       {\r
1113         int s, sSize = av.alignment.getHeight(),\r
1114             res, alwidth = av.alignment.getWidth(), g, gSize, f, fSize, sy;\r
1115         StringBuffer text = new StringBuffer();\r
1116         PrintWriter out = new PrintWriter(new FileWriter(imgMapFile));\r
1117         out.println(jalview.io.HTMLOutput.getImageMapHTML());\r
1118         out.println("<img src=\"" + imageName +\r
1119                     "\" border=\"0\" usemap=\"#Map\" >"\r
1120                     + "<map name=\"Map\">");\r
1121 \r
1122         for (s = 0; s < sSize; s++)\r
1123         {\r
1124           sy = s * av.charHeight + scaleHeight;\r
1125 \r
1126           SequenceI seq = av.alignment.getSequenceAt(s);\r
1127           SequenceFeature [] features = seq.getDatasetSequence().getSequenceFeatures();\r
1128           SequenceGroup[] groups = av.alignment.findAllGroups(seq);\r
1129           for(res =0; res<alwidth; res++)\r
1130           {\r
1131             text = new StringBuffer();\r
1132             Object obj = null;\r
1133             if(av.alignment.isNucleotide())\r
1134               obj = ResidueProperties.nucleotideName.get(seq.getCharAt(res)+"" );\r
1135             else\r
1136               obj = ResidueProperties.aa2Triplet.get(\r
1137                     seq.getCharAt(res) + "");\r
1138 \r
1139               if (obj == null)\r
1140                   continue;\r
1141 \r
1142             String triplet = obj.toString();\r
1143             int alIndex = seq.findPosition(res);\r
1144             gSize = groups.length;\r
1145             for (g = 0; g < gSize; g++)\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 \r
1158               if(groups[g].getStartRes()<res && groups[g].getEndRes()>res)\r
1159                 text.append("<br><em>" + groups[g].getName() + "</em>");\r
1160             }\r
1161 \r
1162             if (features != null)\r
1163             {\r
1164               if(text.length()<1)\r
1165               {\r
1166                 text.append("<area shape=\"rect\" coords=\""\r
1167                   + (idWidth + res * av.charWidth) + ","\r
1168                   + sy + ","\r
1169                   + (idWidth + (res + 1) * av.charWidth) + ","\r
1170                   + (av.charHeight + sy) + "\""\r
1171                   + " onMouseOver=\"toolTip('"\r
1172                   + alIndex + " " + triplet );\r
1173               }\r
1174                 fSize = features.length;\r
1175                 for (f = 0; f < fSize; f++)\r
1176                 {\r
1177 \r
1178                   if ( (features[f].getBegin() <= seq.findPosition(res)) &&\r
1179                       (features[f].getEnd() >= seq.findPosition(res)))\r
1180                   {\r
1181                     if (features[f].getType().equals("disulfide bond"))\r
1182                     {\r
1183                       if (features[f].getBegin() == seq.findPosition(res)\r
1184                           || features[f].getEnd() == seq.findPosition(res))\r
1185                       {\r
1186                         text.append("<br>disulfide bond " + features[f].getBegin() + ":" +\r
1187                                        features[f].getEnd());\r
1188                       }\r
1189                     }\r
1190                     else\r
1191                     {\r
1192                       text.append("<br>");\r
1193                       text.append(features[f].getType());\r
1194                       if (features[f].getDescription() != null && !features[f].getType().equals(features[f].getDescription()))\r
1195                         text.append(" " + features[f].getDescription());\r
1196 \r
1197                       if (features[f].getValue("status") != null )\r
1198                       {\r
1199                         text.append(" (" + features[f].getValue("status") + ")");\r
1200                       }\r
1201                     }\r
1202                   }\r
1203 \r
1204                 }\r
1205               }\r
1206               if(text.length()>1)\r
1207               {\r
1208                 text.append("')\"; onMouseOut=\"toolTip()\";  href=\"#\">");\r
1209                 out.println(text.toString());\r
1210               }\r
1211             }\r
1212           }\r
1213         out.println("</map></body></html>");\r
1214         out.close();\r
1215 \r
1216       }\r
1217       catch (Exception ex)\r
1218       {\r
1219         ex.printStackTrace();\r
1220       }\r
1221     } ///////////END OF IMAGE MAP\r
1222 \r
1223   }\r
1224 \r
1225   int getWrappedHeight()\r
1226   {\r
1227     int seqPanelWidth = seqPanel.seqCanvas.getWidth();\r
1228 \r
1229     //If headless, seqPanel will have 0 width\r
1230     if (System.getProperty("java.awt.headless") != null\r
1231               && System.getProperty("java.awt.headless").equals("true"))\r
1232     {\r
1233       int idWidth = calculateIdWidth().width + 4;\r
1234       seqPanelWidth = alignFrame.getWidth() - idWidth;\r
1235     }\r
1236 \r
1237     int chunkWidth = seqPanel.seqCanvas.getWrappedCanvasWidth(\r
1238         seqPanelWidth\r
1239           );\r
1240 \r
1241     int hgap = av.charHeight;\r
1242     if (av.scaleAboveWrapped)\r
1243       hgap += av.charHeight;\r
1244 \r
1245     int annotationHeight = 0;\r
1246     if (av.showAnnotation)\r
1247     {\r
1248       annotationHeight = annotationPanel.adjustPanelHeight();\r
1249     }\r
1250 \r
1251     int cHeight = av.getAlignment().getHeight() * av.charHeight\r
1252         + hgap\r
1253         + annotationHeight;\r
1254 \r
1255     int maxwidth = av.alignment.getWidth();\r
1256     if (av.hasHiddenColumns)\r
1257       maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;\r
1258 \r
1259 \r
1260     int height = ( (maxwidth / chunkWidth) + 1) * cHeight;\r
1261 \r
1262     return height;\r
1263   }\r
1264 \r
1265   /**\r
1266    * DOCUMENT ME!\r
1267    *\r
1268    * @author $author$\r
1269    * @version $Revision$\r
1270    */\r
1271   class Preview\r
1272       extends JFrame\r
1273   {\r
1274     /**\r
1275      * Creates a new Preview object.\r
1276      *\r
1277      * @param image DOCUMENT ME!\r
1278      */\r
1279     public Preview(Image image)\r
1280     {\r
1281       setResizable(true);\r
1282       setSize(image.getWidth(this), image.getHeight(this));\r
1283       setVisible(true);\r
1284       getContentPane().setLayout(new BorderLayout());\r
1285       getContentPane().add(new PreviewPanel(image), BorderLayout.CENTER);\r
1286       validate();\r
1287       repaint();\r
1288     }\r
1289   }\r
1290 \r
1291   /**\r
1292    * DOCUMENT ME!\r
1293    *\r
1294    * @author $author$\r
1295    * @version $Revision$\r
1296    */\r
1297   class PreviewPanel\r
1298       extends JPanel\r
1299   {\r
1300     Image image;\r
1301 \r
1302     /**\r
1303      * Creates a new PreviewPanel object.\r
1304      *\r
1305      * @param image DOCUMENT ME!\r
1306      */\r
1307     public PreviewPanel(Image image)\r
1308     {\r
1309       this.image = image;\r
1310     }\r
1311 \r
1312     /**\r
1313      * DOCUMENT ME!\r
1314      *\r
1315      * @param g DOCUMENT ME!\r
1316      */\r
1317     public void paintComponent(Graphics g)\r
1318     {\r
1319       if (image != null)\r
1320       {\r
1321         g.drawImage(image, 0, 0, this);\r
1322       }\r
1323       else\r
1324       {\r
1325         System.out.println("DEBUG:image is null");\r
1326       }\r
1327     }\r
1328   }\r
1329 }\r