src/jalview/gui/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.gui;
  22
  23 import jalview.bin.Cache;
  24 import jalview.renderer.OverviewRenderer;
  25 import jalview.util.MessageManager;
  26 import jalview.util.Platform;
  27 import jalview.viewmodel.OverviewDimensions;
  28 import jalview.viewmodel.OverviewDimensionsHideHidden;
  29 import jalview.viewmodel.OverviewDimensionsShowHidden;
  30 import jalview.viewmodel.ViewportListenerI;
  31
  32 import java.awt.BorderLayout;
  33 import java.awt.Cursor;
  34 import java.awt.Dimension;
  35 import java.awt.event.ActionEvent;
  36 import java.awt.event.ActionListener;
  37 import java.awt.event.ComponentAdapter;
  38 import java.awt.event.ComponentEvent;
  39 import java.awt.event.MouseAdapter;
  40 import java.awt.event.MouseEvent;
  41 import java.awt.event.MouseMotionAdapter;
  42 import java.beans.PropertyChangeEvent;
  43 import java.beans.PropertyVetoException;
  44
  45 import javax.swing.JCheckBoxMenuItem;
  46 import javax.swing.JInternalFrame;
  47 import javax.swing.JPanel;
  48 import javax.swing.JPopupMenu;
  49 import javax.swing.SwingUtilities;
  50
  51 /**
  52  * Panel displaying an overview of the full alignment, with an interactive box
  53  * representing the viewport onto the alignment.
  54  *
  55  * @author $author$
  56  * @version $Revision$
  57  */
  58 public class OverviewPanel extends JPanel
  59         implements Runnable, ViewportListenerI
  60 {
  61   private OverviewDimensions od;
  62
  63   private OverviewCanvas oviewCanvas;
  64
  65   private AlignViewport av;
  66
  67   private AlignmentPanel ap;
  68
  69   private JCheckBoxMenuItem displayToggle;
  70
  71   private boolean showHidden = true;
  72
  73   private boolean draggingBox = false;
  74
  75   private ProgressPanel progressPanel;
  76
  77   /**
  78    * Creates a new OverviewPanel object.
  79    *
  80    * @param alPanel
  81    *          The alignment panel which is shown in the overview panel
  82    */
  83   public OverviewPanel(AlignmentPanel alPanel)
  84   {
  85     this.av = alPanel.av;
  86     this.ap = alPanel;
  87
  88     showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
  89             true);
  90     if (showHidden)
  91     {
  92       od = new OverviewDimensionsShowHidden(av.getRanges(),
  93             (av.isShowAnnotation()
  94                     && av.getAlignmentConservationAnnotation() != null));
  95     }
  96     else
  97     {
  98       od = new OverviewDimensionsHideHidden(av.getRanges(),
  99               (av.isShowAnnotation()
 100                       && av.getAlignmentConservationAnnotation() != null));
 101     }
 102
 103     setLayout(new BorderLayout());
 104     progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
 105             MessageManager.getString("label.oview_calc"), getWidth());
 106     this.add(progressPanel, BorderLayout.SOUTH);
 107     oviewCanvas = new OverviewCanvas(od, av, progressPanel);
 108
 109     add(oviewCanvas, BorderLayout.CENTER);
 110
 111     av.getRanges().addPropertyChangeListener(this);
 112
 113     // without this the overview window does not size to fit the overview canvas
 114     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 115
 116     addComponentListener(new ComponentAdapter()
 117     {
 118       @Override
 119       public void componentResized(ComponentEvent evt)
 120       {
 121         // Resize is called on the initial display of the overview.
 122         // This code adjusts sizes to account for the progress bar if it has not
 123         // already been accounted for, which triggers another resize call for
 124         // the correct sizing, at which point the overview image is updated.
 125         // (This avoids a double recalculation of the image.)
 126         if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
 127                 + progressPanel.getHeight())
 128         {
 129           updateOverviewImage();
 130         }
 131         else
 132         {
 133           if ((getWidth() > 0) && (getHeight() > 0))
 134           {
 135             od.setWidth(getWidth());
 136             od.setHeight(getHeight() - progressPanel.getHeight());
 137           }
 138
 139           setPreferredSize(new Dimension(od.getWidth(),
 140                   od.getHeight() + progressPanel.getHeight()));
 141         }
 142       }
 143
 144     });
 145
 146     addMouseMotionListener(new MouseMotionAdapter()
 147     {
 148       @Override
 149       public void mouseDragged(MouseEvent evt)
 150       {
 151         if (!SwingUtilities.isRightMouseButton(evt))
 152         {
 153           if (draggingBox)
 154           {
 155             // set the mouse position as a fixed point in the box
 156             // and drag relative to that position
 157             od.adjustViewportFromMouse(evt.getX(), evt.getY(),
 158                     av.getAlignment().getHiddenSequences(),
 159                     av.getAlignment().getHiddenColumns());
 160           }
 161           else
 162           {
 163             od.updateViewportFromMouse(evt.getX(), evt.getY(),
 164                     av.getAlignment().getHiddenSequences(),
 165                     av.getAlignment().getHiddenColumns());
 166           }
 167         }
 168       }
 169
 170       @Override
 171       public void mouseMoved(MouseEvent evt)
 172       {
 173         if (!draggingBox)
 174         // don't bother changing the cursor if we're dragging the box
 175         // as we can't have moved inside or out of the box in that case
 176         {
 177           if (od.isPositionInBox(evt.getX(), evt.getY()))
 178           {
 179             // display drag cursor at mouse position
 180             setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
 181           }
 182           else
 183           {
 184             // reset cursor
 185             setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
 186           }
 187         }
 188       }
 189     });
 190
 191     addMouseListener(new MouseAdapter()
 192     {
 193       @Override
 194       public void mousePressed(MouseEvent evt)
 195       {
 196         if (SwingUtilities.isRightMouseButton(evt))
 197         {
 198           if (!Platform.isAMac())
 199           {
 200             showPopupMenu(evt);
 201           }
 202         }
 203         else
 204         {
 205           // don't do anything if the mouse press is in the overview's box
 206           // (wait to see if it's a drag instead)
 207           // otherwise update the viewport
 208           if (!od.isPositionInBox(evt.getX(), evt.getY()))
 209           {
 210             draggingBox = false;
 211
 212             // display drag cursor at mouse position
 213             setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
 214
 215             od.updateViewportFromMouse(evt.getX(), evt.getY(),
 216                     av.getAlignment().getHiddenSequences(),
 217                     av.getAlignment().getHiddenColumns());
 218           }
 219           else
 220           {
 221             draggingBox = true;
 222             od.setDragPoint(evt.getX(), evt.getY(),
 223                     av.getAlignment().getHiddenSequences(),
 224                     av.getAlignment().getHiddenColumns());
 225           }
 226         }
 227       }
 228
 229       @Override
 230       public void mouseClicked(MouseEvent evt)
 231       {
 232         if (SwingUtilities.isRightMouseButton(evt))
 233         {
 234           showPopupMenu(evt);
 235         }
 236       }
 237
 238       @Override
 239       public void mouseReleased(MouseEvent evt)
 240       {
 241         draggingBox = false;
 242       }
 243
 244     });
 245   }
 246
 247   /*
 248    * Displays the popup menu and acts on user input
 249    */
 250   private void showPopupMenu(MouseEvent e)
 251   {
 252     JPopupMenu popup = new JPopupMenu();
 253     ActionListener menuListener = new ActionListener()
 254     {
 255       @Override
 256       public void actionPerformed(ActionEvent event)
 257       {
 258         // switch on/off the hidden columns view
 259         toggleHiddenColumns();
 260         displayToggle.setSelected(showHidden);
 261       }
 262     };
 263     displayToggle = new JCheckBoxMenuItem(
 264             MessageManager.getString("label.togglehidden"));
 265     displayToggle.setEnabled(true);
 266     displayToggle.setSelected(showHidden);
 267     popup.add(displayToggle);
 268     displayToggle.addActionListener(menuListener);
 269     popup.show(this, e.getX(), e.getY());
 270   }
 271
 272   /*
 273    * Toggle overview display between showing hidden columns and hiding hidden columns
 274    */
 275   private void toggleHiddenColumns()
 276   {
 277     if (showHidden)
 278     {
 279       showHidden = false;
 280       od = new OverviewDimensionsHideHidden(av.getRanges(),
 281               (av.isShowAnnotation()
 282                       && av.getAlignmentConservationAnnotation() != null));
 283     }
 284     else
 285     {
 286       showHidden = true;
 287       od = new OverviewDimensionsShowHidden(av.getRanges(),
 288               (av.isShowAnnotation()
 289                       && av.getAlignmentConservationAnnotation() != null));
 290     }
 291     oviewCanvas.resetOviewDims(od);
 292     updateOverviewImage();
 293     setBoxPosition();
 294   }
 295
 296   /**
 297    * Updates the overview image when the related alignment panel is updated
 298    */
 299   public void updateOverviewImage()
 300   {
 301     if (oviewCanvas == null)
 302     {
 303       /*
 304        * panel has been disposed
 305        */
 306       return;
 307     }
 308
 309     if ((getWidth() > 0) && (getHeight() > 0))
 310     {
 311       od.setWidth(getWidth());
 312       od.setHeight(getHeight() - progressPanel.getHeight());
 313     }
 314
 315     setPreferredSize(new Dimension(od.getWidth(),
 316             od.getHeight() + progressPanel.getHeight()));
 317
 318     if (oviewCanvas.restartDraw())
 319     {
 320       return;
 321     }
 322
 323     Thread thread = new Thread(this);
 324     thread.start();
 325     repaint();
 326
 327
 328   }
 329
 330   @Override
 331   public void run()
 332   {
 333     if (oviewCanvas != null)
 334     {
 335       oviewCanvas.draw(av.isShowSequenceFeatures(),
 336               (av.isShowAnnotation()
 337                       && av.getAlignmentConservationAnnotation() != null),
 338               ap.getSeqPanel().seqCanvas.getFeatureRenderer());
 339       setBoxPosition();
 340     }
 341   }
 342
 343   /**
 344    * Update the overview panel box when the associated alignment panel is
 345    * changed
 346    *
 347    */
 348   private void setBoxPositionOnly()
 349   {
 350     if (od != null)
 351     {
 352       int oldX = od.getBoxX();
 353       int oldY = od.getBoxY();
 354       int oldWidth = od.getBoxWidth();
 355       int oldHeight = od.getBoxHeight();
 356       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 357               av.getAlignment().getHiddenColumns());
 358       repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
 359       repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
 360               od.getBoxHeight());
 361     }
 362   }
 363
 364   private void setBoxPosition()
 365   {
 366     if (od != null)
 367     {
 368       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 369               av.getAlignment().getHiddenColumns());
 370       repaint();
 371     }
 372   }
 373
 374   @Override
 375   public void propertyChange(PropertyChangeEvent evt)
 376   {
 377     setBoxPositionOnly();
 378   }
 379
 380   /**
 381    * Removes this object as a property change listener, and nulls references
 382    */
 383   protected void dispose()
 384   {
 385     try
 386     {
 387       if (av != null)
 388       {
 389         av.getRanges().removePropertyChangeListener(this);
 390       }
 391
 392       oviewCanvas.dispose();
 393
 394       /*
 395        * close the parent frame (which also removes it from the
 396        * Desktop Windows menu)
 397        */
 398       ((JInternalFrame) SwingUtilities.getAncestorOfClass(
 399               JInternalFrame.class, (this))).setClosed(true);
 400     } catch (PropertyVetoException e)
 401     {
 402       // ignore
 403     } finally
 404     {
 405       progressPanel = null;
 406       av = null;
 407       oviewCanvas = null;
 408       ap = null;
 409       od = null;
 410     }
 411   }
 412 }