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