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.Image;
36 import java.awt.Panel;
37 import java.awt.Point;
38 import java.awt.PopupMenu;
39 import java.awt.event.ComponentAdapter;
40 import java.awt.event.ComponentEvent;
41 import java.awt.event.InputEvent;
42 import java.awt.event.ItemEvent;
43 import java.awt.event.ItemListener;
44 import java.awt.event.MouseEvent;
45 import java.awt.event.MouseListener;
46 import java.awt.event.MouseMotionListener;
47 import java.beans.PropertyChangeEvent;
49 import javax.swing.ImageIcon;
51 public class OverviewPanel extends Panel implements Runnable,
52 MouseMotionListener, MouseListener, ViewportListenerI
54 protected Image dragImage = new ImageIcon(
55 getClass().getResource("/images/dragcursor.png")).getImage();
57 private OverviewDimensions od;
59 private OverviewCanvas oviewCanvas;
61 private AlignViewport av;
63 private AlignmentPanel ap;
65 private boolean showHidden = true;
67 private boolean updateRunning = false;
69 private boolean draggingBox = false;
71 private Cursor dragCursor;
73 public OverviewPanel(AlignmentPanel alPanel)
79 od = new OverviewDimensionsShowHidden(av.getRanges(),
80 (av.isShowAnnotation()
81 && av.getSequenceConsensusHash() != null));
83 oviewCanvas = new OverviewCanvas(od, av);
84 setLayout(new BorderLayout());
85 add(oviewCanvas, BorderLayout.CENTER);
87 setSize(new Dimension(od.getWidth(), od.getHeight()));
89 av.getRanges().addPropertyChangeListener(this);
91 // set up custom cursor for use on Mac...
92 Point hotSpot = new Point(16, 16);
93 String cursorName = "Custom drag cursor";
95 if (Platform.isAMac())
97 dragCursor = getToolkit().createCustomCursor(dragImage, hotSpot,
102 dragCursor = Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR);
105 addComponentListener(new ComponentAdapter()
109 public void componentResized(ComponentEvent evt)
111 if ((getWidth() != od.getWidth())
112 || (getHeight() != (od.getHeight())))
114 updateOverviewImage();
119 addMouseMotionListener(this);
121 addMouseListener(this);
123 updateOverviewImage();
128 public void mouseEntered(MouseEvent evt)
133 public void mouseExited(MouseEvent evt)
138 public void mouseClicked(MouseEvent evt)
140 if ((evt.getModifiers()
141 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
145 else if (od.isPositionInBox(evt.getX(), evt.getY()))
147 // display drag cursor at mouse position
148 this.getParent().setCursor(dragCursor);
154 .setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
159 public void mouseMoved(MouseEvent evt)
161 System.out.println(evt.getY());
162 if (od.isPositionInBox(evt.getX(), evt.getY()))
164 // display drag cursor at mouse position
165 this.getParent().setCursor(dragCursor);
171 .setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
176 public void mousePressed(MouseEvent evt)
178 if ((evt.getModifiers()
179 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
181 if (!Platform.isAMac())
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 if (!od.isPositionInBox(evt.getX(), evt.getY()))
194 od.updateViewportFromMouse(evt.getX(), evt.getY(),
195 av.getAlignment().getHiddenSequences(),
196 av.getAlignment().getHiddenColumns());
201 od.setDragPoint(evt.getX(), evt.getY(),
202 av.getAlignment().getHiddenSequences(),
203 av.getAlignment().getHiddenColumns());
209 public void mouseReleased(MouseEvent evt)
214 public void mouseDragged(MouseEvent evt)
216 if ((evt.getModifiers()
217 & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
219 if (!Platform.isAMac())
228 // set the mouse position as a fixed point in the box
229 // and drag relative to that position
230 od.adjustViewportFromMouse(evt.getX(), evt.getY(),
231 av.getAlignment().getHiddenSequences(),
232 av.getAlignment().getHiddenColumns());
236 od.updateViewportFromMouse(evt.getX(), evt.getY(),
237 av.getAlignment().getHiddenSequences(),
238 av.getAlignment().getHiddenColumns());
240 ap.paintAlignment(false, false);
245 * Updates the overview image when the related alignment panel is updated
247 public void updateOverviewImage()
249 if (oviewCanvas == null)
252 * panel has been disposed
257 if ((getSize().width > 0) && (getSize().height > 0))
259 od.setWidth(getSize().width);
260 od.setHeight(getSize().height);
262 setSize(new Dimension(od.getWidth(), od.getHeight()));
268 oviewCanvas.restartDraw();
272 updateRunning = true;
274 Thread thread = new Thread(this);
277 updateRunning = false;
283 oviewCanvas.draw(av.isShowSequenceFeatures(),
284 (av.isShowAnnotation()
285 && av.getAlignmentConservationAnnotation() != null),
286 ap.seqPanel.seqCanvas.getFeatureRenderer());
291 * Update the overview panel box when the associated alignment panel is
295 private void setBoxPosition()
297 od.setBoxPosition(av.getAlignment().getHiddenSequences(),
298 av.getAlignment().getHiddenColumns());
303 * Displays the popup menu and acts on user input
305 private void showPopupMenu(MouseEvent e)
307 PopupMenu popup = new PopupMenu();
308 ItemListener menuListener = new ItemListener()
311 public void itemStateChanged(ItemEvent e)
313 toggleHiddenColumns();
316 CheckboxMenuItem item = new CheckboxMenuItem(
317 MessageManager.getString("label.togglehidden"));
318 item.setState(showHidden);
320 item.addItemListener(menuListener);
322 popup.show(this, e.getX(), e.getY());
326 public void propertyChange(PropertyChangeEvent evt)
332 * Toggle overview display between showing hidden columns and hiding hidden columns
334 private void toggleHiddenColumns()
339 od = new OverviewDimensionsHideHidden(av.getRanges(),
340 (av.isShowAnnotation()
341 && av.getAlignmentConservationAnnotation() != null));
346 od = new OverviewDimensionsShowHidden(av.getRanges(),
347 (av.isShowAnnotation()
348 && av.getAlignmentConservationAnnotation() != null));
350 oviewCanvas.resetOviewDims(od);
351 updateOverviewImage();
355 * Removes this object as a property change listener, and nulls references
357 protected void dispose()
361 av.getRanges().removePropertyChangeListener(this);
362 Frame parent = (Frame) getParent();
364 parent.setVisible(false);