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"));
92 this.add(progressPanel, BorderLayout.SOUTH);
93 oviewCanvas = new OverviewCanvas(od, av, progressPanel);
95 add(oviewCanvas, BorderLayout.CENTER);
97 av.getRanges().addPropertyChangeListener(this);
99 addComponentListener(new ComponentAdapter()
102 public void componentResized(ComponentEvent evt)
104 updateOverviewImage();
109 addMouseMotionListener(new MouseMotionAdapter()
112 public void mouseDragged(MouseEvent evt)
114 if (!SwingUtilities.isRightMouseButton(evt))
118 // set the mouse position as a fixed point in the box
119 // and drag relative to that position
120 od.adjustViewportFromMouse(evt.getX(),
121 evt.getY(), av.getAlignment().getHiddenSequences(),
122 av.getAlignment().getHiddenColumns());
126 od.updateViewportFromMouse(evt.getX(), evt.getY(), av
127 .getAlignment().getHiddenSequences(), av.getAlignment()
128 .getHiddenColumns());
134 public void mouseMoved(MouseEvent evt)
136 if (od.isPositionInBox(evt.getX(), evt.getY()))
138 // display drag cursor at mouse position
139 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
144 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
149 addMouseListener(new MouseAdapter()
152 public void mousePressed(MouseEvent evt)
154 if (SwingUtilities.isRightMouseButton(evt))
156 if (!Platform.isAMac())
162 // if (!av.getWrapAlignment())
164 if (!od.isPositionInBox(evt.getX(), evt.getY()))
166 // don't do anything if the mouse press is in the overview's box
167 // (wait to see if it's a drag instead)
168 // otherwise update the viewport
169 od.updateViewportFromMouse(evt.getX(), evt.getY(),
170 av.getAlignment().getHiddenSequences(),
171 av.getAlignment().getHiddenColumns());
176 od.setDragPoint(evt.getX(), evt.getY(),
177 av.getAlignment().getHiddenSequences(),
178 av.getAlignment().getHiddenColumns());
184 public void mouseReleased(MouseEvent evt)
193 public void mouseClicked(MouseEvent evt)
195 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 (oviewCanvas == null)
262 * panel has been disposed
267 if ((getWidth() > 0) && (getHeight() > 0))
269 od.setWidth(getWidth());
270 od.setHeight(getHeight() - progressPanel.getHeight());
273 setPreferredSize(new Dimension(od.getWidth(),
276 if (oviewCanvas.restartDraw())
281 Thread thread = new Thread(this);
291 oviewCanvas.draw(av.isShowSequenceFeatures(),
292 (av.isShowAnnotation() && av
293 .getAlignmentConservationAnnotation() != null), ap
294 .getSeqPanel().seqCanvas.getFeatureRenderer());
299 * Update the overview panel box when the associated alignment panel is
303 private void setBoxPosition()
305 od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
306 .getAlignment().getHiddenColumns());
311 public void propertyChange(PropertyChangeEvent evt)
317 * Removes this object as a property change listener, and nulls references
319 protected void dispose()
323 av.getRanges().removePropertyChangeListener(this);
326 progressPanel = null;