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.bin.Cache;
  24 import jalview.renderer.OverviewRenderer;
  25 import jalview.util.MessageManager;
  26 import jalview.util.Platform;
  27 import jalview.viewmodel.OverviewDimensions;
  28 import jalview.viewmodel.OverviewDimensionsHideHidden;
  29 import jalview.viewmodel.OverviewDimensionsShowHidden;
  30 import jalview.viewmodel.ViewportListenerI;
  31
  32 import java.awt.BorderLayout;
  33 import java.awt.Cursor;
  34 import java.awt.Dimension;
  35 import java.awt.event.ActionEvent;
  36 import java.awt.event.ActionListener;
  37 import java.awt.event.ComponentAdapter;
  38 import java.awt.event.ComponentEvent;
  39 import java.awt.event.MouseAdapter;
  40 import java.awt.event.MouseEvent;
  41 import java.awt.event.MouseMotionAdapter;
  42 import java.beans.PropertyChangeEvent;
  43 import java.beans.PropertyVetoException;
  44
  45 import javax.swing.JCheckBoxMenuItem;
  46 import javax.swing.JInternalFrame;
  47 import javax.swing.JPanel;
  48 import javax.swing.JPopupMenu;
  49 import javax.swing.SwingUtilities;
  50
  51 /**
  52  * Panel displaying an overview of the full alignment, with an interactive box
  53  * representing the viewport onto the alignment.
  54  *
  55  * @author $author$
  56  * @version $Revision$
  57  */
  58 @SuppressWarnings("serial")
  59 public class OverviewPanel extends JPanel
  60         implements Runnable, ViewportListenerI
  61 {
  62   protected OverviewDimensions od;
  63
  64   private OverviewCanvas oviewCanvas;
  65
  66   protected AlignViewport av;
  67
  68   private AlignmentPanel ap;
  69
  70   protected JCheckBoxMenuItem displayToggle;
  71
  72   protected boolean showHidden = true;
  73
  74   protected boolean draggingBox = false;
  75
  76   protected 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.isAMacAndNotJS())
 200           {
 201                 // BH - MAC L&F here - forces popup and cancels any drag operation
 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           }
 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
 231       @Override
 232       public void mouseClicked(MouseEvent evt)
 233       {
 234         if (SwingUtilities.isRightMouseButton(evt))
 235         {
 236           showPopupMenu(evt);
 237         }
 238       }
 239
 240       @Override
 241       public void mouseReleased(MouseEvent evt)
 242       {
 243         draggingBox = false;
 244       }
 245
 246     });
 247
 248     /*
 249      * Javascript does not call componentResized on initial display,
 250      * so do the update here
 251      */
 252     boolean doUpdate =  /** @j2sNative true || */ false;
 253     if (doUpdate)
 254       updateOverviewImage();
 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 }