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.util.MessageManager;
  24 import jalview.util.Platform;
  25 import jalview.viewmodel.OverviewDimensions;
  26 import jalview.viewmodel.OverviewDimensionsHideHidden;
  27 import jalview.viewmodel.OverviewDimensionsShowHidden;
  28 import jalview.viewmodel.ViewportListenerI;
  29
  30 import java.awt.BorderLayout;
  31 import java.awt.Dimension;
  32 import java.awt.event.ActionEvent;
  33 import java.awt.event.ActionListener;
  34 import java.awt.event.ComponentAdapter;
  35 import java.awt.event.ComponentEvent;
  36 import java.awt.event.MouseAdapter;
  37 import java.awt.event.MouseEvent;
  38 import java.awt.event.MouseMotionAdapter;
  39 import java.beans.PropertyChangeEvent;
  40
  41 import javax.swing.JCheckBoxMenuItem;
  42 import javax.swing.JPanel;
  43 import javax.swing.JPopupMenu;
  44 import javax.swing.SwingUtilities;
  45
  46 /**
  47  * Panel displaying an overview of the full alignment, with an interactive box
  48  * representing the viewport onto the alignment.
  49  *
  50  * @author $author$
  51  * @version $Revision$
  52  */
  53 public class OverviewPanel extends JPanel implements Runnable,
  54         ViewportListenerI
  55 {
  56   private OverviewDimensions od;
  57
  58   private OverviewCanvas oviewCanvas;
  59
  60   private AlignViewport av;
  61
  62   private AlignmentPanel ap;
  63
  64   private JCheckBoxMenuItem displayToggle;
  65
  66   private boolean showHidden = true;
  67
  68   /**
  69    * Creates a new OverviewPanel object.
  70    *
  71    * @param alPanel
  72    *          The alignment panel which is shown in the overview panel
  73    */
  74   public OverviewPanel(AlignmentPanel alPanel)
  75   {
  76     this.av = alPanel.av;
  77     this.ap = alPanel;
  78
  79     od = new OverviewDimensionsShowHidden(av.getRanges(),
  80             (av.isShowAnnotation() && av
  81                     .getAlignmentConservationAnnotation() != null));
  82
  83     setSize(od.getWidth(), od.getHeight());
  84
  85     oviewCanvas = new OverviewCanvas(od, av);
  86     setLayout(new BorderLayout());
  87     add(oviewCanvas, BorderLayout.CENTER);
  88
  89     av.getRanges().addPropertyChangeListener(this);
  90
  91     addComponentListener(new ComponentAdapter()
  92     {
  93       @Override
  94       public void componentResized(ComponentEvent evt)
  95       {
  96         if ((getWidth() != od.getWidth())
  97                 || (getHeight() != (od.getHeight())))
  98         {
  99           updateOverviewImage();
 100           setBoxPosition();
 101         }
 102       }
 103     });
 104
 105     addMouseMotionListener(new MouseMotionAdapter()
 106     {
 107       @Override
 108       public void mouseDragged(MouseEvent evt)
 109       {
 110         if (!SwingUtilities.isRightMouseButton(evt))
 111         {
 112           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
 113                   .getAlignment().getHiddenSequences(), av.getAlignment()
 114                   .getHiddenColumns());
 115         }
 116       }
 117     });
 118
 119     addMouseListener(new MouseAdapter()
 120     {
 121       @Override
 122       public void mousePressed(MouseEvent evt)
 123       {
 124         if (SwingUtilities.isRightMouseButton(evt))
 125         {
 126           if (!Platform.isAMac())
 127           {
 128             showPopupMenu(evt);
 129           }
 130         }
 131         else
 132         // if (!av.getWrapAlignment())
 133         {
 134           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
 135                   .getAlignment().getHiddenSequences(), av.getAlignment()
 136                   .getHiddenColumns());
 137         }
 138       }
 139
 140       @Override
 141       public void mouseClicked(MouseEvent evt)
 142       {
 143         if (SwingUtilities.isRightMouseButton(evt))
 144         {
 145           showPopupMenu(evt);
 146         }
 147       }
 148     });
 149
 150     updateOverviewImage();
 151   }
 152
 153   /*
 154    * Displays the popup menu and acts on user input
 155    */
 156   private void showPopupMenu(MouseEvent e)
 157   {
 158     JPopupMenu popup = new JPopupMenu();
 159     ActionListener menuListener = new ActionListener()
 160     {
 161       @Override
 162       public void actionPerformed(ActionEvent event)
 163       {
 164         // switch on/off the hidden columns view
 165         toggleHiddenColumns();
 166         displayToggle.setSelected(showHidden);
 167       }
 168     };
 169     displayToggle = new JCheckBoxMenuItem(
 170             MessageManager.getString("label.togglehidden"));
 171     displayToggle.setEnabled(true);
 172     displayToggle.setSelected(showHidden);
 173     popup.add(displayToggle);
 174     displayToggle.addActionListener(menuListener);
 175     popup.show(this, e.getX(), e.getY());
 176   }
 177
 178   /*
 179    * Toggle overview display between showing hidden columns and hiding hidden columns
 180    */
 181   private void toggleHiddenColumns()
 182   {
 183     if (showHidden)
 184     {
 185       showHidden = false;
 186       od = new OverviewDimensionsHideHidden(av.getRanges(),
 187               (av.isShowAnnotation() && av
 188                       .getAlignmentConservationAnnotation() != null));
 189     }
 190     else
 191     {
 192       showHidden = true;
 193       od = new OverviewDimensionsShowHidden(av.getRanges(),
 194               (av.isShowAnnotation() && av
 195                       .getAlignmentConservationAnnotation() != null));
 196     }
 197     oviewCanvas.resetOviewDims(od);
 198     updateOverviewImage();
 199     setBoxPosition();
 200   }
 201
 202   /**
 203    * Updates the overview image when the related alignment panel is updated
 204    */
 205   public void updateOverviewImage()
 206   {
 207     if (oviewCanvas == null)
 208     {
 209       /*
 210        * panel has been disposed
 211        */
 212       return;
 213     }
 214
 215     if ((getWidth() > 0) && (getHeight() > 0))
 216     {
 217       od.setWidth(getWidth());
 218       od.setHeight(getHeight());
 219     }
 220
 221     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 222
 223     if (oviewCanvas.restartDraw())
 224     {
 225       return;
 226     }
 227
 228     Thread thread = new Thread(this);
 229     thread.start();
 230     repaint();
 231   }
 232
 233   @Override
 234   public void run()
 235   {
 236     oviewCanvas.draw(av.isShowSequenceFeatures(),
 237             (av.isShowAnnotation() && av
 238                     .getAlignmentConservationAnnotation() != null), ap
 239                     .getSeqPanel().seqCanvas.getFeatureRenderer());
 240     setBoxPosition();
 241   }
 242
 243   /**
 244    * Update the overview panel box when the associated alignment panel is
 245    * changed
 246    *
 247    */
 248   private void setBoxPosition()
 249   {
 250     od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
 251             .getAlignment().getHiddenColumns());
 252     repaint();
 253   }
 254
 255   @Override
 256   public void propertyChange(PropertyChangeEvent evt)
 257   {
 258     setBoxPosition();
 259   }
 260
 261   /**
 262    * Removes this object as a property change listener, and nulls references
 263    */
 264   protected void dispose()
 265   {
 266     try
 267     {
 268       av.getRanges().removePropertyChangeListener(this);
 269     } finally
 270     {
 271       av = null;
 272       oviewCanvas = null;
 273       ap = null;
 274       od = null;
 275     }
 276   }
 277 }