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.bin.Cache;
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
56 implements Runnable, ViewportListenerI
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;
73 * Creates a new OverviewPanel object.
76 * The alignment panel which is shown in the overview panel
78 public OverviewPanel(AlignmentPanel alPanel)
83 showHidden = Cache.getDefault("SHOW_OV_HIDDEN_AT_START", true);
86 od = new OverviewDimensionsShowHidden(av.getRanges(),
87 (av.isShowAnnotation()
88 && av.getAlignmentConservationAnnotation() != null));
92 od = new OverviewDimensionsHideHidden(av.getRanges(),
93 (av.isShowAnnotation()
94 && av.getAlignmentConservationAnnotation() != null));
97 setSize(od.getWidth(), od.getHeight());
99 oviewCanvas = new OverviewCanvas(od, av);
100 setLayout(new BorderLayout());
101 add(oviewCanvas, BorderLayout.CENTER);
103 av.getRanges().addPropertyChangeListener(this);
105 addComponentListener(new ComponentAdapter()
108 public void componentResized(ComponentEvent evt)
110 if ((getWidth() != od.getWidth())
111 || (getHeight() != (od.getHeight())))
113 updateOverviewImage();
119 addMouseMotionListener(new MouseMotionAdapter()
122 public void mouseDragged(MouseEvent evt)
124 if (!SwingUtilities.isRightMouseButton(evt))
128 // set the mouse position as a fixed point in the box
129 // and drag relative to that position
130 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
131 av.getAlignment().getHiddenSequences(),
132 av.getAlignment().getHiddenColumns());
136 od.updateViewportFromMouse(evt.getX(), evt.getY(),
137 av.getAlignment().getHiddenSequences(),
138 av.getAlignment().getHiddenColumns());
144 public void mouseMoved(MouseEvent evt)
146 if (od.isPositionInBox(evt.getX(), evt.getY()))
148 // display drag cursor at mouse position
149 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
154 setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
159 addMouseListener(new MouseAdapter()
162 public void mousePressed(MouseEvent evt)
164 if (SwingUtilities.isRightMouseButton(evt))
166 if (!Platform.isAMac())
173 if (!od.isPositionInBox(evt.getX(), evt.getY()))
175 // don't do anything if the mouse press is in the overview's box
176 // (wait to see if it's a drag instead)
177 // otherwise update the viewport
178 od.updateViewportFromMouse(evt.getX(), evt.getY(),
179 av.getAlignment().getHiddenSequences(),
180 av.getAlignment().getHiddenColumns());
185 od.setDragPoint(evt.getX(), evt.getY(),
186 av.getAlignment().getHiddenSequences(),
187 av.getAlignment().getHiddenColumns());
193 public void mouseReleased(MouseEvent evt)
202 public void mouseClicked(MouseEvent evt)
204 if (SwingUtilities.isRightMouseButton(evt))
211 updateOverviewImage();
215 * Displays the popup menu and acts on user input
217 private void showPopupMenu(MouseEvent e)
219 JPopupMenu popup = new JPopupMenu();
220 ActionListener menuListener = new ActionListener()
223 public void actionPerformed(ActionEvent event)
225 // switch on/off the hidden columns view
226 toggleHiddenColumns();
227 displayToggle.setSelected(showHidden);
230 displayToggle = new JCheckBoxMenuItem(
231 MessageManager.getString("label.togglehidden"));
232 displayToggle.setEnabled(true);
233 displayToggle.setSelected(showHidden);
234 popup.add(displayToggle);
235 displayToggle.addActionListener(menuListener);
236 popup.show(this, e.getX(), e.getY());
240 * Toggle overview display between showing hidden columns and hiding hidden columns
242 private void toggleHiddenColumns()
247 od = new OverviewDimensionsHideHidden(av.getRanges(),
248 (av.isShowAnnotation()
249 && av.getAlignmentConservationAnnotation() != null));
254 od = new OverviewDimensionsShowHidden(av.getRanges(),
255 (av.isShowAnnotation()
256 && av.getAlignmentConservationAnnotation() != null));
258 oviewCanvas.resetOviewDims(od);
259 updateOverviewImage();
264 * Updates the overview image when the related alignment panel is updated
266 public void updateOverviewImage()
268 if (oviewCanvas == null)
271 * panel has been disposed
276 if ((getWidth() > 0) && (getHeight() > 0))
278 od.setWidth(getWidth());
279 od.setHeight(getHeight());
282 setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
284 if (oviewCanvas.restartDraw())
289 Thread thread = new Thread(this);
297 oviewCanvas.draw(av.isShowSequenceFeatures(),
298 (av.isShowAnnotation()
299 && av.getAlignmentConservationAnnotation() != null),
300 ap.getSeqPanel().seqCanvas.getFeatureRenderer());
305 * Update the overview panel box when the associated alignment panel is
309 private void setBoxPosition()
311 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
312 av.getAlignment().getHiddenColumns());
317 public void propertyChange(PropertyChangeEvent evt)
323 * Removes this object as a property change listener, and nulls references
325 protected void dispose()
329 av.getRanges().removePropertyChangeListener(this);