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 setLayout(new BorderLayout());
90 progressPanel = new ProgressPanel(OverviewRenderer.UPDATE,
91 MessageManager.getString("label.oview_calc"), getWidth());
92 this.add(progressPanel, BorderLayout.SOUTH);
93 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
95 add(oviewCanvas, BorderLayout.CENTER);
97 av.getRanges().addPropertyChangeListener(this);
99 // without this the overview window does not size to fit the overview canvas
100 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
102 addComponentListener(new ComponentAdapter()
105 public void componentResized(ComponentEvent evt)
107 // Resize is called on the initial display of the overview.
108 // This code adjusts sizes to account for the progress bar if it has not
109 // already been accounted for, which triggers another resize call for
110 // the correct sizing, at which point the overview image is updated.
111 // (This avoids a double recalculation of the image.)
112 if (getWidth() == od.getWidth() && getHeight() == od.getHeight()
113 + progressPanel.getHeight())
115 updateOverviewImage();
119 if ((getWidth() > 0) && (getHeight() > 0))
121 od.setWidth(getWidth());
122 od.setHeight(getHeight() - progressPanel.getHeight());
125 setPreferredSize(new Dimension(od.getWidth(),
126 od.getHeight() + progressPanel.getHeight()));
132 addMouseMotionListener(new MouseMotionAdapter()
135 public void mouseDragged(MouseEvent evt)
137 if (!SwingUtilities.isRightMouseButton(evt))
141 // set the mouse position as a fixed point in the box
142 // and drag relative to that position
143 od.adjustViewportFromMouse(evt.getX(),
144 evt.getY(), av.getAlignment().getHiddenSequences(),
145 av.getAlignment().getHiddenColumns());
149 od.updateViewportFromMouse(evt.getX(), evt.getY(), av
150 .getAlignment().getHiddenSequences(), av.getAlignment()
151 .getHiddenColumns());
157 public void mouseMoved(MouseEvent evt)
159 if (od.isPositionInBox(evt.getX(), evt.getY()))
161 // display drag cursor at mouse position
162 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
167 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
172 addMouseListener(new MouseAdapter()
175 public void mousePressed(MouseEvent evt)
177 if (SwingUtilities.isRightMouseButton(evt))
179 if (!Platform.isAMac())
186 if (!od.isPositionInBox(evt.getX(), evt.getY()))
188 // don't do anything if the mouse press is in the overview's box
189 // (wait to see if it's a drag instead)
190 // otherwise update the viewport
191 od.updateViewportFromMouse(evt.getX(), evt.getY(),
192 av.getAlignment().getHiddenSequences(),
193 av.getAlignment().getHiddenColumns());
198 od.setDragPoint(evt.getX(), evt.getY(),
199 av.getAlignment().getHiddenSequences(),
200 av.getAlignment().getHiddenColumns());
206 public void mouseReleased(MouseEvent evt)
215 public void mouseClicked(MouseEvent evt)
217 if (SwingUtilities.isRightMouseButton(evt))
226 * Displays the popup menu and acts on user input
228 private void showPopupMenu(MouseEvent e)
230 JPopupMenu popup = new JPopupMenu();
231 ActionListener menuListener = new ActionListener()
234 public void actionPerformed(ActionEvent event)
236 // switch on/off the hidden columns view
237 toggleHiddenColumns();
238 displayToggle.setSelected(showHidden);
241 displayToggle = new JCheckBoxMenuItem(
242 MessageManager.getString("label.togglehidden"));
243 displayToggle.setEnabled(true);
244 displayToggle.setSelected(showHidden);
245 popup.add(displayToggle);
246 displayToggle.addActionListener(menuListener);
247 popup.show(this, e.getX(), e.getY());
251 * Toggle overview display between showing hidden columns and hiding hidden columns
253 private void toggleHiddenColumns()
258 od = new OverviewDimensionsHideHidden(av.getRanges(),
259 (av.isShowAnnotation() && av
260 .getAlignmentConservationAnnotation() != null));
265 od = new OverviewDimensionsShowHidden(av.getRanges(),
266 (av.isShowAnnotation() && av
267 .getAlignmentConservationAnnotation() != null));
269 oviewCanvas.resetOviewDims(od);
270 updateOverviewImage();
275 * Updates the overview image when the related alignment panel is updated
277 public void updateOverviewImage()
279 if (oviewCanvas == null)
282 * panel has been disposed
287 if ((getWidth() > 0) && (getHeight() > 0))
289 od.setWidth(getWidth());
290 od.setHeight(getHeight() - progressPanel.getHeight());
293 setPreferredSize(new Dimension(od.getWidth(),
294 od.getHeight() + progressPanel.getHeight()));
296 if (oviewCanvas.restartDraw())
301 Thread thread = new Thread(this);
311 if (oviewCanvas != null)
313 oviewCanvas.draw(av.isShowSequenceFeatures(),
314 (av.isShowAnnotation()
315 && av.getAlignmentConservationAnnotation() != null),
316 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
322 * Update the overview panel box when the associated alignment panel is
326 private void setBoxPosition()
330 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
331 av.getAlignment().getHiddenColumns());
337 public void propertyChange(PropertyChangeEvent evt)
343 * Removes this object as a property change listener, and nulls references
345 protected void dispose()
349 av.getRanges().removePropertyChangeListener(this);
350 oviewCanvas.dispose();
353 progressPanel = null;