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