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