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             false);
  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 (od.isPositionInBox(evt.getX(), evt.getY()))
 175         {
 176           /*
 177            * using HAND_CURSOR rather than DRAG_CURSOR
 178            * as the latter is not supported on Mac
 179            */
 180           getParent().setCursor(
 181                   Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
 182         }
 183         else
 184         {
 185           // reset cursor
 186           getParent().setCursor(
 187                   Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
 188         }
 189       }
 190
 191     });
 192
 193     addMouseListener(new MouseAdapter()
 194     {
 195       @Override
 196       public void mousePressed(MouseEvent evt)
 197       {
 198         if (SwingUtilities.isRightMouseButton(evt))
 199         {
 200           if (!Platform.isAMac())
 201           {
 202             showPopupMenu(evt);
 203           }
 204         }
 205         else
 206         {
 207           // don't do anything if the mouse press is in the overview's box
 208           // (wait to see if it's a drag instead)
 209           // otherwise update the viewport
 210           if (!od.isPositionInBox(evt.getX(), evt.getY()))
 211           {
 212             draggingBox = false;
 213
 214             // display drag cursor at mouse position
 215             setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
 216
 217             od.updateViewportFromMouse(evt.getX(), evt.getY(),
 218                     av.getAlignment().getHiddenSequences(),
 219                     av.getAlignment().getHiddenColumns());
 220             getParent().setCursor(
 221                     Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
 222           }
 223           else
 224           {
 225             draggingBox = true;
 226             od.setDragPoint(evt.getX(), evt.getY(),
 227                     av.getAlignment().getHiddenSequences(),
 228                     av.getAlignment().getHiddenColumns());
 229           }
 230         }
 231       }
 232
 233       @Override
 234       public void mouseClicked(MouseEvent evt)
 235       {
 236         if (SwingUtilities.isRightMouseButton(evt))
 237         {
 238           showPopupMenu(evt);
 239         }
 240       }
 241
 242       @Override
 243       public void mouseReleased(MouseEvent evt)
 244       {
 245         draggingBox = false;
 246       }
 247
 248     });
 249   }
 250
 251   /*
 252    * Displays the popup menu and acts on user input
 253    */
 254   private void showPopupMenu(MouseEvent e)
 255   {
 256     JPopupMenu popup = new JPopupMenu();
 257     ActionListener menuListener = new ActionListener()
 258     {
 259       @Override
 260       public void actionPerformed(ActionEvent event)
 261       {
 262         // switch on/off the hidden columns view
 263         toggleHiddenColumns();
 264         displayToggle.setSelected(showHidden);
 265       }
 266     };
 267     displayToggle = new JCheckBoxMenuItem(
 268             MessageManager.getString("label.togglehidden"));
 269     displayToggle.setEnabled(true);
 270     displayToggle.setSelected(showHidden);
 271     popup.add(displayToggle);
 272     displayToggle.addActionListener(menuListener);
 273     popup.show(this, e.getX(), e.getY());
 274   }
 275
 276   /*
 277    * Toggle overview display between showing hidden columns and hiding hidden columns
 278    */
 279   private void toggleHiddenColumns()
 280   {
 281     if (showHidden)
 282     {
 283       showHidden = false;
 284       od = new OverviewDimensionsHideHidden(av.getRanges(),
 285               (av.isShowAnnotation()
 286                       && av.getAlignmentConservationAnnotation() != null));
 287     }
 288     else
 289     {
 290       showHidden = true;
 291       od = new OverviewDimensionsShowHidden(av.getRanges(),
 292               (av.isShowAnnotation()
 293                       && av.getAlignmentConservationAnnotation() != null));
 294     }
 295     oviewCanvas.resetOviewDims(od);
 296     updateOverviewImage();
 297     setBoxPosition();
 298   }
 299
 300   /**
 301    * Updates the overview image when the related alignment panel is updated
 302    */
 303   public void updateOverviewImage()
 304   {
 305     if (oviewCanvas == null)
 306     {
 307       /*
 308        * panel has been disposed
 309        */
 310       return;
 311     }
 312
 313     if ((getWidth() > 0) && (getHeight() > 0))
 314     {
 315       od.setWidth(getWidth());
 316       od.setHeight(getHeight() - progressPanel.getHeight());
 317     }
 318
 319     setPreferredSize(new Dimension(od.getWidth(),
 320             od.getHeight() + progressPanel.getHeight()));
 321
 322     if (oviewCanvas.restartDraw())
 323     {
 324       return;
 325     }
 326
 327     Thread thread = new Thread(this);
 328     thread.start();
 329     repaint();
 330
 331
 332   }
 333
 334   @Override
 335   public void run()
 336   {
 337     if (oviewCanvas != null)
 338     {
 339       oviewCanvas.draw(av.isShowSequenceFeatures(),
 340               (av.isShowAnnotation()
 341                       && av.getAlignmentConservationAnnotation() != null),
 342               ap.getSeqPanel().seqCanvas.getFeatureRenderer());
 343       setBoxPosition();
 344     }
 345   }
 346
 347   /**
 348    * Update the overview panel box when the associated alignment panel is
 349    * changed
 350    *
 351    */
 352   private void setBoxPositionOnly()
 353   {
 354     if (od != null)
 355     {
 356       int oldX = od.getBoxX();
 357       int oldY = od.getBoxY();
 358       int oldWidth = od.getBoxWidth();
 359       int oldHeight = od.getBoxHeight();
 360       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 361               av.getAlignment().getHiddenColumns());
 362       repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
 363       repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
 364               od.getBoxHeight());
 365     }
 366   }
 367
 368   private void setBoxPosition()
 369   {
 370     if (od != null)
 371     {
 372       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 373               av.getAlignment().getHiddenColumns());
 374       repaint();
 375     }
 376   }
 377
 378   @Override
 379   public void propertyChange(PropertyChangeEvent evt)
 380   {
 381     setBoxPositionOnly();
 382   }
 383
 384   /**
 385    * Removes this object as a property change listener, and nulls references
 386    */
 387   protected void dispose()
 388   {
 389     try
 390     {
 391       if (av != null)
 392       {
 393         av.getRanges().removePropertyChangeListener(this);
 394       }
 395
 396       oviewCanvas.dispose();
 397
 398       /*
 399        * close the parent frame (which also removes it from the
 400        * Desktop Windows menu)
 401        */
 402       ((JInternalFrame) SwingUtilities.getAncestorOfClass(
 403               JInternalFrame.class, (this))).setClosed(true);
 404     } catch (PropertyVetoException e)
 405     {
 406       // ignore
 407     } finally
 408     {
 409       progressPanel = null;
 410       av = null;
 411       oviewCanvas = null;
 412       ap = null;
 413       od = null;
 414     }
 415   }
 416 }