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