src/jalview/appletgui/OverviewPanel.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.datamodel.SequenceI;
  24 import jalview.renderer.seqfeatures.FeatureColourFinder;
  25 import jalview.viewmodel.OverviewDimensions;
  26 import jalview.viewmodel.ViewportListenerI;
  27
  28 import java.awt.Color;
  29 import java.awt.Dimension;
  30 import java.awt.Frame;
  31 import java.awt.Graphics;
  32 import java.awt.Image;
  33 import java.awt.Panel;
  34 import java.awt.event.ComponentAdapter;
  35 import java.awt.event.ComponentEvent;
  36 import java.awt.event.MouseEvent;
  37 import java.awt.event.MouseListener;
  38 import java.awt.event.MouseMotionListener;
  39 import java.beans.PropertyChangeEvent;
  40
  41 public class OverviewPanel extends Panel implements Runnable,
  42         MouseMotionListener, MouseListener, ViewportListenerI
  43 {
  44   private OverviewDimensions od;
  45
  46   private Image miniMe;
  47
  48   private Image offscreen;
  49
  50   private AlignViewport av;
  51
  52   private AlignmentPanel ap;
  53
  54   private boolean resizing = false;
  55
  56   // This is set true if the user resizes whilst
  57   // the overview is being calculated
  58   private boolean resizeAgain = false;
  59
  60   // Can set different properties in this seqCanvas than
  61   // main visible SeqCanvas
  62   private SequenceRenderer sr;
  63
  64   private FeatureRenderer fr;
  65
  66   private Frame nullFrame;
  67
  68   public OverviewPanel(AlignmentPanel alPanel)
  69   {
  70     this.av = alPanel.av;
  71     this.ap = alPanel;
  72     setLayout(null);
  73     nullFrame = new Frame();
  74     nullFrame.addNotify();
  75
  76     sr = new SequenceRenderer(av);
  77     sr.graphics = nullFrame.getGraphics();
  78     sr.renderGaps = false;
  79     sr.forOverview = true;
  80     fr = new FeatureRenderer(av);
  81
  82     od = new OverviewDimensions(av.getRanges(),
  83             (av.isShowAnnotation() && av.getSequenceConsensusHash() != null));
  84
  85     setSize(new Dimension(od.getWidth(), od.getHeight()));
  86
  87     av.getRanges().addPropertyChangeListener(this);
  88
  89     addComponentListener(new ComponentAdapter()
  90     {
  91
  92       @Override
  93       public void componentResized(ComponentEvent evt)
  94       {
  95         if ((getWidth() != od.getWidth())
  96                 || (getHeight() != (od.getHeight())))
  97         {
  98           updateOverviewImage();
  99         }
 100       }
 101     });
 102
 103     addMouseMotionListener(this);
 104
 105     addMouseListener(this);
 106
 107     updateOverviewImage();
 108
 109   }
 110
 111   @Override
 112   public void mouseEntered(MouseEvent evt)
 113   {
 114   }
 115
 116   @Override
 117   public void mouseExited(MouseEvent evt)
 118   {
 119   }
 120
 121   @Override
 122   public void mouseClicked(MouseEvent evt)
 123   {
 124   }
 125
 126   @Override
 127   public void mouseMoved(MouseEvent evt)
 128   {
 129   }
 130
 131   @Override
 132   public void mousePressed(MouseEvent evt)
 133   {
 134     mouseAction(evt);
 135   }
 136
 137   @Override
 138   public void mouseReleased(MouseEvent evt)
 139   {
 140     mouseAction(evt);
 141   }
 142
 143   @Override
 144   public void mouseDragged(MouseEvent evt)
 145   {
 146     mouseAction(evt);
 147   }
 148
 149   private void mouseAction(MouseEvent evt)
 150   {
 151     od.updateViewportFromMouse(evt.getX(), evt.getY(), av.getAlignment()
 152             .getHiddenSequences(), av.getColumnSelection(), av
 153             .getRanges());
 154     // ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
 155     ap.paintAlignment(false);
 156   }
 157
 158   /**
 159    * Updates the overview image when the related alignment panel is updated
 160    */
 161   public void updateOverviewImage()
 162   {
 163     if (resizing)
 164     {
 165       resizeAgain = true;
 166       return;
 167     }
 168
 169     if (av.isShowSequenceFeatures())
 170     {
 171       fr.transferSettings(ap.seqPanel.seqCanvas.fr);
 172     }
 173
 174     resizing = true;
 175
 176     if ((getSize().width > 0) && (getSize().height > 0))
 177     {
 178       od.setWidth(getSize().width);
 179       od.setHeight(getSize().height);
 180     }
 181     setSize(new Dimension(od.getWidth(), od.getHeight()));
 182
 183     Thread thread = new Thread(this);
 184     thread.start();
 185     repaint();
 186   }
 187
 188   @Override
 189   public void run()
 190   {
 191     miniMe = null;
 192
 193     if (av.isShowSequenceFeatures())
 194     {
 195       fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());
 196     }
 197
 198     if (getSize().width > 0 && getSize().height > 0)
 199     {
 200       od.setWidth(getSize().width);
 201       od.setHeight(getSize().height);
 202     }
 203
 204     setSize(new Dimension(od.getWidth(), od.getHeight()));
 205
 206     miniMe = nullFrame.createImage(od.getWidth(), od.getHeight());
 207     offscreen = nullFrame.createImage(od.getWidth(), od.getHeight());
 208
 209     Graphics mg = miniMe.getGraphics();
 210
 211     int alwidth = av.getAlignment().getWidth();
 212     int alheight = av.getAlignment().getAbsoluteHeight();
 213     float sampleCol = alwidth / (float) od.getWidth();
 214     float sampleRow = alheight / (float) od.getSequencesHeight();
 215
 216     buildImage(sampleRow, sampleCol, mg);
 217
 218     // check for conservation annotation to make sure overview works for DNA too
 219     if (av.isShowAnnotation()
 220             && (av.getAlignmentConservationAnnotation() != null))
 221     {
 222       for (int col = 0; col < od.getWidth() && !resizeAgain; col++)
 223       {
 224         mg.translate(col, od.getSequencesHeight());
 225         ap.annotationPanel.renderer.drawGraph(mg,
 226                 av.getAlignmentConservationAnnotation(),
 227                 av.getAlignmentConservationAnnotation().annotations,
 228                 (int) (sampleCol) + 1, od.getGraphHeight(),
 229                 (int) (col * sampleCol), (int) (col * sampleCol) + 1);
 230         mg.translate(-col, -od.getSequencesHeight());
 231       }
 232     }
 233     System.gc();
 234
 235     resizing = false;
 236
 237     setBoxPosition();
 238
 239     if (resizeAgain)
 240     {
 241       resizeAgain = false;
 242       updateOverviewImage();
 243     }
 244   }
 245
 246   /*
 247    * Build the overview panel image
 248    */
 249   private void buildImage(float sampleRow, float sampleCol, Graphics mg)
 250   {
 251     int lastcol = 0;
 252     int lastrow = 0;
 253     int xstart = 0;
 254     int ystart = 0;
 255     Color color = Color.yellow;
 256     int sameRow = 0;
 257     int sameCol = 0;
 258
 259     SequenceI seq = null;
 260     FeatureColourFinder finder = new FeatureColourFinder(fr);
 261
 262     final boolean hasHiddenCols = av.hasHiddenColumns();
 263     boolean hiddenRow = false;
 264
 265     for (int row = 0; row <= od.getSequencesHeight() && !resizeAgain; row++)
 266     {
 267       if ((int) (row * sampleRow) == lastrow)
 268       {
 269         sameRow++;
 270       }
 271       else
 272       {
 273         // get the sequence which would be at alignment index 'lastrow' if no
 274         // columns were hidden, and determine whether it is hidden or not
 275         hiddenRow = av.getAlignment().isHidden(lastrow);
 276         seq = av.getAlignment().getSequenceAtAbsoluteIndex(lastrow);
 277
 278         for (int col = 0; col < od.getWidth(); col++)
 279         {
 280           if ((int) (col * sampleCol) == lastcol
 281                   && (int) (row * sampleRow) == lastrow)
 282           {
 283             sameCol++;
 284           }
 285           else
 286           {
 287             lastcol = (int) (col * sampleCol);
 288
 289             color = getColumnColourFromSequence(seq, hiddenRow,
 290                     hasHiddenCols, lastcol, finder);
 291
 292             mg.setColor(color);
 293             if (sameCol == 1 && sameRow == 1)
 294             {
 295               mg.drawLine(xstart, ystart, xstart, ystart);
 296             }
 297             else
 298             {
 299               mg.fillRect(xstart, ystart, sameCol, sameRow);
 300             }
 301
 302             xstart = col;
 303             sameCol = 1;
 304           }
 305         }
 306         lastrow = (int) (row * sampleRow);
 307         ystart = row;
 308         sameRow = 1;
 309       }
 310     }
 311   }
 312
 313   /*
 314    * Find the colour of a sequence at a specified column position
 315    */
 316   private Color getColumnColourFromSequence(
 317           jalview.datamodel.SequenceI seq, boolean hiddenRow,
 318           boolean hasHiddenCols, int lastcol, FeatureColourFinder finder)
 319   {
 320     Color color = Color.white;
 321     if (seq.getLength() > lastcol)
 322     {
 323       color = sr.getResidueColour(seq, lastcol, finder);
 324     }
 325
 326     if (hiddenRow
 327             || (hasHiddenCols && !av.getColumnSelection()
 328                     .isVisible(lastcol)))
 329     {
 330       color = color.darker().darker();
 331     }
 332     return color;
 333   }
 334
 335   /**
 336    * Update the overview panel box when the associated alignment panel is
 337    * changed
 338    *
 339    */
 340   private void setBoxPosition()
 341   {
 342     od.setBoxPosition(av.getAlignment()
 343             .getHiddenSequences(), av.getColumnSelection(), av.getRanges());
 344     repaint();
 345   }
 346
 347   @Override
 348   public void update(Graphics g)
 349   {
 350     paint(g);
 351   }
 352
 353   @Override
 354   public void paint(Graphics g)
 355   {
 356     Graphics og = offscreen.getGraphics();
 357     if (miniMe != null)
 358     {
 359       og.drawImage(miniMe, 0, 0, this);
 360       og.setColor(Color.red);
 361       od.drawBox(og);
 362       g.drawImage(offscreen, 0, 0, this);
 363     }
 364   }
 365
 366   @Override
 367   public void propertyChange(PropertyChangeEvent evt)
 368   {
 369     setBoxPosition();
 370   }
 371
 372 }