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.renderer.OverviewRenderer;
24 import jalview.util.MessageManager;
25 import jalview.util.Platform;
26 import jalview.viewmodel.OverviewDimensions;
27 import jalview.viewmodel.OverviewDimensionsHideHidden;
28 import jalview.viewmodel.OverviewDimensionsShowHidden;
29 import jalview.viewmodel.ViewportListenerI;
31 import java.awt.BorderLayout;
32 import java.awt.Cursor;
33 import java.awt.Dimension;
34 import java.awt.event.ActionEvent;
35 import java.awt.event.ActionListener;
36 import java.awt.event.ComponentAdapter;
37 import java.awt.event.ComponentEvent;
38 import java.awt.event.MouseAdapter;
39 import java.awt.event.MouseEvent;
40 import java.awt.event.MouseMotionAdapter;
41 import java.beans.PropertyChangeEvent;
43 import javax.swing.JCheckBoxMenuItem;
44 import javax.swing.JPanel;
45 import javax.swing.JPopupMenu;
46 import javax.swing.SwingUtilities;
49 * Panel displaying an overview of the full alignment, with an interactive box
50 * representing the viewport onto the alignment.
55 public class OverviewPanel extends JPanel implements Runnable,
58 private OverviewDimensions od;
60 private OverviewCanvas oviewCanvas;
62 private AlignViewport av;
64 private AlignmentPanel ap;
66 private JCheckBoxMenuItem displayToggle;
68 private boolean showHidden = true;
70 private boolean draggingBox = false;
72 private ProgressPanel progressPanel;
75 * Creates a new OverviewPanel object.
78 * The alignment panel which is shown in the overview panel
80 public OverviewPanel(AlignmentPanel alPanel)
85 od = new OverviewDimensionsShowHidden(av.getRanges(),
86 (av.isShowAnnotation() && av
87 .getAlignmentConservationAnnotation() != null));
89 // setSize(od.getWidth(), od.getHeight() + 20);
91 setLayout(new BorderLayout());
92 progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
93 MessageManager.getString("label.oview_calc"));
94 this.add(progressPanel, BorderLayout.SOUTH);
95 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
97 add(oviewCanvas, BorderLayout.CENTER);
99 av.getRanges().addPropertyChangeListener(this);
101 addComponentListener(new ComponentAdapter()
104 public void componentResized(ComponentEvent evt)
106 updateOverviewImage();
111 addMouseMotionListener(new MouseMotionAdapter()
114 public void mouseDragged(MouseEvent evt)
116 if (!SwingUtilities.isRightMouseButton(evt))
120 // set the mouse position as a fixed point in the box
121 // and drag relative to that position
122 od.adjustViewportFromMouse(evt.getX(),
123 evt.getY(), av.getAlignment().getHiddenSequences(),
124 av.getAlignment().getHiddenColumns());
128 od.updateViewportFromMouse(evt.getX(), evt.getY(), av
129 .getAlignment().getHiddenSequences(), av.getAlignment()
130 .getHiddenColumns());
136 public void mouseMoved(MouseEvent evt)
138 if (od.isPositionInBox(evt.getX(), evt.getY()))
140 // display drag cursor at mouse position
141 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
146 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
151 addMouseListener(new MouseAdapter()
154 public void mousePressed(MouseEvent evt)
156 if (SwingUtilities.isRightMouseButton(evt))
158 if (!Platform.isAMac())
165 if (!od.isPositionInBox(evt.getX(), evt.getY()))
167 // don't do anything if the mouse press is in the overview's box
168 // (wait to see if it's a drag instead)
169 // otherwise update the viewport
170 od.updateViewportFromMouse(evt.getX(), evt.getY(),
171 av.getAlignment().getHiddenSequences(),
172 av.getAlignment().getHiddenColumns());
177 od.setDragPoint(evt.getX(), evt.getY(),
178 av.getAlignment().getHiddenSequences(),
179 av.getAlignment().getHiddenColumns());
185 public void mouseReleased(MouseEvent evt)
194 public void mouseClicked(MouseEvent evt)
196 if (SwingUtilities.isRightMouseButton(evt))
203 setPreferredSize(new Dimension(od.getWidth(),
208 * Displays the popup menu and acts on user input
210 private void showPopupMenu(MouseEvent e)
212 JPopupMenu popup = new JPopupMenu();
213 ActionListener menuListener = new ActionListener()
216 public void actionPerformed(ActionEvent event)
218 // switch on/off the hidden columns view
219 toggleHiddenColumns();
220 displayToggle.setSelected(showHidden);
223 displayToggle = new JCheckBoxMenuItem(
224 MessageManager.getString("label.togglehidden"));
225 displayToggle.setEnabled(true);
226 displayToggle.setSelected(showHidden);
227 popup.add(displayToggle);
228 displayToggle.addActionListener(menuListener);
229 popup.show(this, e.getX(), e.getY());
233 * Toggle overview display between showing hidden columns and hiding hidden columns
235 private void toggleHiddenColumns()
240 od = new OverviewDimensionsHideHidden(av.getRanges(),
241 (av.isShowAnnotation() && av
242 .getAlignmentConservationAnnotation() != null));
247 od = new OverviewDimensionsShowHidden(av.getRanges(),
248 (av.isShowAnnotation() && av
249 .getAlignmentConservationAnnotation() != null));
251 oviewCanvas.resetOviewDims(od);
252 updateOverviewImage();
257 * Updates the overview image when the related alignment panel is updated
259 public void updateOverviewImage()
261 if (oviewCanvas == null)
264 * panel has been disposed
269 if ((getWidth() > 0) && (getHeight() > 0))
271 od.setWidth(getWidth());
272 od.setHeight(getHeight() - progressPanel.getHeight());
275 setPreferredSize(new Dimension(od.getWidth(),
276 od.getHeight() + progressPanel.getHeight()));
278 if (oviewCanvas.restartDraw())
283 Thread thread = new Thread(this);
293 oviewCanvas.draw(av.isShowSequenceFeatures(),
294 (av.isShowAnnotation() && av
295 .getAlignmentConservationAnnotation() != null), ap
296 .getSeqPanel().seqCanvas.getFeatureRenderer());
301 * Update the overview panel box when the associated alignment panel is
305 private void setBoxPosition()
307 od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
308 .getAlignment().getHiddenColumns());
313 public void propertyChange(PropertyChangeEvent evt)
319 * Removes this object as a property change listener, and nulls references
321 protected void dispose()
325 av.getRanges().removePropertyChangeListener(this);
328 progressPanel = null;