src/jalview/appletgui/AlignmentPanel.java

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