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         updateOverviewImage();
  97       }
  98     });
  99
 100     addMouseMotionListener(new MouseMotionAdapter()
 101     {
 102       @Override
 103       public void mouseDragged(MouseEvent evt)
 104       {
 105         if (!SwingUtilities.isRightMouseButton(evt)
 106                 && !av.getWrapAlignment())
 107         {
 108           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
 109                   .getAlignment().getHiddenSequences(), av.getAlignment()
 110                   .getHiddenColumns());
 111
 112         }
 113       }
 114     });
 115
 116     addMouseListener(new MouseAdapter()
 117     {
 118       @Override
 119       public void mousePressed(MouseEvent evt)
 120       {
 121         if (SwingUtilities.isRightMouseButton(evt))
 122         {
 123           if (!Platform.isAMac())
 124           {
 125             showPopupMenu(evt);
 126           }
 127         }
 128         else if (!av.getWrapAlignment())
 129         {
 130           od.updateViewportFromMouse(evt.getX(), evt.getY(), av
 131                   .getAlignment().getHiddenSequences(), av.getAlignment()
 132                   .getHiddenColumns());
 133         }
 134       }
 135
 136       @Override
 137       public void mouseClicked(MouseEvent evt)
 138       {
 139         if (SwingUtilities.isRightMouseButton(evt))
 140         {
 141           showPopupMenu(evt);
 142         }
 143       }
 144     });
 145
 146
 147     updateOverviewImage();
 148   }
 149
 150   /*
 151    * Displays the popup menu and acts on user input
 152    */
 153   private void showPopupMenu(MouseEvent e)
 154   {
 155     JPopupMenu popup = new JPopupMenu();
 156     ActionListener menuListener = new ActionListener()
 157     {
 158       @Override
 159       public void actionPerformed(ActionEvent event)
 160       {
 161         // switch on/off the hidden columns view
 162         toggleHiddenColumns();
 163         displayToggle.setSelected(showHidden);
 164       }
 165     };
 166     displayToggle = new JCheckBoxMenuItem(
 167             MessageManager.getString("label.togglehidden"));
 168     displayToggle.setEnabled(true);
 169     displayToggle.setSelected(showHidden);
 170     popup.add(displayToggle);
 171     displayToggle.addActionListener(menuListener);
 172     popup.show(this, e.getX(), e.getY());
 173   }
 174
 175   /*
 176    * Toggle overview display between showing hidden columns and hiding hidden columns
 177    */
 178   private void toggleHiddenColumns()
 179   {
 180     if (showHidden)
 181     {
 182       showHidden = false;
 183       od = new OverviewDimensionsHideHidden(av.getRanges(),
 184               (av.isShowAnnotation() && av
 185                       .getAlignmentConservationAnnotation() != null));
 186     }
 187     else
 188     {
 189       showHidden = true;
 190       od = new OverviewDimensionsShowHidden(av.getRanges(),
 191               (av.isShowAnnotation() && av
 192                       .getAlignmentConservationAnnotation() != null));
 193     }
 194     oviewCanvas.resetOviewDims(od);
 195     updateOverviewImage();
 196     setBoxPosition();
 197   }
 198
 199   /**
 200    * Updates the overview image when the related alignment panel is updated
 201    */
 202   public void updateOverviewImage()
 203   {
 204     if ((getWidth() > 0) && (getHeight() > 0))
 205     {
 206       od.setWidth(getWidth());
 207       od.setHeight(getHeight());
 208     }
 209
 210     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
 211
 212     if (oviewCanvas.restartDraw())
 213     {
 214       return;
 215     }
 216
 217     Thread thread = new Thread(this);
 218     thread.start();
 219     repaint();
 220
 221   }
 222
 223   @Override
 224   public void run()
 225   {
 226     oviewCanvas.draw(av.isShowSequenceFeatures(),
 227             (av.isShowAnnotation() && av
 228                     .getAlignmentConservationAnnotation() != null), ap
 229                     .getSeqPanel().seqCanvas.getFeatureRenderer());
 230     setBoxPosition();
 231   }
 232
 233   /**
 234    * Update the overview panel box when the associated alignment panel is
 235    * changed
 236    *
 237    */
 238   private void setBoxPosition()
 239   {
 240     od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
 241             .getAlignment().getHiddenColumns());
 242     repaint();
 243   }
 244
 245   @Override
 246   public void propertyChange(PropertyChangeEvent evt)
 247   {
 248     setBoxPosition();
 249   }
 250 }