2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
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;
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;
41 import javax.swing.JCheckBoxMenuItem;
42 import javax.swing.JPanel;
43 import javax.swing.JPopupMenu;
44 import javax.swing.SwingUtilities;
47 * Panel displaying an overview of the full alignment, with an interactive box
48 * representing the viewport onto the alignment.
53 public class OverviewPanel extends JPanel implements Runnable,
56 private OverviewDimensions od;
58 private OverviewCanvas oviewCanvas;
60 private AlignViewport av;
62 private AlignmentPanel ap;
64 private JCheckBoxMenuItem displayToggle;
66 private boolean showHidden = true;
68 private boolean draggingBox = false;
71 * Creates a new OverviewPanel object.
74 * The alignment panel which is shown in the overview panel
76 public OverviewPanel(AlignmentPanel alPanel)
81 od = new OverviewDimensionsShowHidden(av.getRanges(),
82 (av.isShowAnnotation() && av
83 .getAlignmentConservationAnnotation() != null));
85 setSize(od.getWidth(), od.getHeight());
87 oviewCanvas = new OverviewCanvas(od, av);
88 setLayout(new BorderLayout());
89 add(oviewCanvas, BorderLayout.CENTER);
91 av.getRanges().addPropertyChangeListener(this);
93 addComponentListener(new ComponentAdapter()
96 public void componentResized(ComponentEvent evt)
98 if ((getWidth() != od.getWidth())
99 || (getHeight() != (od.getHeight())))
101 updateOverviewImage();
107 addMouseMotionListener(new MouseMotionAdapter()
110 public void mouseDragged(MouseEvent evt)
112 if (!SwingUtilities.isRightMouseButton(evt)
113 && !av.getWrapAlignment())
117 od.adjustViewportFromMouse(evt.getX(),
118 evt.getY(), av.getAlignment().getHiddenSequences(),
119 av.getAlignment().getHiddenColumns());
123 od.updateViewportFromMouse(evt.getX(), evt.getY(), av
124 .getAlignment().getHiddenSequences(), av.getAlignment()
125 .getHiddenColumns());
132 public void mouseMoved(MouseEvent evt)
134 if (od.isPositionInBox(evt.getX(), evt.getY()))
136 // display drag cursor at mouse position
147 addMouseListener(new MouseAdapter()
150 public void mousePressed(MouseEvent evt)
152 if (SwingUtilities.isRightMouseButton(evt))
154 if (!Platform.isAMac())
159 else if (!av.getWrapAlignment())
161 if (!od.isPositionInBox(evt.getX(), evt.getY()))
163 // don't do anything if the mouse press is in the overview's box
164 // (wait to see if it's a drag instead)
165 // otherwise update the viewport
166 od.updateViewportFromMouse(evt.getX(), evt.getY(),
167 av.getAlignment().getHiddenSequences(),
168 av.getAlignment().getHiddenColumns());
173 od.setDragPoint(evt.getX(), evt.getY(),
174 av.getAlignment().getHiddenSequences(),
175 av.getAlignment().getHiddenColumns());
181 public void mouseReleased(MouseEvent evt)
190 public void mouseClicked(MouseEvent evt)
192 if (SwingUtilities.isRightMouseButton(evt))
202 updateOverviewImage();
206 * Displays the popup menu and acts on user input
208 private void showPopupMenu(MouseEvent e)
210 JPopupMenu popup = new JPopupMenu();
211 ActionListener menuListener = new ActionListener()
214 public void actionPerformed(ActionEvent event)
216 // switch on/off the hidden columns view
217 toggleHiddenColumns();
218 displayToggle.setSelected(showHidden);
221 displayToggle = new JCheckBoxMenuItem(
222 MessageManager.getString("label.togglehidden"));
223 displayToggle.setEnabled(true);
224 displayToggle.setSelected(showHidden);
225 popup.add(displayToggle);
226 displayToggle.addActionListener(menuListener);
227 popup.show(this, e.getX(), e.getY());
231 * Toggle overview display between showing hidden columns and hiding hidden columns
233 private void toggleHiddenColumns()
238 od = new OverviewDimensionsHideHidden(av.getRanges(),
239 (av.isShowAnnotation() && av
240 .getAlignmentConservationAnnotation() != null));
245 od = new OverviewDimensionsShowHidden(av.getRanges(),
246 (av.isShowAnnotation() && av
247 .getAlignmentConservationAnnotation() != null));
249 oviewCanvas.resetOviewDims(od);
250 updateOverviewImage();
255 * Updates the overview image when the related alignment panel is updated
257 public void updateOverviewImage()
259 if ((getWidth() > 0) && (getHeight() > 0))
261 od.setWidth(getWidth());
262 od.setHeight(getHeight());
265 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
267 if (oviewCanvas.restartDraw())
272 Thread thread = new Thread(this);
281 oviewCanvas.draw(av.isShowSequenceFeatures(),
282 (av.isShowAnnotation() && av
283 .getAlignmentConservationAnnotation() != null), ap
284 .getSeqPanel().seqCanvas.getFeatureRenderer());
289 * Update the overview panel box when the associated alignment panel is
293 private void setBoxPosition()
295 od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
296 .getAlignment().getHiddenColumns());
301 public void propertyChange(PropertyChangeEvent evt)