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 java.awt.BorderLayout;
  24 import java.awt.Cursor;
  25 import java.awt.Dimension;
  26 import java.awt.event.ActionEvent;
  27 import java.awt.event.ActionListener;
  28 import java.awt.event.ComponentAdapter;
  29 import java.awt.event.ComponentEvent;
  30 import java.awt.event.MouseAdapter;
  31 import java.awt.event.MouseEvent;
  32 import java.awt.event.MouseMotionAdapter;
  33 import java.beans.PropertyChangeEvent;
  34 import java.beans.PropertyVetoException;
  35
  36 import javax.swing.JCheckBoxMenuItem;
  37 import javax.swing.JInternalFrame;
  38 import javax.swing.JPanel;
  39 import javax.swing.JPopupMenu;
  40 import javax.swing.SwingUtilities;
  41
  42 import jalview.renderer.OverviewRenderer;
  43 import jalview.util.MessageManager;
  44 import jalview.util.Platform;
  45 import jalview.viewmodel.OverviewDimensions;
  46 import jalview.viewmodel.OverviewDimensionsHideHidden;
  47 import jalview.viewmodel.OverviewDimensionsShowHidden;
  48 import jalview.viewmodel.ViewportListenerI;
  49
  50 /**
  51  * Panel displaying an overview of the full alignment, with an interactive box
  52  * representing the viewport onto the alignment.
  53  *
  54  * @author $author$
  55  * @version $Revision$
  56  */
  57 @SuppressWarnings("serial")
  58 public class OverviewPanel extends JPanel
  59         implements Runnable, ViewportListenerI
  60 {
  61   protected OverviewDimensions od;
  62
  63   private OverviewCanvas oviewCanvas;
  64
  65   protected AlignViewport av;
  66
  67   private AlignmentPanel ap;
  68
  69   protected JCheckBoxMenuItem displayToggle;
  70
  71   protected boolean showHidden = true;
  72
  73   protected boolean draggingBox = false;
  74
  75   protected 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    * @param isShowHidden TODO
  83    */
  84   public OverviewPanel(AlignmentPanel alPanel, boolean isShowHidden)
  85   {
  86     this.av = alPanel.av;
  87     this.ap = alPanel;
  88
  89     showHidden = isShowHidden;
  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 (od.isPositionInBox(evt.getX(), evt.getY()))
 174         {
 175           /*
 176            * using HAND_CURSOR rather than DRAG_CURSOR
 177            * as the latter is not supported on Mac
 178            */
 179           getParent().setCursor(
 180                   Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
 181         }
 182         else
 183         {
 184           // reset cursor
 185           getParent().setCursor(
 186                   Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
 187         }
 188       }
 189
 190     });
 191
 192     addMouseListener(new MouseAdapter()
 193     {
 194       @Override
 195       public void mousePressed(MouseEvent evt)
 196       {
 197
 198         if (Platform.isWinRightButton(evt)) {
 199                 showPopupMenu(evt);
 200                 return;
 201         }
 202         if (SwingUtilities.isRightMouseButton(evt)) {
 203                 return;
 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             getParent().setCursor(
 219                     Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
 220           }
 221           else
 222           {
 223             draggingBox = true;
 224             od.setDragPoint(evt.getX(), evt.getY(),
 225                     av.getAlignment().getHiddenSequences(),
 226                     av.getAlignment().getHiddenColumns());
 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      * Javascript does not call componentResized on initial display,
 249      * so do the update here
 250      */
 251     if (Platform.isJS())
 252     {
 253       updateOverviewImage();
 254     }
 255   }
 256
 257   /*
 258    * Displays the popup menu and acts on user input
 259    */
 260   protected void showPopupMenu(MouseEvent e)
 261   {
 262     JPopupMenu popup = new JPopupMenu();
 263     ActionListener menuListener = new ActionListener()
 264     {
 265       @Override
 266       public void actionPerformed(ActionEvent event)
 267       {
 268         // switch on/off the hidden columns view
 269         toggleHiddenColumns();
 270         displayToggle.setSelected(showHidden);
 271       }
 272     };
 273     displayToggle = new JCheckBoxMenuItem(
 274             MessageManager.getString("label.togglehidden"));
 275     displayToggle.setEnabled(true);
 276     displayToggle.setSelected(showHidden);
 277     popup.add(displayToggle);
 278     displayToggle.addActionListener(menuListener);
 279     popup.show(this, e.getX(), e.getY());
 280   }
 281
 282   /*
 283    * Toggle overview display between showing hidden columns and hiding hidden columns
 284    */
 285   protected void toggleHiddenColumns()
 286   {
 287     if (showHidden)
 288     {
 289       showHidden = false;
 290       od = new OverviewDimensionsHideHidden(av.getRanges(),
 291               (av.isShowAnnotation()
 292                       && av.getAlignmentConservationAnnotation() != null));
 293     }
 294     else
 295     {
 296       showHidden = true;
 297       od = new OverviewDimensionsShowHidden(av.getRanges(),
 298               (av.isShowAnnotation()
 299                       && av.getAlignmentConservationAnnotation() != null));
 300     }
 301     oviewCanvas.resetOviewDims(od);
 302     updateOverviewImage();
 303     setBoxPosition();
 304   }
 305
 306   /**
 307    * Updates the overview image when the related alignment panel is updated
 308    */
 309   public void updateOverviewImage()
 310   {
 311     if (oviewCanvas == null)
 312     {
 313       /*
 314        * panel has been disposed
 315        */
 316       return;
 317     }
 318
 319     if ((getWidth() > 0) && (getHeight() > 0))
 320     {
 321       od.setWidth(getWidth());
 322       od.setHeight(getHeight() - progressPanel.getHeight());
 323     }
 324
 325     setPreferredSize(new Dimension(od.getWidth(),
 326             od.getHeight() + progressPanel.getHeight()));
 327
 328     if (oviewCanvas.restartDraw())
 329     {
 330       return;
 331     }
 332
 333     Thread thread = new Thread(this);
 334     thread.start();
 335     repaint();
 336
 337
 338   }
 339
 340   @Override
 341   public void run()
 342   {
 343     if (oviewCanvas != null)
 344     {
 345       oviewCanvas.draw(av.isShowSequenceFeatures(),
 346               (av.isShowAnnotation()
 347                       && av.getAlignmentConservationAnnotation() != null),
 348               ap.getSeqPanel().seqCanvas.getFeatureRenderer());
 349       setBoxPosition();
 350     }
 351   }
 352
 353   /**
 354    * Update the overview panel box when the associated alignment panel is
 355    * changed
 356    *
 357    */
 358   private void setBoxPositionOnly()
 359   {
 360     if (od != null)
 361     {
 362       int oldX = od.getBoxX();
 363       int oldY = od.getBoxY();
 364       int oldWidth = od.getBoxWidth();
 365       int oldHeight = od.getBoxHeight();
 366       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 367               av.getAlignment().getHiddenColumns());
 368       repaint(oldX - 1, oldY - 1, oldWidth + 2, oldHeight + 2);
 369       repaint(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
 370               od.getBoxHeight());
 371     }
 372   }
 373
 374   private void setBoxPosition()
 375   {
 376     if (od != null)
 377     {
 378       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 379               av.getAlignment().getHiddenColumns());
 380       repaint();
 381     }
 382   }
 383
 384   @Override
 385   public void propertyChange(PropertyChangeEvent evt)
 386   {
 387     setBoxPositionOnly();
 388   }
 389
 390   /**
 391    * Removes this object as a property change listener, and nulls references
 392    */
 393   protected void dispose()
 394   {
 395     try
 396     {
 397       if (av != null)
 398       {
 399         av.getRanges().removePropertyChangeListener(this);
 400       }
 401
 402       oviewCanvas.dispose();
 403
 404       /*
 405        * close the parent frame (which also removes it from the
 406        * Desktop Windows menu)
 407        */
 408       ((JInternalFrame) SwingUtilities.getAncestorOfClass(
 409               JInternalFrame.class, (this))).setClosed(true);
 410     } catch (PropertyVetoException e)
 411     {
 412       // ignore
 413     } finally
 414     {
 415       progressPanel = null;
 416       av = null;
 417       oviewCanvas = null;
 418       ap = null;
 419       od = null;
 420     }
 421   }
 422
 423   public boolean isShowHiddenRegions()
 424   {
 425     return showHidden;
 426   }
 427
 428   public OverviewCanvas getCanvas()
 429   {
 430     return oviewCanvas;
 431   }
 432 }