src/jalview/appletgui/AlignmentPanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.appletgui;
  22
  23 import jalview.analysis.AnnotationSorter;
  24 import jalview.api.AlignViewportI;
  25 import jalview.api.AlignmentViewPanel;
  26 import jalview.bin.JalviewLite;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.SearchResultsI;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.structure.StructureSelectionManager;
  31 import jalview.viewmodel.ViewportListenerI;
  32 import jalview.viewmodel.ViewportRanges;
  33
  34 import java.awt.BorderLayout;
  35 import java.awt.Color;
  36 import java.awt.Dimension;
  37 import java.awt.FontMetrics;
  38 import java.awt.Frame;
  39 import java.awt.Graphics;
  40 import java.awt.Panel;
  41 import java.awt.Scrollbar;
  42 import java.awt.event.AdjustmentEvent;
  43 import java.awt.event.AdjustmentListener;
  44 import java.awt.event.ComponentAdapter;
  45 import java.awt.event.ComponentEvent;
  46 import java.beans.PropertyChangeEvent;
  47 import java.util.List;
  48
  49 public class AlignmentPanel extends Panel implements AdjustmentListener,
  50         AlignmentViewPanel, ViewportListenerI
  51 {
  52
  53   public AlignViewport av;
  54
  55   OverviewPanel overviewPanel;
  56
  57   SeqPanel seqPanel;
  58
  59   IdPanel idPanel;
  60
  61   IdwidthAdjuster idwidthAdjuster;
  62
  63   public AlignFrame alignFrame;
  64
  65   ScalePanel scalePanel;
  66
  67   AnnotationPanel annotationPanel;
  68
  69   AnnotationLabels alabels;
  70
  71   ViewportRanges vpRanges;
  72
  73   // this value is set false when selection area being dragged
  74   boolean fastPaint = true;
  75
  76   @Override
  77   public void finalize() throws Throwable
  78   {
  79     alignFrame = null;
  80     av = null;
  81     vpRanges = null;
  82     seqPanel = null;
  83     seqPanelHolder = null;
  84     sequenceHolderPanel = null;
  85     scalePanel = null;
  86     scalePanelHolder = null;
  87     annotationPanel = null;
  88     annotationPanelHolder = null;
  89     annotationSpaceFillerHolder = null;
  90     super.finalize();
  91   }
  92
  93   public AlignmentPanel(AlignFrame af, final AlignViewport av)
  94   {
  95     try
  96     {
  97       jbInit();
  98     } catch (Exception e)
  99     {
 100       e.printStackTrace();
 101     }
 102
 103     alignFrame = af;
 104     this.av = av;
 105     vpRanges = av.getRanges();
 106     seqPanel = new SeqPanel(av, this);
 107     idPanel = new IdPanel(av, this);
 108     scalePanel = new ScalePanel(av, this);
 109     idwidthAdjuster = new IdwidthAdjuster(this);
 110     annotationPanel = new AnnotationPanel(this);
 111     annotationPanelHolder.add(annotationPanel, BorderLayout.CENTER);
 112
 113     sequenceHolderPanel.add(annotationPanelHolder, BorderLayout.SOUTH);
 114     alabels = new AnnotationLabels(this);
 115
 116     setAnnotationVisible(av.isShowAnnotation());
 117
 118     idPanelHolder.add(idPanel, BorderLayout.CENTER);
 119     idSpaceFillerPanel1.add(idwidthAdjuster, BorderLayout.CENTER);
 120     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);
 121     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);
 122     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);
 123
 124     fontChanged();
 125     setScrollValues(0, 0);
 126
 127     apvscroll.addAdjustmentListener(this);
 128     hscroll.addAdjustmentListener(this);
 129     vscroll.addAdjustmentListener(this);
 130
 131     addComponentListener(new ComponentAdapter()
 132     {
 133       @Override
 134       public void componentResized(ComponentEvent evt)
 135       {
 136         // reset the viewport ranges when the alignment panel is resized
 137         // in particular, this initialises the end residue value when Jalview
 138         // is initialised
 139         if (av.getWrapAlignment())
 140         {
 141           int widthInRes = seqPanel.seqCanvas
 142                   .getWrappedCanvasWidth(seqPanel.seqCanvas.getWidth());
 143           vpRanges.setViewportWidth(widthInRes);
 144         }
 145         else
 146         {
 147           int widthInRes = seqPanel.seqCanvas.getWidth()
 148                   / av.getCharWidth();
 149           int heightInSeq = seqPanel.seqCanvas.getHeight()
 150                   / av.getCharHeight();
 151
 152           vpRanges.setViewportWidth(widthInRes);
 153           vpRanges.setViewportHeight(heightInSeq);
 154         }
 155         // setScrollValues(vpRanges.getStartRes(), vpRanges.getStartSeq());
 156         if (getSize().height > 0
 157                 && annotationPanelHolder.getSize().height > 0)
 158         {
 159           validateAnnotationDimensions(false);
 160         }
 161         repaint();
 162       }
 163
 164     });
 165
 166     Dimension d = calculateIdWidth();
 167     idPanel.idCanvas.setSize(d);
 168
 169     hscrollFillerPanel.setSize(d.width, annotationPanel.getSize().height);
 170
 171     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);
 172     annotationSpaceFillerHolder.setSize(d.width,
 173             annotationPanel.getSize().height);
 174     alabels.setSize(d.width, annotationPanel.getSize().height);
 175     final AlignmentPanel ap = this;
 176     av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
 177     {
 178       @Override
 179       public void propertyChange(java.beans.PropertyChangeEvent evt)
 180       {
 181         if (evt.getPropertyName().equals("alignment"))
 182         {
 183           PaintRefresher.Refresh(ap, av.getSequenceSetId(), true, true);
 184           alignmentChanged();
 185         }
 186       }
 187     });
 188     av.getRanges().addPropertyChangeListener(this);
 189   }
 190
 191   @Override
 192   public AlignViewportI getAlignViewport()
 193   {
 194     return av;
 195   }
 196
 197   public SequenceRenderer getSequenceRenderer()
 198   {
 199     return seqPanel.seqCanvas.sr;
 200   }
 201
 202   @Override
 203   public jalview.api.FeatureRenderer getFeatureRenderer()
 204   {
 205     return seqPanel.seqCanvas.fr;
 206   }
 207
 208   @Override
 209   public jalview.api.FeatureRenderer cloneFeatureRenderer()
 210   {
 211     FeatureRenderer nfr = new FeatureRenderer(av);
 212     nfr.transferSettings(seqPanel.seqCanvas.fr);
 213     return nfr;
 214   }
 215
 216   public void alignmentChanged()
 217   {
 218     av.alignmentChanged(this);
 219
 220     if (overviewPanel != null)
 221     {
 222       overviewPanel.updateOverviewImage();
 223     }
 224
 225     alignFrame.updateEditMenuBar();
 226
 227     repaint();
 228   }
 229
 230   public void fontChanged()
 231   {
 232     // set idCanvas bufferedImage to null
 233     // to prevent drawing old image
 234     idPanel.idCanvas.image = null;
 235     FontMetrics fm = getFontMetrics(av.getFont());
 236
 237     scalePanel.setSize(new Dimension(10, av.getCharHeight()
 238             + fm.getDescent()));
 239     idwidthAdjuster.setSize(new Dimension(10, av.getCharHeight()
 240             + fm.getDescent()));
 241     av.updateSequenceIdColours();
 242     annotationPanel.image = null;
 243     int ap = annotationPanel.adjustPanelHeight(false);
 244     Dimension d = calculateIdWidth();
 245     d.setSize(d.width + 4, seqPanel.seqCanvas.getSize().height);
 246     alabels.setSize(d.width + 4, ap);
 247
 248     idPanel.idCanvas.setSize(d);
 249     hscrollFillerPanel.setSize(d);
 250
 251     validateAnnotationDimensions(false);
 252     annotationPanel.repaint();
 253     validate();
 254     repaint();
 255   }
 256
 257   public void setIdWidth(int w, int h)
 258   {
 259     idPanel.idCanvas.setSize(w, h);
 260     idPanelHolder.setSize(w, idPanelHolder.getSize().height);
 261     annotationSpaceFillerHolder.setSize(w,
 262             annotationSpaceFillerHolder.getSize().height);
 263     alabels.setSize(w, alabels.getSize().height);
 264     validate();
 265   }
 266
 267   Dimension calculateIdWidth()
 268   {
 269     if (av.nullFrame == null)
 270     {
 271       av.nullFrame = new Frame();
 272       av.nullFrame.addNotify();
 273     }
 274
 275     Graphics g = av.nullFrame.getGraphics();
 276
 277     FontMetrics fm = g.getFontMetrics(av.font);
 278     AlignmentI al = av.getAlignment();
 279
 280     int i = 0;
 281     int idWidth = 0;
 282     String id;
 283     while (i < al.getHeight() && al.getSequenceAt(i) != null)
 284     {
 285       SequenceI s = al.getSequenceAt(i);
 286       id = s.getDisplayId(av.getShowJVSuffix());
 287
 288       if (fm.stringWidth(id) > idWidth)
 289       {
 290         idWidth = fm.stringWidth(id);
 291       }
 292       i++;
 293     }
 294
 295     // Also check annotation label widths
 296     i = 0;
 297     if (al.getAlignmentAnnotation() != null)
 298     {
 299       fm = g.getFontMetrics(av.nullFrame.getFont());
 300       while (i < al.getAlignmentAnnotation().length)
 301       {
 302         String label = al.getAlignmentAnnotation()[i].label;
 303         if (fm.stringWidth(label) > idWidth)
 304         {
 305           idWidth = fm.stringWidth(label);
 306         }
 307         i++;
 308       }
 309     }
 310
 311     return new Dimension(idWidth, idPanel.idCanvas.getSize().height);
 312   }
 313
 314   /**
 315    * Highlight the given results on the alignment.
 316    *
 317    */
 318   public void highlightSearchResults(SearchResultsI results)
 319   {
 320     scrollToPosition(results);
 321     seqPanel.seqCanvas.highlightSearchResults(results);
 322   }
 323
 324   /**
 325    * scroll the view to show the position of the highlighted region in results
 326    * (if any) and redraw the overview
 327    *
 328    * @param results
 329    * @return false if results were not found
 330    */
 331   public boolean scrollToPosition(SearchResultsI results)
 332   {
 333     return scrollToPosition(results, true);
 334   }
 335
 336   /**
 337    * scroll the view to show the position of the highlighted region in results
 338    * (if any)
 339    *
 340    * @param results
 341    * @param redrawOverview
 342    *          - when set, the overview will be recalculated (takes longer)
 343    * @return false if results were not found
 344    */
 345   public boolean scrollToPosition(SearchResultsI results,
 346           boolean redrawOverview)
 347   {
 348     return scrollToPosition(results, 0, redrawOverview, false);
 349   }
 350
 351   /**
 352    * scroll the view to show the position of the highlighted region in results
 353    * (if any)
 354    *
 355    * @param results
 356    * @param redrawOverview
 357    *          - when set, the overview will be recalculated (takes longer)
 358    * @return false if results were not found
 359    */
 360   public boolean scrollToPosition(SearchResultsI results,
 361           int verticalOffset,
 362           boolean redrawOverview, boolean centre)
 363   {
 364     // do we need to scroll the panel?
 365     if (results != null && results.getSize() > 0)
 366     {
 367       AlignmentI alignment = av.getAlignment();
 368       int seqIndex = alignment.findIndex(results);
 369       if (seqIndex == -1)
 370       {
 371         return false;
 372       }
 373       /*
 374        * allow for offset of target sequence (actually scroll to one above it)
 375        */
 376
 377       SequenceI seq = alignment.getSequenceAt(seqIndex);
 378       int[] r = results.getResults(seq, 0, alignment.getWidth());
 379       if (r == null)
 380       {
 381         if (JalviewLite.debug)
 382         {// DEBUG
 383           System.out
 384                   .println("DEBUG: scroll didn't happen - results not within alignment : "
 385                           + seq.getStart() + "," + seq.getEnd());
 386         }
 387         return false;
 388       }
 389       if (JalviewLite.debug)
 390       {
 391         // DEBUG
 392         /*
 393          * System.out.println("DEBUG: scroll: start=" + r[0] +
 394          * " av.getStartRes()=" + av.getStartRes() + " end=" + r[1] +
 395          * " seq.end=" + seq.getEnd() + " av.getEndRes()=" + av.getEndRes() +
 396          * " hextent=" + hextent);
 397          */
 398       }
 399       int start = r[0];
 400       int end = r[1];
 401
 402       /*
 403        * To centre results, scroll to positions half the visible width
 404        * left/right of the start/end positions
 405        */
 406       if (centre)
 407       {
 408         int offset = (vpRanges.getEndRes() - vpRanges.getStartRes() + 1) / 2 - 1;
 409         start = Math.max(start - offset, 0);
 410         end = end + offset - 1;
 411         // end = Math.min(end + offset, seq.getEnd() - 1);
 412       }
 413
 414       if (start < 0)
 415       {
 416         return false;
 417       }
 418       if (end == seq.getEnd())
 419       {
 420         return false;
 421       }
 422
 423       /*
 424        * allow for offset of target sequence (actually scroll to one above it)
 425        */
 426       seqIndex = Math.max(0, seqIndex - verticalOffset);
 427       return scrollTo(start, end, seqIndex, false, redrawOverview);
 428     }
 429     return true;
 430   }
 431
 432   public boolean scrollTo(int ostart, int end, int seqIndex,
 433           boolean scrollToNearest, boolean redrawOverview)
 434   {
 435     int startv, endv, starts, ends, width;
 436
 437     int start = -1;
 438     if (av.hasHiddenColumns())
 439     {
 440       AlignmentI al = av.getAlignment();
 441       start = al.getHiddenColumns().findColumnPosition(ostart);
 442       end = al.getHiddenColumns().findColumnPosition(end);
 443       if (start == end)
 444       {
 445         if (!scrollToNearest && !al.getHiddenColumns().isVisible(ostart))
 446         {
 447           // don't scroll - position isn't visible
 448           return false;
 449         }
 450       }
 451     }
 452     else
 453     {
 454       start = ostart;
 455     }
 456
 457     if (!av.getWrapAlignment())
 458     {
 459       /*
 460        * int spos=av.getStartRes(),sqpos=av.getStartSeq(); if ((startv =
 461        * av.getStartRes()) >= start) { spos=start-1; // seqIn //
 462        * setScrollValues(start - 1, seqIndex); } else if ((endv =
 463        * av.getEndRes()) <= end) { // setScrollValues(spos=startv + 1 + end -
 464        * endv, seqIndex); spos=startv + 1 + end - endv; } else if ((starts =
 465        * av.getStartSeq()) > seqIndex) { setScrollValues(av.getStartRes(),
 466        * seqIndex); } else if ((ends = av.getEndSeq()) <= seqIndex) {
 467        * setScrollValues(av.getStartRes(), starts + seqIndex - ends + 1); }
 468        */
 469
 470       // below is scrolling logic up to Jalview 2.8.2
 471       // if ((av.getStartRes() > end)
 472       // || (av.getEndRes() < start)
 473       // || ((av.getStartSeq() > seqIndex) || (av.getEndSeq() < seqIndex)))
 474       // {
 475       // if (start > av.getAlignment().getWidth() - hextent)
 476       // {
 477       // start = av.getAlignment().getWidth() - hextent;
 478       // if (start < 0)
 479       // {
 480       // start = 0;
 481       // }
 482       //
 483       // }
 484       // if (seqIndex > av.getAlignment().getHeight() - vextent)
 485       // {
 486       // seqIndex = av.getAlignment().getHeight() - vextent;
 487       // if (seqIndex < 0)
 488       // {
 489       // seqIndex = 0;
 490       // }
 491       // }
 492       // setScrollValues(start, seqIndex);
 493       // }
 494       // logic copied from jalview.gui.AlignmentPanel:
 495       if ((startv = vpRanges.getStartRes()) >= start)
 496       {
 497         /*
 498          * Scroll left to make start of search results visible
 499          */
 500         setScrollValues(start - 1, seqIndex);
 501       }
 502       else if ((endv = vpRanges.getEndRes()) <= end)
 503       {
 504         /*
 505          * Scroll right to make end of search results visible
 506          */
 507         setScrollValues(startv + 1 + end - endv, seqIndex);
 508       }
 509       else if ((starts = vpRanges.getStartSeq()) > seqIndex)
 510       {
 511         /*
 512          * Scroll up to make start of search results visible
 513          */
 514         setScrollValues(vpRanges.getStartRes(), seqIndex);
 515       }
 516       else if ((ends = vpRanges.getEndSeq()) <= seqIndex)
 517       {
 518         /*
 519          * Scroll down to make end of search results visible
 520          */
 521         setScrollValues(vpRanges.getStartRes(), starts + seqIndex - ends
 522                 + 1);
 523       }
 524       /*
 525        * Else results are already visible - no need to scroll
 526        */
 527     }
 528     else
 529     {
 530       vpRanges.scrollToWrappedVisible(start);
 531     }
 532
 533     paintAlignment(redrawOverview);
 534     return true;
 535   }
 536
 537   public OverviewPanel getOverviewPanel()
 538   {
 539     return overviewPanel;
 540   }
 541
 542   public void setOverviewPanel(OverviewPanel op)
 543   {
 544     overviewPanel = op;
 545   }
 546
 547   public void setAnnotationVisible(boolean b)
 548   {
 549     if (!av.getWrapAlignment())
 550     {
 551       annotationSpaceFillerHolder.setVisible(b);
 552       annotationPanelHolder.setVisible(b);
 553     }
 554     else
 555     {
 556       annotationSpaceFillerHolder.setVisible(false);
 557       annotationPanelHolder.setVisible(false);
 558     }
 559     validate();
 560     repaint();
 561   }
 562
 563   /**
 564    * automatically adjust annotation panel height for new annotation whilst
 565    * ensuring the alignment is still visible.
 566    */
 567   @Override
 568   public void adjustAnnotationHeight()
 569   {
 570     // TODO: display vertical annotation scrollbar if necessary
 571     // this is called after loading new annotation onto alignment
 572     if (alignFrame.getSize().height == 0)
 573     {
 574       System.out
 575               .println("adjustAnnotationHeight frame size zero NEEDS FIXING");
 576     }
 577     fontChanged();
 578     validateAnnotationDimensions(true);
 579     apvscroll.addNotify();
 580     hscroll.addNotify();
 581     validate();
 582     paintAlignment(true);
 583   }
 584
 585   /**
 586    * Calculate the annotation dimensions and refresh slider values accordingly.
 587    * Need to do repaints/notifys afterwards.
 588    */
 589   protected void validateAnnotationDimensions(boolean adjustPanelHeight)
 590   {
 591     int rowHeight = av.getCharHeight();
 592     int alignmentHeight = rowHeight * av.getAlignment().getHeight();
 593     int annotationHeight = av.calcPanelHeight();
 594
 595     int mheight = annotationHeight;
 596     Dimension d = sequenceHolderPanel.getSize();
 597
 598     int availableHeight = d.height - scalePanelHolder.getHeight();
 599
 600     if (adjustPanelHeight)
 601     {
 602       /*
 603        * If not enough vertical space, maximize annotation height while keeping
 604        * at least two rows of alignment visible
 605        */
 606       if (annotationHeight + alignmentHeight > availableHeight)
 607       {
 608         annotationHeight = Math.min(annotationHeight, availableHeight - 2
 609                 * rowHeight);
 610       }
 611     }
 612     else
 613     {
 614       // maintain same window layout whilst updating sliders
 615       annotationHeight = annotationPanelHolder.getSize().height;
 616     }
 617
 618     if (availableHeight - annotationHeight < 5)
 619     {
 620       annotationHeight = availableHeight;
 621     }
 622
 623     annotationPanel.setSize(new Dimension(d.width, annotationHeight));
 624     annotationPanelHolder.setSize(new Dimension(d.width, annotationHeight));
 625     // seqPanelHolder.setSize(d.width, seqandannot - height);
 626     seqPanel.seqCanvas
 627             .setSize(d.width, seqPanel.seqCanvas.getSize().height);
 628
 629     Dimension e = idPanel.getSize();
 630     alabels.setSize(new Dimension(e.width, annotationHeight));
 631     annotationSpaceFillerHolder.setSize(new Dimension(e.width,
 632             annotationHeight));
 633
 634     int s = apvscroll.getValue();
 635     if (s > mheight - annotationHeight)
 636     {
 637       s = 0;
 638     }
 639     apvscroll.setValues(s, annotationHeight, 0, mheight);
 640     annotationPanel.setScrollOffset(apvscroll.getValue(), false);
 641     alabels.setScrollOffset(apvscroll.getValue(), false);
 642   }
 643
 644   public void setWrapAlignment(boolean wrap)
 645   {
 646     vpRanges.setStartSeq(0);
 647     vpRanges.setStartRes(0);
 648     scalePanelHolder.setVisible(!wrap);
 649
 650     hscroll.setVisible(!wrap);
 651     idwidthAdjuster.setVisible(!wrap);
 652
 653     if (wrap)
 654     {
 655       annotationPanelHolder.setVisible(false);
 656       annotationSpaceFillerHolder.setVisible(false);
 657     }
 658     else if (av.isShowAnnotation())
 659     {
 660       annotationPanelHolder.setVisible(true);
 661       annotationSpaceFillerHolder.setVisible(true);
 662     }
 663
 664     idSpaceFillerPanel1.setVisible(!wrap);
 665
 666     fontChanged(); // This is so that the scalePanel is resized correctly
 667
 668     validate();
 669     sequenceHolderPanel.validate();
 670     repaint();
 671
 672   }
 673
 674   int hextent = 0;
 675
 676   int vextent = 0;
 677
 678   public void setScrollValues(int xpos, int ypos)
 679   {
 680     int x = xpos;
 681     int y = ypos;
 682
 683     if (av.getWrapAlignment())
 684     {
 685       setScrollingForWrappedPanel(x);
 686     }
 687     else
 688     {
 689       int width = av.getAlignment().getWidth();
 690       int height = av.getAlignment().getHeight();
 691
 692       if (av.hasHiddenColumns())
 693       {
 694         width = av.getAlignment().getHiddenColumns()
 695                 .findColumnPosition(width);
 696       }
 697       if (x < 0)
 698       {
 699         x = 0;
 700       }
 701
 702       hextent = seqPanel.seqCanvas.getSize().width / av.getCharWidth();
 703       vextent = seqPanel.seqCanvas.getSize().height / av.getCharHeight();
 704
 705       if (hextent > width)
 706       {
 707         hextent = width;
 708       }
 709
 710       if (vextent > height)
 711       {
 712         vextent = height;
 713       }
 714
 715       if ((hextent + x) > width)
 716       {
 717         System.err.println("hextent was " + hextent + " and x was " + x);
 718
 719         x = width - hextent;
 720       }
 721
 722       if ((vextent + y) > height)
 723       {
 724         y = height - vextent;
 725       }
 726
 727       if (y < 0)
 728       {
 729         y = 0;
 730       }
 731
 732       if (x < 0)
 733       {
 734         System.err.println("x was " + x);
 735         x = 0;
 736       }
 737
 738       hscroll.setValues(x, hextent, 0, width);
 739       vscroll.setValues(y, vextent, 0, height);
 740
 741       // AWT scrollbar does not fire adjustmentValueChanged for setValues
 742       // so also call adjustment code!
 743       adjustHorizontal(x);
 744       adjustVertical(y);
 745
 746       sendViewPosition();
 747     }
 748   }
 749
 750   /**
 751    * Respond to adjustment event when horizontal or vertical scrollbar is
 752    * changed
 753    *
 754    * @param evt
 755    *          adjustment event encoding whether apvscroll, hscroll or vscroll
 756    *          changed
 757    */
 758   @Override
 759   public void adjustmentValueChanged(AdjustmentEvent evt)
 760   {
 761     // Note that this event is NOT fired by the AWT scrollbar when setValues is
 762     // called. Instead manually call adjustHorizontal and adjustVertical
 763     // directly.
 764     if (evt == null || evt.getSource() == apvscroll)
 765     {
 766       annotationPanel.setScrollOffset(apvscroll.getValue(), false);
 767       alabels.setScrollOffset(apvscroll.getValue(), false);
 768     }
 769     if (evt == null || evt.getSource() == hscroll)
 770     {
 771       int x = hscroll.getValue();
 772       adjustHorizontal(x);
 773     }
 774
 775     if (evt == null || evt.getSource() == vscroll)
 776     {
 777       int offy = vscroll.getValue();
 778       adjustVertical(offy);
 779     }
 780
 781   }
 782
 783   private void adjustHorizontal(int x)
 784   {
 785     int oldX = vpRanges.getStartRes();
 786     int oldwidth = vpRanges.getViewportWidth();
 787     int width = seqPanel.seqCanvas.getWidth() / av.getCharWidth();
 788
 789     // if we're scrolling to the position we're already at, stop
 790     // this prevents infinite recursion of events when the scroll/viewport
 791     // ranges values are the same
 792     if ((x == oldX) && (width == oldwidth))
 793     {
 794       return;
 795     }
 796     vpRanges.setViewportStartAndWidth(x, width);
 797
 798     if (av.getWrapAlignment() || !fastPaint)
 799     {
 800       repaint();
 801     }
 802     sendViewPosition();
 803   }
 804
 805   private void adjustVertical(int newY)
 806   {
 807     if (av.getWrapAlignment())
 808     {
 809       /*
 810        * if we're scrolling to the position we're already at, stop
 811        * this prevents infinite recursion of events when the scroll/viewport
 812        * ranges values are the same
 813        */
 814       int oldX = vpRanges.getStartRes();
 815       int oldY = vpRanges.getWrappedScrollPosition(oldX);
 816       if (oldY == newY)
 817       {
 818         return;
 819       }
 820       else if (newY > -1)
 821       {
 822         /*
 823          * limit page up/down to one width's worth of positions
 824          */
 825         int rowSize = vpRanges.getViewportWidth();
 826         int newX = newY > oldY ? oldX + rowSize : oldX - rowSize;
 827         vpRanges.setViewportStartAndWidth(newX, rowSize);
 828       }
 829     }
 830     else
 831     {
 832       int height = seqPanel.seqCanvas.getHeight() / av.getCharHeight();
 833       int oldY = vpRanges.getStartSeq();
 834       int oldheight = vpRanges.getViewportHeight();
 835
 836       // if we're scrolling to the position we're already at, stop
 837       // this prevents infinite recursion of events when the scroll/viewport
 838       // ranges values are the same
 839       if ((newY == oldY) && (height == oldheight))
 840       {
 841         return;
 842       }
 843       vpRanges.setViewportStartAndHeight(newY, height);
 844     }
 845     if (av.getWrapAlignment() || !fastPaint)
 846     {
 847       repaint();
 848     }
 849     sendViewPosition();
 850   }
 851
 852   /**
 853    * A helper method to return the AlignmentPanel in the other (complementary)
 854    * half of a SplitFrame view. Returns null if not in a SplitFrame.
 855    *
 856    * @return
 857    */
 858   private AlignmentPanel getComplementPanel()
 859   {
 860     AlignmentPanel ap = null;
 861     if (alignFrame != null)
 862     {
 863       SplitFrame sf = alignFrame.getSplitFrame();
 864       if (sf != null)
 865       {
 866         AlignFrame other = sf.getComplement(alignFrame);
 867         if (other != null)
 868         {
 869           ap = other.alignPanel;
 870         }
 871       }
 872     }
 873     return ap;
 874   }
 875
 876   /**
 877    * Follow a scrolling change in the (cDNA/Protein) complementary alignment.
 878    * The aim is to keep the two alignments 'lined up' on their centre columns.
 879    *
 880    * @param sr
 881    *          holds mapped region(s) of this alignment that we are scrolling
 882    *          'to'; may be modified for sequence offset by this method
 883    * @param seqOffset
 884    *          the number of visible sequences to show above the mapped region
 885    */
 886   protected void scrollToCentre(SearchResultsI sr, int seqOffset)
 887   {
 888     /*
 889      * To avoid jumpy vertical scrolling (if some sequences are gapped or not
 890      * mapped), we can make the scroll-to location a sequence above the one
 891      * actually mapped.
 892      */
 893     SequenceI mappedTo = sr.getResults().get(0).getSequence();
 894     List<SequenceI> seqs = av.getAlignment().getSequences();
 895
 896     /*
 897      * This is like AlignmentI.findIndex(seq) but here we are matching the
 898      * dataset sequence not the aligned sequence
 899      */
 900     boolean matched = false;
 901     for (SequenceI seq : seqs)
 902     {
 903       if (mappedTo == seq.getDatasetSequence())
 904       {
 905         matched = true;
 906         break;
 907       }
 908     }
 909     if (!matched)
 910     {
 911       return; // failsafe, shouldn't happen
 912     }
 913
 914     /*
 915      * Scroll to position but centring the target residue. Also set a state flag
 916      * to prevent adjustmentValueChanged performing this recursively.
 917      */
 918     scrollToPosition(sr, seqOffset, true, true);
 919   }
 920
 921   private void sendViewPosition()
 922   {
 923     StructureSelectionManager.getStructureSelectionManager(av.applet)
 924             .sendViewPosition(this, vpRanges.getStartRes(),
 925                     vpRanges.getEndRes(), vpRanges.getStartSeq(),
 926                     vpRanges.getEndSeq());
 927   }
 928
 929   /**
 930    * Repaint the alignment and annotations, and, optionally, any overview window
 931    */
 932   @Override
 933   public void paintAlignment(boolean updateOverview)
 934   {
 935     final AnnotationSorter sorter = new AnnotationSorter(getAlignment(),
 936             av.isShowAutocalculatedAbove());
 937     sorter.sort(getAlignment().getAlignmentAnnotation(),
 938             av.getSortAnnotationsBy());
 939     repaint();
 940
 941     if (updateOverview)
 942     {
 943       // TODO: determine if this paintAlignment changed structure colours
 944       jalview.structure.StructureSelectionManager
 945               .getStructureSelectionManager(av.applet)
 946               .sequenceColoursChanged(this);
 947
 948       if (overviewPanel != null)
 949       {
 950         overviewPanel.updateOverviewImage();
 951       }
 952     }
 953   }
 954
 955   @Override
 956   public void update(Graphics g)
 957   {
 958     paint(g);
 959   }
 960
 961   @Override
 962   public void paint(Graphics g)
 963   {
 964     invalidate();
 965     Dimension d = idPanel.idCanvas.getSize();
 966     final int canvasHeight = seqPanel.seqCanvas.getSize().height;
 967     if (canvasHeight != d.height)
 968     {
 969       idPanel.idCanvas.setSize(d.width, canvasHeight);
 970     }
 971
 972     setScrollValues(vpRanges.getStartRes(), vpRanges.getStartSeq());
 973
 974     seqPanel.seqCanvas.repaint();
 975     idPanel.idCanvas.repaint();
 976     if (!av.getWrapAlignment())
 977     {
 978       if (av.isShowAnnotation())
 979       {
 980         alabels.repaint();
 981         annotationPanel.repaint();
 982       }
 983       scalePanel.repaint();
 984     }
 985
 986   }
 987
 988   /**
 989    * Set vertical scroll bar parameters for wrapped panel
 990    *
 991    * @param topLeftColumn
 992    *          the column position at top left (0..)
 993    */
 994   private void setScrollingForWrappedPanel(int topLeftColumn)
 995   {
 996     int scrollPosition = vpRanges.getWrappedScrollPosition(topLeftColumn);
 997     int maxScroll = vpRanges.getWrappedMaxScroll(topLeftColumn);
 998
 999     /*
1000      * a scrollbar's value can be set to at most (maximum-extent)
1001      * so we add extent (1) to the maxScroll value
1002      */
1003     vscroll.setUnitIncrement(1);
1004     vscroll.setValues(scrollPosition, 1, 0, maxScroll + 1);
1005   }
1006
1007   protected Panel sequenceHolderPanel = new Panel();
1008
1009   protected Scrollbar vscroll = new Scrollbar();
1010
1011   protected Scrollbar hscroll = new Scrollbar();
1012
1013   protected Panel seqPanelHolder = new Panel();
1014
1015   protected Panel scalePanelHolder = new Panel();
1016
1017   protected Panel idPanelHolder = new Panel();
1018
1019   protected Panel idSpaceFillerPanel1 = new Panel();
1020
1021   public Panel annotationSpaceFillerHolder = new Panel();
1022
1023   protected Panel hscrollFillerPanel = new Panel();
1024
1025   Panel annotationPanelHolder = new Panel();
1026
1027   protected Scrollbar apvscroll = new Scrollbar();
1028
1029   /*
1030    * Flag set while scrolling to follow complementary cDNA/protein scroll. When
1031    * false, suppresses invoking the same method recursively.
1032    */
1033   private boolean scrollComplementaryPanel = true;
1034
1035   private void jbInit() throws Exception
1036   {
1037     // idPanelHolder.setPreferredSize(new Dimension(70, 10));
1038     this.setLayout(new BorderLayout());
1039
1040     // sequenceHolderPanel.setPreferredSize(new Dimension(150, 150));
1041     sequenceHolderPanel.setLayout(new BorderLayout());
1042     seqPanelHolder.setLayout(new BorderLayout());
1043     scalePanelHolder.setBackground(Color.white);
1044
1045     // scalePanelHolder.setPreferredSize(new Dimension(10, 30));
1046     scalePanelHolder.setLayout(new BorderLayout());
1047     idPanelHolder.setLayout(new BorderLayout());
1048     idSpaceFillerPanel1.setBackground(Color.white);
1049
1050     // idSpaceFillerPanel1.setPreferredSize(new Dimension(10, 30));
1051     idSpaceFillerPanel1.setLayout(new BorderLayout());
1052     annotationSpaceFillerHolder.setBackground(Color.white);
1053
1054     // annotationSpaceFillerHolder.setPreferredSize(new Dimension(10, 80));
1055     annotationSpaceFillerHolder.setLayout(new BorderLayout());
1056     hscroll.setOrientation(Scrollbar.HORIZONTAL);
1057
1058     Panel hscrollHolder = new Panel();
1059     hscrollHolder.setLayout(new BorderLayout());
1060     hscrollFillerPanel.setBackground(Color.white);
1061     apvscroll.setOrientation(Scrollbar.VERTICAL);
1062     apvscroll.setVisible(true);
1063     apvscroll.addAdjustmentListener(this);
1064
1065     annotationPanelHolder.setBackground(Color.white);
1066     annotationPanelHolder.setLayout(new BorderLayout());
1067     annotationPanelHolder.add(apvscroll, BorderLayout.EAST);
1068     // hscrollFillerPanel.setPreferredSize(new Dimension(70, 10));
1069     hscrollHolder.setBackground(Color.white);
1070
1071     // annotationScroller.setPreferredSize(new Dimension(10, 80));
1072     // this.setPreferredSize(new Dimension(220, 166));
1073     seqPanelHolder.setBackground(Color.white);
1074     idPanelHolder.setBackground(Color.white);
1075     sequenceHolderPanel.add(scalePanelHolder, BorderLayout.NORTH);
1076     sequenceHolderPanel.add(seqPanelHolder, BorderLayout.CENTER);
1077     seqPanelHolder.add(vscroll, BorderLayout.EAST);
1078
1079     // Panel3.add(secondaryPanelHolder, BorderLayout.SOUTH);
1080     this.add(idPanelHolder, BorderLayout.WEST);
1081     idPanelHolder.add(idSpaceFillerPanel1, BorderLayout.NORTH);
1082     idPanelHolder.add(annotationSpaceFillerHolder, BorderLayout.SOUTH);
1083     this.add(hscrollHolder, BorderLayout.SOUTH);
1084     hscrollHolder.add(hscroll, BorderLayout.CENTER);
1085     hscrollHolder.add(hscrollFillerPanel, BorderLayout.WEST);
1086     this.add(sequenceHolderPanel, BorderLayout.CENTER);
1087   }
1088
1089   /**
1090    * hides or shows dynamic annotation rows based on groups and av state flags
1091    */
1092   public void updateAnnotation()
1093   {
1094     updateAnnotation(false);
1095   }
1096
1097   public void updateAnnotation(boolean applyGlobalSettings)
1098   {
1099     updateAnnotation(applyGlobalSettings, false);
1100   }
1101
1102   public void updateAnnotation(boolean applyGlobalSettings,
1103           boolean preserveNewGroupSettings)
1104   {
1105     av.updateGroupAnnotationSettings(applyGlobalSettings,
1106             preserveNewGroupSettings);
1107     adjustAnnotationHeight();
1108   }
1109
1110   @Override
1111   public AlignmentI getAlignment()
1112   {
1113     return av.getAlignment();
1114   }
1115
1116   @Override
1117   public String getViewName()
1118   {
1119     return getName();
1120   }
1121
1122   @Override
1123   public StructureSelectionManager getStructureSelectionManager()
1124   {
1125     return StructureSelectionManager
1126             .getStructureSelectionManager(av.applet);
1127   }
1128
1129   @Override
1130   public void raiseOOMWarning(String string, OutOfMemoryError error)
1131   {
1132     // TODO: JAL-960
1133     System.err.println("Out of memory whilst '" + string + "'");
1134     error.printStackTrace();
1135   }
1136
1137   /**
1138    * Set a flag to say we are scrolling to follow a (cDNA/protein) complement.
1139    *
1140    * @param b
1141    */
1142   protected void setToScrollComplementPanel(boolean b)
1143   {
1144     this.scrollComplementaryPanel = b;
1145   }
1146
1147   /**
1148    * Get whether to scroll complement panel
1149    *
1150    * @return true if cDNA/protein complement panels should be scrolled
1151    */
1152   protected boolean isSetToScrollComplementPanel()
1153   {
1154     return this.scrollComplementaryPanel;
1155   }
1156
1157   @Override
1158   /**
1159    * Property change event fired when a change is made to the viewport ranges
1160    * object associated with this alignment panel's viewport
1161    */
1162   public void propertyChange(PropertyChangeEvent evt)
1163   {
1164     // update this panel's scroll values based on the new viewport ranges values
1165     int x = vpRanges.getStartRes();
1166     int y = vpRanges.getStartSeq();
1167     setScrollValues(x, y);
1168
1169     // now update any complementary alignment (its viewport ranges object
1170     // is different so does not get automatically updated)
1171     if (isSetToScrollComplementPanel())
1172     {
1173       setToScrollComplementPanel(false);
1174       av.scrollComplementaryAlignment(getComplementPanel());
1175       setToScrollComplementPanel(true);
1176     }
1177
1178   }
1179
1180 }