src/jalview/appletgui/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.appletgui;
  22
  23 import jalview.util.MessageManager;
  24 import jalview.util.Platform;
  25 import jalview.viewmodel.OverviewDimensions;
  26 import jalview.viewmodel.OverviewDimensionsAllVisible;
  27 import jalview.viewmodel.OverviewDimensionsWithHidden;
  28
  29 import java.awt.BorderLayout;
  30 import java.awt.Dimension;
  31 import java.awt.Panel;
  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.MouseEvent;
  37 import java.awt.event.MouseListener;
  38 import java.awt.event.MouseMotionListener;
  39
  40 import javax.swing.JMenuItem;
  41 import javax.swing.JPopupMenu;
  42 import javax.swing.SwingUtilities;
  43
  44 public class OverviewPanel extends Panel implements Runnable,
  45         MouseMotionListener, MouseListener
  46 {
  47   private OverviewDimensions od;
  48
  49   private OverviewCanvas oviewCanvas;
  50
  51   private AlignViewport av;
  52
  53   private AlignmentPanel ap;
  54
  55   private boolean showHidden = true;
  56
  57   private boolean updateRunning = false;
  58
  59   public OverviewPanel(AlignmentPanel alPanel)
  60   {
  61     this.av = alPanel.av;
  62     this.ap = alPanel;
  63     setLayout(null);
  64
  65     od = new OverviewDimensionsWithHidden(av.getRanges(),
  66             (av.isShowAnnotation() && av.getSequenceConsensusHash() != null));
  67
  68     oviewCanvas = new OverviewCanvas(od, av);
  69     setLayout(new BorderLayout());
  70     add(oviewCanvas, BorderLayout.CENTER);
  71
  72     setSize(new Dimension(od.getWidth(), od.getHeight()));
  73     addComponentListener(new ComponentAdapter()
  74     {
  75
  76       @Override
  77       public void componentResized(ComponentEvent evt)
  78       {
  79         if ((getWidth() != od.getWidth())
  80                 || (getHeight() != (od.getHeight())))
  81         {
  82           updateOverviewImage();
  83         }
  84       }
  85     });
  86
  87     addMouseMotionListener(this);
  88
  89     addMouseListener(this);
  90
  91     updateOverviewImage();
  92
  93   }
  94
  95   @Override
  96   public void mouseEntered(MouseEvent evt)
  97   {
  98   }
  99
 100   @Override
 101   public void mouseExited(MouseEvent evt)
 102   {
 103   }
 104
 105   @Override
 106   public void mouseClicked(MouseEvent evt)
 107   {
 108     if (SwingUtilities.isRightMouseButton(evt))
 109     {
 110       showPopupMenu(evt);
 111     }
 112   }
 113
 114   @Override
 115   public void mouseMoved(MouseEvent evt)
 116   {
 117   }
 118
 119   @Override
 120   public void mousePressed(MouseEvent evt)
 121   {
 122     mouseAction(evt);
 123   }
 124
 125   @Override
 126   public void mouseReleased(MouseEvent evt)
 127   {
 128     mouseAction(evt);
 129   }
 130
 131   @Override
 132   public void mouseDragged(MouseEvent evt)
 133   {
 134     mouseAction(evt);
 135   }
 136
 137   private void mouseAction(MouseEvent evt)
 138   {
 139     if (SwingUtilities.isRightMouseButton(evt))
 140     {
 141       if (!Platform.isAMac())
 142       {
 143         showPopupMenu(evt);
 144       }
 145     }
 146     else
 147     {
 148       od.updateViewportFromMouse(evt.getX(), evt.getY(), av.getAlignment()
 149               .getHiddenSequences(), av.getAlignment().getHiddenColumns());
 150       ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
 151       ap.paintAlignment(false);
 152     }
 153   }
 154
 155   /**
 156    * Updates the overview image when the related alignment panel is updated
 157    */
 158   public void updateOverviewImage()
 159   {
 160     if ((getSize().width > 0) && (getSize().height > 0))
 161     {
 162       od.setWidth(getSize().width);
 163       od.setHeight(getSize().height);
 164     }
 165     setSize(new Dimension(od.getWidth(), od.getHeight()));
 166
 167     synchronized (this)
 168     {
 169       if (updateRunning)
 170       {
 171         oviewCanvas.restartDraw();
 172         return;
 173       }
 174
 175       updateRunning = true;
 176     }
 177     Thread thread = new Thread(this);
 178     thread.start();
 179     repaint();
 180     updateRunning = false;
 181   }
 182
 183   @Override
 184   public void run()
 185   {
 186     oviewCanvas.draw(av.isShowSequenceFeatures(),
 187             (av.isShowAnnotation() && av
 188                     .getAlignmentConservationAnnotation() != null),
 189             ap.seqPanel.seqCanvas.getFeatureRenderer());
 190     setBoxPosition();
 191   }
 192
 193   /**
 194    * Update the overview panel box when the associated alignment panel is
 195    * changed
 196    *
 197    */
 198   public void setBoxPosition()
 199   {
 200     od.setBoxPosition(av.getAlignment()
 201 .getHiddenSequences(), av
 202             .getAlignment().getHiddenColumns());
 203     repaint();
 204   }
 205
 206   /*
 207    * Displays the popup menu and acts on user input
 208    */
 209   private void showPopupMenu(MouseEvent e)
 210   {
 211     JPopupMenu popup = new JPopupMenu();
 212     ActionListener menuListener = new ActionListener()
 213     {
 214       @Override
 215       public void actionPerformed(ActionEvent event)
 216       {
 217         // switch on/off the hidden columns view
 218         toggleHiddenColumns();
 219       }
 220     };
 221     JMenuItem item = new JMenuItem(
 222             MessageManager.getString("label.togglehidden"));
 223     popup.add(item);
 224     item.addActionListener(menuListener);
 225     popup.show(this, e.getX(), e.getY());
 226   }
 227
 228   /*
 229    * Toggle overview display between showing hidden columns and hiding hidden columns
 230    */
 231   private void toggleHiddenColumns()
 232   {
 233     if (showHidden)
 234     {
 235       showHidden = false;
 236       od = new OverviewDimensionsAllVisible(av.getRanges(),
 237               (av.isShowAnnotation() && av
 238                       .getAlignmentConservationAnnotation() != null));
 239     }
 240     else
 241     {
 242       showHidden = true;
 243       od = new OverviewDimensionsWithHidden(av.getRanges(),
 244               (av.isShowAnnotation() && av
 245                       .getAlignmentConservationAnnotation() != null));
 246     }
 247     oviewCanvas.resetOviewDims(od);
 248     updateOverviewImage();
 249   }
 250 }