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.
21 package jalview.appletgui;
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.CheckboxMenuItem;
32 import java.awt.Cursor;
33 import java.awt.Dimension;
34 import java.awt.Frame;
35 import java.awt.Panel;
36 import java.awt.PopupMenu;
37 import java.awt.event.ComponentAdapter;
38 import java.awt.event.ComponentEvent;
39 import java.awt.event.InputEvent;
40 import java.awt.event.ItemEvent;
41 import java.awt.event.ItemListener;
42 import java.awt.event.MouseEvent;
43 import java.awt.event.MouseListener;
44 import java.awt.event.MouseMotionListener;
45 import java.beans.PropertyChangeEvent;
47 import javax.swing.SwingUtilities;
49 public class OverviewPanel extends Panel implements Runnable,
50 MouseMotionListener, MouseListener, ViewportListenerI
52 private OverviewDimensions od;
54 private OverviewCanvas oviewCanvas;
56 private AlignViewport av;
58 private AlignmentPanel ap;
60 private boolean showHidden = true;
62 private boolean updateRunning = false;
64 private boolean draggingBox = false;
66 public OverviewPanel(AlignmentPanel alPanel)
72 od = new OverviewDimensionsShowHidden(av.getRanges(),
73 (av.isShowAnnotation()
74 && av.getSequenceConsensusHash() != null));
76 oviewCanvas = new OverviewCanvas(od, av);
77 setLayout(new BorderLayout());
78 add(oviewCanvas, BorderLayout.CENTER);
80 setSize(new Dimension(od.getWidth(), od.getHeight()));
82 av.getRanges().addPropertyChangeListener(this);
84 addComponentListener(new ComponentAdapter()
88 public void componentResized(ComponentEvent evt)
90 if ((getWidth() != od.getWidth())
91 || (getHeight() != (od.getHeight())))
93 updateOverviewImage();
98 addMouseMotionListener(this);
100 addMouseListener(this);
102 updateOverviewImage();
107 public void mouseEntered(MouseEvent evt)
112 public void mouseExited(MouseEvent evt)
117 public void mouseClicked(MouseEvent evt)
119 if ((evt.getModifiersEx()
120 & InputEvent.BUTTON3_DOWN_MASK) == InputEvent.BUTTON3_DOWN_MASK)
127 public void mouseMoved(MouseEvent evt)
129 if (od.isPositionInBox(evt.getX(), evt.getY()))
132 .setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
136 this.getParent().setCursor(
137 Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
142 public void mousePressed(MouseEvent evt)
144 if ((evt.getModifiersEx()
145 & InputEvent.BUTTON3_DOWN_MASK) == InputEvent.BUTTON3_DOWN_MASK)
147 if (!Platform.isMac()) // BH was excluding JavaScript
154 // don't do anything if the mouse press is in the overview's box
155 // (wait to see if it's a drag instead)
156 // otherwise update the viewport
157 if (!od.isPositionInBox(evt.getX(), evt.getY()))
161 // display drag cursor at mouse position
162 setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
164 od.updateViewportFromMouse(evt.getX(), evt.getY(),
165 av.getAlignment().getHiddenSequences(),
166 av.getAlignment().getHiddenColumns());
168 .setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
173 od.setDragPoint(evt.getX(), evt.getY(),
174 av.getAlignment().getHiddenSequences(),
175 av.getAlignment().getHiddenColumns());
181 public void mouseReleased(MouseEvent evt)
187 public void mouseDragged(MouseEvent evt)
189 if (Platform.isWinRightButton(evt))
195 if (SwingUtilities.isRightMouseButton(evt))
202 // set the mouse position as a fixed point in the box
203 // and drag relative to that position
204 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
205 av.getAlignment().getHiddenSequences(),
206 av.getAlignment().getHiddenColumns());
210 od.updateViewportFromMouse(evt.getX(), evt.getY(),
211 av.getAlignment().getHiddenSequences(),
212 av.getAlignment().getHiddenColumns());
214 ap.paintAlignment(false, false);
218 * Updates the overview image when the related alignment panel is updated
220 public void updateOverviewImage()
222 if (oviewCanvas == null)
225 * panel has been disposed
230 if ((getSize().width > 0) && (getSize().height > 0))
232 od.setWidth(getSize().width);
233 od.setHeight(getSize().height);
235 setSize(new Dimension(od.getWidth(), od.getHeight()));
241 oviewCanvas.restartDraw();
245 updateRunning = true;
247 Thread thread = new Thread(this);
250 updateRunning = false;
256 oviewCanvas.draw(av.isShowSequenceFeatures(),
257 (av.isShowAnnotation()
258 && av.getAlignmentConservationAnnotation() != null),
259 ap.seqPanel.seqCanvas.getFeatureRenderer());
264 * Update the overview panel box when the associated alignment panel is
268 private void setBoxPosition()
270 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
271 av.getAlignment().getHiddenColumns());
276 * Displays the popup menu and acts on user input
278 private void showPopupMenu(MouseEvent e)
280 PopupMenu popup = new PopupMenu();
281 ItemListener menuListener = new ItemListener()
284 public void itemStateChanged(ItemEvent e)
286 toggleHiddenColumns();
289 CheckboxMenuItem item = new CheckboxMenuItem(
290 MessageManager.getString("label.togglehidden"));
291 item.setState(showHidden);
293 item.addItemListener(menuListener);
295 popup.show(this, e.getX(), e.getY());
299 public void propertyChange(PropertyChangeEvent evt)
305 * Toggle overview display between showing hidden columns and hiding hidden columns
307 private void toggleHiddenColumns()
312 od = new OverviewDimensionsHideHidden(av.getRanges(),
313 (av.isShowAnnotation()
314 && av.getAlignmentConservationAnnotation() != null));
319 od = new OverviewDimensionsShowHidden(av.getRanges(),
320 (av.isShowAnnotation()
321 && av.getAlignmentConservationAnnotation() != null));
323 oviewCanvas.resetOviewDims(od);
324 updateOverviewImage();
328 * Removes this object as a property change listener, and nulls references
330 protected void dispose()
334 av.getRanges().removePropertyChangeListener(this);
335 Frame parent = (Frame) getParent();
337 parent.setVisible(false);
341 if (oviewCanvas != null)
343 oviewCanvas.dispose();