1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.gui;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.awt.Cursor;
|
---|
7 | import java.awt.Point;
|
---|
8 | import java.awt.event.ActionEvent;
|
---|
9 | import java.awt.event.KeyEvent;
|
---|
10 | import java.awt.event.MouseAdapter;
|
---|
11 | import java.awt.event.MouseEvent;
|
---|
12 | import java.awt.event.MouseMotionListener;
|
---|
13 | import java.awt.event.MouseWheelEvent;
|
---|
14 | import java.awt.event.MouseWheelListener;
|
---|
15 |
|
---|
16 | import javax.swing.AbstractAction;
|
---|
17 | import javax.swing.ActionMap;
|
---|
18 | import javax.swing.InputMap;
|
---|
19 | import javax.swing.JComponent;
|
---|
20 | import javax.swing.JPanel;
|
---|
21 | import javax.swing.KeyStroke;
|
---|
22 |
|
---|
23 | import org.openstreetmap.josm.Main;
|
---|
24 | import org.openstreetmap.josm.actions.mapmode.SelectAction;
|
---|
25 | import org.openstreetmap.josm.data.coor.EastNorth;
|
---|
26 | import org.openstreetmap.josm.tools.Destroyable;
|
---|
27 | import org.openstreetmap.josm.tools.Shortcut;
|
---|
28 |
|
---|
29 | /**
|
---|
30 | * Enables moving of the map by holding down the right mouse button and drag
|
---|
31 | * the mouse. Also, enables zooming by the mouse wheel.
|
---|
32 | *
|
---|
33 | * @author imi
|
---|
34 | */
|
---|
35 | public class MapMover extends MouseAdapter implements MouseMotionListener, MouseWheelListener, Destroyable {
|
---|
36 |
|
---|
37 | private final class ZoomerAction extends AbstractAction {
|
---|
38 | private final String action;
|
---|
39 |
|
---|
40 | ZoomerAction(String action) {
|
---|
41 | this.action = action;
|
---|
42 | }
|
---|
43 |
|
---|
44 | @Override
|
---|
45 | public void actionPerformed(ActionEvent e) {
|
---|
46 | if (".".equals(action) || ",".equals(action)) {
|
---|
47 | Point mouse = nc.getMousePosition();
|
---|
48 | if (mouse == null)
|
---|
49 | mouse = new Point((int) nc.getBounds().getCenterX(), (int) nc.getBounds().getCenterY());
|
---|
50 | MouseWheelEvent we = new MouseWheelEvent(nc, e.getID(), e.getWhen(), e.getModifiers(), mouse.x, mouse.y, 0, false,
|
---|
51 | MouseWheelEvent.WHEEL_UNIT_SCROLL, 1, ",".equals(action) ? -1 : 1);
|
---|
52 | mouseWheelMoved(we);
|
---|
53 | } else {
|
---|
54 | EastNorth center = nc.getCenter();
|
---|
55 | EastNorth newcenter = nc.getEastNorth(nc.getWidth()/2+nc.getWidth()/5, nc.getHeight()/2+nc.getHeight()/5);
|
---|
56 | switch(action) {
|
---|
57 | case "left":
|
---|
58 | nc.zoomTo(new EastNorth(2*center.east()-newcenter.east(), center.north()));
|
---|
59 | break;
|
---|
60 | case "right":
|
---|
61 | nc.zoomTo(new EastNorth(newcenter.east(), center.north()));
|
---|
62 | break;
|
---|
63 | case "up":
|
---|
64 | nc.zoomTo(new EastNorth(center.east(), 2*center.north()-newcenter.north()));
|
---|
65 | break;
|
---|
66 | case "down":
|
---|
67 | nc.zoomTo(new EastNorth(center.east(), newcenter.north()));
|
---|
68 | break;
|
---|
69 | }
|
---|
70 | }
|
---|
71 | }
|
---|
72 | }
|
---|
73 |
|
---|
74 | /**
|
---|
75 | * The point in the map that was the under the mouse point
|
---|
76 | * when moving around started.
|
---|
77 | */
|
---|
78 | private EastNorth mousePosMove;
|
---|
79 | /**
|
---|
80 | * The map to move around.
|
---|
81 | */
|
---|
82 | private final NavigatableComponent nc;
|
---|
83 | private final JPanel contentPane;
|
---|
84 |
|
---|
85 | private boolean movementInPlace;
|
---|
86 |
|
---|
87 | /**
|
---|
88 | * Constructs a new {@code MapMover}.
|
---|
89 | * @param navComp the navigatable component
|
---|
90 | * @param contentPane the content pane
|
---|
91 | */
|
---|
92 | public MapMover(NavigatableComponent navComp, JPanel contentPane) {
|
---|
93 | this.nc = navComp;
|
---|
94 | this.contentPane = contentPane;
|
---|
95 | nc.addMouseListener(this);
|
---|
96 | nc.addMouseMotionListener(this);
|
---|
97 | nc.addMouseWheelListener(this);
|
---|
98 |
|
---|
99 | if (contentPane != null) {
|
---|
100 | // CHECKSTYLE.OFF: LineLength
|
---|
101 | contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
|
---|
102 | Shortcut.registerShortcut("system:movefocusright", tr("Map: {0}", tr("Move right")), KeyEvent.VK_RIGHT, Shortcut.CTRL).getKeyStroke(),
|
---|
103 | "MapMover.Zoomer.right");
|
---|
104 | contentPane.getActionMap().put("MapMover.Zoomer.right", new ZoomerAction("right"));
|
---|
105 |
|
---|
106 | contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
|
---|
107 | Shortcut.registerShortcut("system:movefocusleft", tr("Map: {0}", tr("Move left")), KeyEvent.VK_LEFT, Shortcut.CTRL).getKeyStroke(),
|
---|
108 | "MapMover.Zoomer.left");
|
---|
109 | contentPane.getActionMap().put("MapMover.Zoomer.left", new ZoomerAction("left"));
|
---|
110 |
|
---|
111 | contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
|
---|
112 | Shortcut.registerShortcut("system:movefocusup", tr("Map: {0}", tr("Move up")), KeyEvent.VK_UP, Shortcut.CTRL).getKeyStroke(),
|
---|
113 | "MapMover.Zoomer.up");
|
---|
114 | contentPane.getActionMap().put("MapMover.Zoomer.up", new ZoomerAction("up"));
|
---|
115 |
|
---|
116 | contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
|
---|
117 | Shortcut.registerShortcut("system:movefocusdown", tr("Map: {0}", tr("Move down")), KeyEvent.VK_DOWN, Shortcut.CTRL).getKeyStroke(),
|
---|
118 | "MapMover.Zoomer.down");
|
---|
119 | contentPane.getActionMap().put("MapMover.Zoomer.down", new ZoomerAction("down"));
|
---|
120 | // CHECKSTYLE.ON: LineLength
|
---|
121 |
|
---|
122 | // see #10592 - Disable these alternate shortcuts on OS X because of conflict with system shortcut
|
---|
123 | if (!Main.isPlatformOsx()) {
|
---|
124 | contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
|
---|
125 | Shortcut.registerShortcut("view:zoominalternate",
|
---|
126 | tr("Map: {0}", tr("Zoom in")), KeyEvent.VK_COMMA, Shortcut.CTRL).getKeyStroke(),
|
---|
127 | "MapMover.Zoomer.in");
|
---|
128 | contentPane.getActionMap().put("MapMover.Zoomer.in", new ZoomerAction(","));
|
---|
129 |
|
---|
130 | contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
|
---|
131 | Shortcut.registerShortcut("view:zoomoutalternate",
|
---|
132 | tr("Map: {0}", tr("Zoom out")), KeyEvent.VK_PERIOD, Shortcut.CTRL).getKeyStroke(),
|
---|
133 | "MapMover.Zoomer.out");
|
---|
134 | contentPane.getActionMap().put("MapMover.Zoomer.out", new ZoomerAction("."));
|
---|
135 | }
|
---|
136 | }
|
---|
137 | }
|
---|
138 |
|
---|
139 | /**
|
---|
140 | * If the right (and only the right) mouse button is pressed, move the map.
|
---|
141 | */
|
---|
142 | @Override
|
---|
143 | public void mouseDragged(MouseEvent e) {
|
---|
144 | int offMask = MouseEvent.BUTTON1_DOWN_MASK | MouseEvent.BUTTON2_DOWN_MASK;
|
---|
145 | int macMouseMask = MouseEvent.CTRL_DOWN_MASK | MouseEvent.BUTTON1_DOWN_MASK;
|
---|
146 | boolean stdMovement = (e.getModifiersEx() & (MouseEvent.BUTTON3_DOWN_MASK | offMask)) == MouseEvent.BUTTON3_DOWN_MASK;
|
---|
147 | boolean macMovement = Main.isPlatformOsx() && e.getModifiersEx() == macMouseMask;
|
---|
148 | boolean allowedMode = !Main.map.mapModeSelect.equals(Main.map.mapMode)
|
---|
149 | || SelectAction.Mode.SELECT.equals(Main.map.mapModeSelect.getMode());
|
---|
150 | if (stdMovement || (macMovement && allowedMode)) {
|
---|
151 | if (mousePosMove == null)
|
---|
152 | startMovement(e);
|
---|
153 | EastNorth center = nc.getCenter();
|
---|
154 | EastNorth mouseCenter = nc.getEastNorth(e.getX(), e.getY());
|
---|
155 | nc.zoomTo(new EastNorth(
|
---|
156 | mousePosMove.east() + center.east() - mouseCenter.east(),
|
---|
157 | mousePosMove.north() + center.north() - mouseCenter.north()));
|
---|
158 | } else {
|
---|
159 | endMovement();
|
---|
160 | }
|
---|
161 | }
|
---|
162 |
|
---|
163 | /**
|
---|
164 | * Start the movement, if it was the 3rd button (right button).
|
---|
165 | */
|
---|
166 | @Override
|
---|
167 | public void mousePressed(MouseEvent e) {
|
---|
168 | int offMask = MouseEvent.BUTTON1_DOWN_MASK | MouseEvent.BUTTON2_DOWN_MASK;
|
---|
169 | int macMouseMask = MouseEvent.CTRL_DOWN_MASK | MouseEvent.BUTTON1_DOWN_MASK;
|
---|
170 | if (e.getButton() == MouseEvent.BUTTON3 && (e.getModifiersEx() & offMask) == 0 ||
|
---|
171 | Main.isPlatformOsx() && e.getModifiersEx() == macMouseMask) {
|
---|
172 | startMovement(e);
|
---|
173 | }
|
---|
174 | }
|
---|
175 |
|
---|
176 | /**
|
---|
177 | * Change the cursor back to it's pre-move cursor.
|
---|
178 | */
|
---|
179 | @Override
|
---|
180 | public void mouseReleased(MouseEvent e) {
|
---|
181 | if (e.getButton() == MouseEvent.BUTTON3 || Main.isPlatformOsx() && e.getButton() == MouseEvent.BUTTON1) {
|
---|
182 | endMovement();
|
---|
183 | }
|
---|
184 | }
|
---|
185 |
|
---|
186 | /**
|
---|
187 | * Start movement by setting a new cursor and remember the current mouse
|
---|
188 | * position.
|
---|
189 | * @param e The mouse event that leat to the movement from.
|
---|
190 | */
|
---|
191 | private void startMovement(MouseEvent e) {
|
---|
192 | if (movementInPlace)
|
---|
193 | return;
|
---|
194 | movementInPlace = true;
|
---|
195 | mousePosMove = nc.getEastNorth(e.getX(), e.getY());
|
---|
196 | nc.setNewCursor(Cursor.MOVE_CURSOR, this);
|
---|
197 | }
|
---|
198 |
|
---|
199 | /**
|
---|
200 | * End the movement. Setting back the cursor and clear the movement variables
|
---|
201 | */
|
---|
202 | private void endMovement() {
|
---|
203 | if (!movementInPlace)
|
---|
204 | return;
|
---|
205 | movementInPlace = false;
|
---|
206 | nc.resetCursor(this);
|
---|
207 | mousePosMove = null;
|
---|
208 | }
|
---|
209 |
|
---|
210 | /**
|
---|
211 | * Zoom the map by 1/5th of current zoom per wheel-delta.
|
---|
212 | * @param e The wheel event.
|
---|
213 | */
|
---|
214 | @Override
|
---|
215 | public void mouseWheelMoved(MouseWheelEvent e) {
|
---|
216 | nc.zoomToFactor(e.getX(), e.getY(), Math.pow(Math.sqrt(2), e.getWheelRotation()));
|
---|
217 | }
|
---|
218 |
|
---|
219 | /**
|
---|
220 | * Emulates dragging on Mac OSX.
|
---|
221 | */
|
---|
222 | @Override
|
---|
223 | public void mouseMoved(MouseEvent e) {
|
---|
224 | if (!movementInPlace)
|
---|
225 | return;
|
---|
226 | // Mac OSX simulates with ctrl + mouse 1 the second mouse button hence no dragging events get fired.
|
---|
227 | // Is only the selected mouse button pressed?
|
---|
228 | if (Main.isPlatformOsx()) {
|
---|
229 | if (e.getModifiersEx() == MouseEvent.CTRL_DOWN_MASK) {
|
---|
230 | if (mousePosMove == null) {
|
---|
231 | startMovement(e);
|
---|
232 | }
|
---|
233 | EastNorth center = nc.getCenter();
|
---|
234 | EastNorth mouseCenter = nc.getEastNorth(e.getX(), e.getY());
|
---|
235 | nc.zoomTo(new EastNorth(mousePosMove.east() + center.east() - mouseCenter.east(), mousePosMove.north()
|
---|
236 | + center.north() - mouseCenter.north()));
|
---|
237 | } else {
|
---|
238 | endMovement();
|
---|
239 | }
|
---|
240 | }
|
---|
241 | }
|
---|
242 |
|
---|
243 | @Override
|
---|
244 | public void destroy() {
|
---|
245 | if (this.contentPane != null) {
|
---|
246 | InputMap inputMap = contentPane.getInputMap();
|
---|
247 | KeyStroke[] inputKeys = inputMap.keys();
|
---|
248 | if (inputKeys != null) {
|
---|
249 | for (KeyStroke key : inputKeys) {
|
---|
250 | Object binding = inputMap.get(key);
|
---|
251 | if (binding instanceof String && ((String) binding).startsWith("MapMover.")) {
|
---|
252 | inputMap.remove(key);
|
---|
253 | }
|
---|
254 | }
|
---|
255 | }
|
---|
256 | ActionMap actionMap = contentPane.getActionMap();
|
---|
257 | Object[] actionsKeys = actionMap.keys();
|
---|
258 | if (actionsKeys != null) {
|
---|
259 | for (Object key : actionsKeys) {
|
---|
260 | if (key instanceof String && ((String) key).startsWith("MapMover.")) {
|
---|
261 | actionMap.remove(key);
|
---|
262 | }
|
---|
263 | }
|
---|
264 | }
|
---|
265 | }
|
---|
266 | }
|
---|
267 | }
|
---|