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