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           // don't do anything if the mouse press is in the overview's box
 199           // (wait to see if it's a drag instead)
 200           // otherwise update the viewport
 201           if (!od.isPositionInBox(evt.getX(), evt.getY()))
 202           {
 203             draggingBox = false;
 204             od.updateViewportFromMouse(evt.getX(), evt.getY(),
 205                     av.getAlignment().getHiddenSequences(),
 206                     av.getAlignment().getHiddenColumns());
 207           }
 208           else
 209           {
 210             draggingBox = true;
 211             od.setDragPoint(evt.getX(), evt.getY(),
 212                     av.getAlignment().getHiddenSequences(),
 213                     av.getAlignment().getHiddenColumns());
 214           }
 215         }
 216       }
 217
 218       @Override
 219       public void mouseClicked(MouseEvent evt)
 220       {
 221         if (SwingUtilities.isRightMouseButton(evt))
 222         {
 223           showPopupMenu(evt);
 224         }
 225       }
 226     });
 227   }
 228
 229   /*
 230    * Displays the popup menu and acts on user input
 231    */
 232   private void showPopupMenu(MouseEvent e)
 233   {
 234     JPopupMenu popup = new JPopupMenu();
 235     ActionListener menuListener = new ActionListener()
 236     {
 237       @Override
 238       public void actionPerformed(ActionEvent event)
 239       {
 240         // switch on/off the hidden columns view
 241         toggleHiddenColumns();
 242         displayToggle.setSelected(showHidden);
 243       }
 244     };
 245     displayToggle = new JCheckBoxMenuItem(
 246             MessageManager.getString("label.togglehidden"));
 247     displayToggle.setEnabled(true);
 248     displayToggle.setSelected(showHidden);
 249     popup.add(displayToggle);
 250     displayToggle.addActionListener(menuListener);
 251     popup.show(this, e.getX(), e.getY());
 252   }
 253
 254   /*
 255    * Toggle overview display between showing hidden columns and hiding hidden columns
 256    */
 257   private void toggleHiddenColumns()
 258   {
 259     if (showHidden)
 260     {
 261       showHidden = false;
 262       od = new OverviewDimensionsHideHidden(av.getRanges(),
 263               (av.isShowAnnotation()
 264                       && av.getAlignmentConservationAnnotation() != null));
 265     }
 266     else
 267     {
 268       showHidden = true;
 269       od = new OverviewDimensionsShowHidden(av.getRanges(),
 270               (av.isShowAnnotation()
 271                       && av.getAlignmentConservationAnnotation() != null));
 272     }
 273     oviewCanvas.resetOviewDims(od);
 274     updateOverviewImage();
 275     setBoxPosition();
 276   }
 277
 278   /**
 279    * Updates the overview image when the related alignment panel is updated
 280    */
 281   public void updateOverviewImage()
 282   {
 283     if (oviewCanvas == null)
 284     {
 285       /*
 286        * panel has been disposed
 287        */
 288       return;
 289     }
 290
 291     if ((getWidth() > 0) && (getHeight() > 0))
 292     {
 293       od.setWidth(getWidth());
 294       od.setHeight(getHeight() - progressPanel.getHeight());
 295     }
 296
 297     setPreferredSize(new Dimension(od.getWidth(),
 298             od.getHeight() + progressPanel.getHeight()));
 299
 300     if (oviewCanvas.restartDraw())
 301     {
 302       return;
 303     }
 304
 305     Thread thread = new Thread(this);
 306     thread.start();
 307     repaint();
 308
 309
 310   }
 311
 312   @Override
 313   public void run()
 314   {
 315     if (oviewCanvas != null)
 316     {
 317       oviewCanvas.draw(av.isShowSequenceFeatures(),
 318               (av.isShowAnnotation()
 319                       && av.getAlignmentConservationAnnotation() != null),
 320               ap.getSeqPanel().seqCanvas.getFeatureRenderer());
 321       setBoxPosition();
 322     }
 323   }
 324
 325   /**
 326    * Update the overview panel box when the associated alignment panel is
 327    * changed
 328    *
 329    */
 330   private void setBoxPosition()
 331   {
 332     if (od != null)
 333     {
 334       od.setBoxPosition(av.getAlignment().getHiddenSequences(),
 335               av.getAlignment().getHiddenColumns());
 336       repaint();
 337     }
 338   }
 339
 340   @Override
 341   public void propertyChange(PropertyChangeEvent evt)
 342   {
 343     setBoxPosition();
 344   }
 345
 346   /**
 347    * Removes this object as a property change listener, and nulls references
 348    */
 349   protected void dispose()
 350   {
 351     try
 352     {
 353       av.getRanges().removePropertyChangeListener(this);
 354       oviewCanvas.dispose();
 355     } finally
 356     {
 357       progressPanel = null;
 358       av = null;
 359       oviewCanvas = null;
 360       ap = null;
 361       od = null;
 362     }
 363   }
 364 }