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