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