src/jalview/appletgui/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 \r
  20 package jalview.appletgui;\r
  21 \r
  22 import java.awt.*;\r
  23 import java.awt.event.*;\r
  24 \r
  25 import jalview.datamodel.*;\r
  26 \r
  27 public class AlignmentPanel extends Panel implements AdjustmentListener\r
  28 {\r
  29 \r
  30   AlignViewport av;\r
  31   OverviewPanel overviewPanel;\r
  32   SeqPanel seqPanel;\r
  33   IdPanel idPanel;\r
  34   IdwidthAdjuster idwidthAdjuster;\r
  35   public AlignFrame alignFrame;\r
  36   ScalePanel scalePanel;\r
  37   AnnotationPanel annotationPanel;\r
  38   AnnotationLabels alabels;\r
  39 \r
  40   // this value is set false when selection area being dragged\r
  41   boolean fastPaint = true;\r
  42 \r
  43   boolean MAC = false;\r
  44 \r
  45   public AlignmentPanel(AlignFrame af, final AlignViewport av)\r
  46   {\r
  47     try\r
  48     {\r
  49       jbInit();\r
  50     }\r
  51     catch (Exception e)\r
  52     {\r
  53       e.printStackTrace();\r
  54     }\r
  55 \r
  56     if(System.getProperty("os.name").startsWith("Mac"))\r
  57       MAC = true;\r
  58 \r
  59     alignFrame = af;\r
  60     this.av = av;\r
  61     seqPanel = new SeqPanel(av, this);\r
  62     idPanel = new IdPanel(av, this);\r
  63     scalePanel = new ScalePanel(av, this);\r
  64     idwidthAdjuster = new IdwidthAdjuster(this);\r
  65     annotationPanel = new AnnotationPanel(this);\r
  66     alabels = new AnnotationLabels(this);\r
  67 \r
  68     idPanelHolder.add(idPanel, BorderLayout.CENTER);\r
  69     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);\r
  70     annotationScroller.add(annotationPanel);\r
  71     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);\r
  72     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);\r
  73     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);\r
  74 \r
  75     fontChanged();\r
  76     setScrollValues(0, 0);\r
  77 \r
  78     hscroll.addAdjustmentListener(this);\r
  79     vscroll.addAdjustmentListener(this);\r
  80 \r
  81     seqPanel.seqCanvas.addKeyListener(new MyKeyAdapter());\r
  82     idPanel.idCanvas.addKeyListener(new MyKeyAdapter());\r
  83 \r
  84     addComponentListener(new ComponentAdapter()\r
  85     {\r
  86       public void componentResized(ComponentEvent evt)\r
  87       {\r
  88         setScrollValues(av.getStartRes(), av.getStartSeq());\r
  89         repaint();\r
  90       }\r
  91     });\r
  92 \r
  93     Dimension d = calculateIdWidth();\r
  94     idPanel.idCanvas.setSize(d);\r
  95 \r
  96     hscrollFillerPanel.setSize(d.width, annotationPanel.getSize().height);\r
  97     annotationScroller.setSize(annotationPanel.getSize());\r
  98 \r
  99     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);\r
 100     annotationSpaceFillerHolder.setSize(d.width,\r
 101                                         annotationPanel.getSize().height);\r
 102     alabels.setSize(d.width, annotationPanel.getSize().height);\r
 103 \r
 104   }\r
 105 \r
 106   class MyKeyAdapter\r
 107       extends KeyAdapter\r
 108   {\r
 109     public void keyPressed(KeyEvent evt)\r
 110     {\r
 111       // System.out.println(evt.getKeyCode()); log.\r
 112       switch (evt.getKeyCode())\r
 113       {\r
 114         case 27: // escape key\r
 115           av.setSelectionGroup(null);\r
 116           alignFrame.alignPanel.repaint();\r
 117           break;\r
 118         case KeyEvent.VK_X:\r
 119           if (evt.isControlDown())\r
 120           {\r
 121             alignFrame.cut_actionPerformed(null);\r
 122           }\r
 123           break;\r
 124         case KeyEvent.VK_C:\r
 125           if (evt.isControlDown())\r
 126           {\r
 127             alignFrame.copy_actionPerformed(null);\r
 128           }\r
 129           break;\r
 130         case KeyEvent.VK_V:\r
 131           if (evt.isControlDown())\r
 132           {\r
 133             alignFrame.paste(true);\r
 134           }\r
 135           break;\r
 136         case KeyEvent.VK_A:\r
 137           if (evt.isControlDown())\r
 138           {\r
 139             alignFrame.selectAllSequenceMenuItem_actionPerformed(null);\r
 140           }\r
 141           break;\r
 142         case KeyEvent.VK_DOWN:\r
 143           alignFrame.moveSelectedSequences(false);\r
 144           break;\r
 145         case KeyEvent.VK_UP:\r
 146           alignFrame.moveSelectedSequences(true);\r
 147           break;\r
 148         case KeyEvent.VK_F:\r
 149           if (evt.isControlDown())\r
 150           {\r
 151             alignFrame.findMenuItem_actionPerformed(null);\r
 152           }\r
 153           break;\r
 154         case KeyEvent.VK_BACK_SPACE:\r
 155         case KeyEvent.VK_DELETE:\r
 156           alignFrame.cut_actionPerformed(null);\r
 157           break;\r
 158 \r
 159       }\r
 160     }\r
 161   }\r
 162 \r
 163   public void fontChanged()\r
 164   {\r
 165     // set idCanvas bufferedImage to null\r
 166     // to prevent drawing old image\r
 167     FontMetrics fm = getFontMetrics(av.getFont());\r
 168 \r
 169     scalePanel.setSize(new Dimension(10, av.charHeight + fm.getDescent()));\r
 170     idwidthAdjuster.setSize(new Dimension(10, av.charHeight + fm.getDescent()));\r
 171 \r
 172     annotationPanel.adjustPanelHeight();\r
 173     annotationPanel.repaint();\r
 174     Dimension d = calculateIdWidth();\r
 175     d.setSize(d.width + 4, seqPanel.seqCanvas.getSize().height);\r
 176     idPanel.idCanvas.setSize(d);\r
 177     hscrollFillerPanel.setSize(d);\r
 178 \r
 179     alignFrame.pack();\r
 180 \r
 181     if(overviewPanel!=null)\r
 182           overviewPanel.updateOverviewImage();\r
 183   }\r
 184 \r
 185   public void setIdWidth(int w, int h)\r
 186   {\r
 187     idPanel.idCanvas.setSize(w, h);\r
 188     idPanelHolder.setSize(w, idPanelHolder.getSize().height);\r
 189     alabels.setSize(w, alabels.getSize().height);\r
 190     validate();\r
 191   }\r
 192 \r
 193   Dimension calculateIdWidth()\r
 194   {\r
 195     Frame frame = new Frame();\r
 196     frame.addNotify();\r
 197     Graphics g = frame.getGraphics();\r
 198     if (g == null)\r
 199     {\r
 200       Frame f = new Frame();\r
 201       f.addNotify();\r
 202       g = f.getGraphics();\r
 203     }\r
 204 \r
 205     FontMetrics fm = g.getFontMetrics(av.font);\r
 206     AlignmentI al = av.getAlignment();\r
 207 \r
 208     int i = 0;\r
 209     int idWidth = 0;\r
 210     String id;\r
 211     while (i < al.getHeight() && al.getSequenceAt(i) != null)\r
 212     {\r
 213       SequenceI s = al.getSequenceAt(i);\r
 214       id = s.getDisplayId(av.getShowDBPrefix(), av.getShowJVSuffix());\r
 215 \r
 216       if (fm.stringWidth(id) > idWidth)\r
 217       {\r
 218         idWidth = fm.stringWidth(id);\r
 219       }\r
 220       i++;\r
 221     }\r
 222 \r
 223     // Also check annotation label widths\r
 224     i = 0;\r
 225     if (al.getAlignmentAnnotation() != null)\r
 226     {\r
 227       fm = g.getFontMetrics(frame.getFont());\r
 228       while (i < al.getAlignmentAnnotation().length)\r
 229       {\r
 230         String label = al.getAlignmentAnnotation()[i].label;\r
 231         if (fm.stringWidth(label) > idWidth)\r
 232         {\r
 233           idWidth = fm.stringWidth(label);\r
 234         }\r
 235         i++;\r
 236       }\r
 237     }\r
 238 \r
 239     return new Dimension(idWidth, idPanel.idCanvas.getSize().height);\r
 240   }\r
 241 \r
 242   public void highlightSearchResults(int[] results)\r
 243   {\r
 244     seqPanel.seqCanvas.highlightSearchResults(results);\r
 245 \r
 246     // do we need to scroll the panel?\r
 247     if (results != null)\r
 248     {\r
 249       SequenceI seq = av.alignment.getSequenceAt(results[0]);\r
 250       int start = seq.findIndex(results[1]) - 1;\r
 251       int end = seq.findIndex(results[2]) - 1;\r
 252       if (av.getStartRes() > start\r
 253           || av.getEndRes() < end\r
 254           || (av.getStartSeq() > results[0]\r
 255               || av.getEndSeq() < results[0]))\r
 256       {\r
 257         setScrollValues(start, results[0]);\r
 258       }\r
 259     }\r
 260 \r
 261   }\r
 262 \r
 263   public OverviewPanel getOverviewPanel()\r
 264   {\r
 265     return overviewPanel;\r
 266   }\r
 267 \r
 268   public void setOverviewPanel(OverviewPanel op)\r
 269   {\r
 270     overviewPanel = op;\r
 271   }\r
 272 \r
 273   public void setAnnotationVisible(boolean b)\r
 274   {\r
 275     if (!av.wrapAlignment)\r
 276     {\r
 277       annotationSpaceFillerHolder.setVisible(b);\r
 278       annotationScroller.setVisible(b);\r
 279     }\r
 280     validate();\r
 281     repaint();\r
 282   }\r
 283 \r
 284   public void setWrapAlignment(boolean wrap)\r
 285   {\r
 286     av.startSeq = 0;\r
 287     scalePanelHolder.setVisible(!wrap);\r
 288     hscroll.setVisible(!wrap);\r
 289     idwidthAdjuster.setVisible(!wrap);\r
 290 \r
 291     if (wrap)\r
 292     {\r
 293       annotationScroller.setVisible(false);\r
 294       annotationSpaceFillerHolder.setVisible(false);\r
 295     }\r
 296     else if (av.showAnnotation)\r
 297     {\r
 298       annotationScroller.setVisible(true);\r
 299       annotationSpaceFillerHolder.setVisible(true);\r
 300     }\r
 301 \r
 302     idSpaceFillerPanel1.setVisible(!wrap);\r
 303 \r
 304     validate();\r
 305     repaint();\r
 306 \r
 307   }\r
 308 \r
 309 \r
 310   int hextent = 0;\r
 311   int vextent = 0;\r
 312 \r
 313   // return value is true if the scroll is valid\r
 314   public boolean scrollUp(boolean up)\r
 315   {\r
 316     if (up)\r
 317     {\r
 318       if (vscroll.getValue() < 1)\r
 319       {\r
 320         return false;\r
 321       }\r
 322       fastPaint = false;\r
 323       vscroll.setValue(vscroll.getValue() - 1);\r
 324     }\r
 325     else\r
 326     {\r
 327       if (vextent + vscroll.getValue() >= av.getAlignment().getHeight())\r
 328       {\r
 329         return false;\r
 330       }\r
 331       fastPaint = false;\r
 332       vscroll.setValue(vscroll.getValue() + 1);\r
 333     }\r
 334     fastPaint = true;\r
 335     return true;\r
 336   }\r
 337 \r
 338   public boolean scrollRight(boolean right)\r
 339   {\r
 340 \r
 341     if (right)\r
 342     {\r
 343       if (hscroll.getValue() < 1)\r
 344       {\r
 345         return false;\r
 346       }\r
 347       fastPaint = false;\r
 348       hscroll.setValue(hscroll.getValue() - 1);\r
 349     }\r
 350     else\r
 351     {\r
 352       if (hextent + hscroll.getValue() >= av.getAlignment().getWidth())\r
 353       {\r
 354         return false;\r
 355       }\r
 356       fastPaint = false;\r
 357       hscroll.setValue(hscroll.getValue() + 1);\r
 358     }\r
 359     fastPaint = true;\r
 360     return true;\r
 361   }\r
 362 \r
 363   public void setScrollValues(int x, int y)\r
 364   {\r
 365 \r
 366     av.setStartRes(x);\r
 367     av.setStartSeq(y);\r
 368     av.setEndRes(x + seqPanel.seqCanvas.getSize().width / av.getCharWidth() - 1);\r
 369 \r
 370     hextent = seqPanel.seqCanvas.getSize().width / av.charWidth;\r
 371     vextent = seqPanel.seqCanvas.getSize().height / av.charHeight;\r
 372 \r
 373     if (hextent > av.alignment.getWidth())\r
 374     {\r
 375       hextent = av.alignment.getWidth();\r
 376     }\r
 377     if (vextent > av.alignment.getHeight())\r
 378     {\r
 379       vextent = av.alignment.getHeight();\r
 380     }\r
 381 \r
 382     if (hextent + x > av.getAlignment().getWidth())\r
 383     {\r
 384       x = av.getAlignment().getWidth() - hextent;\r
 385     }\r
 386 \r
 387     if (vextent + y > av.getAlignment().getHeight())\r
 388     {\r
 389       y = av.getAlignment().getHeight() - vextent;\r
 390     }\r
 391 \r
 392     if (y < 0)\r
 393     {\r
 394       y = 0;\r
 395     }\r
 396 \r
 397     if (x < 0)\r
 398     {\r
 399       x = 0;\r
 400     }\r
 401 \r
 402     int endSeq = y + vextent;\r
 403     if (endSeq > av.alignment.getHeight())\r
 404     {\r
 405       endSeq = av.alignment.getHeight();\r
 406     }\r
 407 \r
 408     av.setEndSeq(endSeq);\r
 409     hscroll.setValues(x, hextent, 0, av.getAlignment().getWidth());\r
 410     vscroll.setValues(y, vextent, 0, av.getAlignment().getHeight());\r
 411 \r
 412   }\r
 413 \r
 414   public void adjustmentValueChanged(AdjustmentEvent evt)\r
 415   {\r
 416     int oldX = av.getStartRes();\r
 417     int oldY = av.getStartSeq();\r
 418 \r
 419     if (evt.getSource() == hscroll)\r
 420     {\r
 421       int x = hscroll.getValue();\r
 422       av.setStartRes(x);\r
 423       av.setEndRes(x + seqPanel.seqCanvas.getSize().width / av.getCharWidth() -\r
 424                    1);\r
 425     }\r
 426 \r
 427     if (evt.getSource() == vscroll)\r
 428     {\r
 429       int offy = vscroll.getValue();\r
 430       if (av.getWrapAlignment())\r
 431       {\r
 432         int rowSize = seqPanel.seqCanvas.getWrappedCanvasWidth(seqPanel.\r
 433             seqCanvas.getSize().width);\r
 434         av.setStartRes(vscroll.getValue() * rowSize);\r
 435         av.setEndRes( (vscroll.getValue() + 1) * rowSize);\r
 436       }\r
 437       else\r
 438       {\r
 439         av.setStartSeq(offy);\r
 440         av.setEndSeq(offy +\r
 441                      seqPanel.seqCanvas.getSize().height / av.getCharHeight());\r
 442       }\r
 443     }\r
 444 \r
 445     if (overviewPanel != null)\r
 446     {\r
 447       overviewPanel.setBoxPosition();\r
 448     }\r
 449 \r
 450     if (av.getWrapAlignment() || !fastPaint || MAC)\r
 451     {\r
 452       repaint();\r
 453     }\r
 454     else\r
 455     {\r
 456       idPanel.idCanvas.fastPaint(av.getStartSeq() - oldY);\r
 457       seqPanel.seqCanvas.fastPaint(av.getStartRes() - oldX,\r
 458                                    av.getStartSeq() - oldY);\r
 459 \r
 460       scalePanel.repaint();\r
 461       if (av.getShowAnnotation())\r
 462       {\r
 463         annotationPanel.fastPaint(av.getStartRes() - oldX);\r
 464       }\r
 465     }\r
 466 \r
 467   }\r
 468 \r
 469   public void update(Graphics g)\r
 470   {\r
 471     paint(g);\r
 472   }\r
 473 \r
 474   public void paint(Graphics g)\r
 475   {\r
 476     Dimension d = idPanel.idCanvas.getSize();\r
 477     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);\r
 478     annotationSpaceFillerHolder.setSize(d.width,\r
 479                                         annotationPanel.getSize().height);\r
 480 \r
 481     alabels.setSize(d.width, annotationPanel.getSize().height);\r
 482 \r
 483     if (av.getWrapAlignment())\r
 484     {\r
 485       int max = av.alignment.getWidth() /\r
 486           seqPanel.seqCanvas.\r
 487           getWrappedCanvasWidth(seqPanel.seqCanvas.getSize().width);\r
 488       vscroll.setMaximum(max);\r
 489       vscroll.setUnitIncrement(1);\r
 490       vscroll.setVisibleAmount(1);\r
 491     }\r
 492     else\r
 493     {\r
 494       setScrollValues(av.getStartRes(), av.getStartSeq());\r
 495     }\r
 496 \r
 497     alabels.repaint();\r
 498     idPanel.idCanvas.repaint();\r
 499     seqPanel.seqCanvas.repaint();\r
 500     scalePanel.repaint();\r
 501     annotationPanel.repaint();\r
 502 \r
 503     if (getBounds() == g.getClipBounds())\r
 504     {\r
 505       if (overviewPanel != null)\r
 506         overviewPanel.updateOverviewImage();\r
 507     }\r
 508 \r
 509   }\r
 510 \r
 511   protected Panel sequenceHolderPanel = new Panel();\r
 512   protected Scrollbar vscroll = new Scrollbar();\r
 513   protected Scrollbar hscroll = new Scrollbar();\r
 514   protected Panel seqPanelHolder = new Panel();\r
 515   BorderLayout borderLayout1 = new BorderLayout();\r
 516   BorderLayout borderLayout3 = new BorderLayout();\r
 517   protected Panel scalePanelHolder = new Panel();\r
 518   protected Panel idPanelHolder = new Panel();\r
 519   BorderLayout borderLayout5 = new BorderLayout();\r
 520   protected Panel idSpaceFillerPanel1 = new Panel();\r
 521   public Panel annotationSpaceFillerHolder = new Panel();\r
 522   BorderLayout borderLayout6 = new BorderLayout();\r
 523   BorderLayout borderLayout7 = new BorderLayout();\r
 524   Panel hscrollHolder = new Panel();\r
 525   BorderLayout borderLayout10 = new BorderLayout();\r
 526   protected Panel hscrollFillerPanel = new Panel();\r
 527   BorderLayout borderLayout11 = new BorderLayout();\r
 528   public Panel annotationScroller = new Panel();\r
 529   BorderLayout borderLayout4 = new BorderLayout();\r
 530   BorderLayout borderLayout2 = new BorderLayout();\r
 531 \r
 532   private void jbInit() throws Exception {\r
 533       //  idPanelHolder.setPreferredSize(new Dimension(70, 10));\r
 534       this.setLayout(borderLayout7);\r
 535 \r
 536       //   sequenceHolderPanel.setPreferredSize(new Dimension(150, 150));\r
 537       sequenceHolderPanel.setLayout(borderLayout3);\r
 538       seqPanelHolder.setLayout(borderLayout1);\r
 539       scalePanelHolder.setBackground(Color.white);\r
 540 \r
 541       // scalePanelHolder.setPreferredSize(new Dimension(10, 30));\r
 542       scalePanelHolder.setLayout(borderLayout6);\r
 543       idPanelHolder.setLayout(borderLayout5);\r
 544       idSpaceFillerPanel1.setBackground(Color.white);\r
 545 \r
 546       //  idSpaceFillerPanel1.setPreferredSize(new Dimension(10, 30));\r
 547       idSpaceFillerPanel1.setLayout(borderLayout11);\r
 548       annotationSpaceFillerHolder.setBackground(Color.white);\r
 549 \r
 550       //  annotationSpaceFillerHolder.setPreferredSize(new Dimension(10, 80));\r
 551       annotationSpaceFillerHolder.setLayout(borderLayout4);\r
 552       hscroll.setOrientation(Scrollbar.HORIZONTAL);\r
 553       hscrollHolder.setLayout(borderLayout10);\r
 554       hscrollFillerPanel.setBackground(Color.white);\r
 555 \r
 556       //  hscrollFillerPanel.setPreferredSize(new Dimension(70, 10));\r
 557       hscrollHolder.setBackground(Color.white);\r
 558 \r
 559       //    annotationScroller.setPreferredSize(new Dimension(10, 80));\r
 560       //  this.setPreferredSize(new Dimension(220, 166));\r
 561       seqPanelHolder.setBackground(Color.white);\r
 562       idPanelHolder.setBackground(Color.white);\r
 563       annotationScroller.setLayout(borderLayout2);\r
 564       sequenceHolderPanel.add(scalePanelHolder, BorderLayout.NORTH);\r
 565       sequenceHolderPanel.add(seqPanelHolder, BorderLayout.CENTER);\r
 566       seqPanelHolder.add(vscroll, BorderLayout.EAST);\r
 567       sequenceHolderPanel.add(annotationScroller, BorderLayout.SOUTH);\r
 568 \r
 569       //  Panel3.add(secondaryPanelHolder,  BorderLayout.SOUTH);\r
 570       this.add(idPanelHolder, BorderLayout.WEST);\r
 571       idPanelHolder.add(idSpaceFillerPanel1, BorderLayout.NORTH);\r
 572       idPanelHolder.add(annotationSpaceFillerHolder, BorderLayout.SOUTH);\r
 573       this.add(hscrollHolder, BorderLayout.SOUTH);\r
 574       hscrollHolder.add(hscroll, BorderLayout.CENTER);\r
 575       hscrollHolder.add(hscrollFillerPanel, BorderLayout.WEST);\r
 576       this.add(sequenceHolderPanel, BorderLayout.CENTER);\r
 577   }\r
 578 \r
 579 }\r