src/jalview/gui/AlignmentPanel.java

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