1 | // License: GPL. For details, see LICENSE file.
|
---|
2 | package org.openstreetmap.josm.tools;
|
---|
3 |
|
---|
4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
5 |
|
---|
6 | import java.awt.event.KeyEvent;
|
---|
7 | import java.util.ArrayList;
|
---|
8 | import java.util.Arrays;
|
---|
9 | import java.util.Comparator;
|
---|
10 | import java.util.HashMap;
|
---|
11 | import java.util.List;
|
---|
12 | import java.util.Map;
|
---|
13 | import java.util.Optional;
|
---|
14 | import java.util.concurrent.CopyOnWriteArrayList;
|
---|
15 | import java.util.function.Predicate;
|
---|
16 | import java.util.stream.Collectors;
|
---|
17 |
|
---|
18 | import javax.swing.AbstractAction;
|
---|
19 | import javax.swing.AbstractButton;
|
---|
20 | import javax.swing.JMenu;
|
---|
21 | import javax.swing.KeyStroke;
|
---|
22 | import javax.swing.text.JTextComponent;
|
---|
23 |
|
---|
24 | import org.openstreetmap.josm.Main;
|
---|
25 | import org.openstreetmap.josm.spi.preferences.Config;
|
---|
26 |
|
---|
27 | /**
|
---|
28 | * Global shortcut class.
|
---|
29 | *
|
---|
30 | * Note: This class represents a single shortcut, contains the factory to obtain
|
---|
31 | * shortcut objects from, manages shortcuts and shortcut collisions, and
|
---|
32 | * finally manages loading and saving shortcuts to/from the preferences.
|
---|
33 | *
|
---|
34 | * Action authors: You only need the {@link #registerShortcut} factory. Ignore everything else.
|
---|
35 | *
|
---|
36 | * All: Use only public methods that are also marked to be used. The others are
|
---|
37 | * public so the shortcut preferences can use them.
|
---|
38 | * @since 1084
|
---|
39 | */
|
---|
40 | public final class Shortcut {
|
---|
41 | /** the unique ID of the shortcut */
|
---|
42 | private final String shortText;
|
---|
43 | /** a human readable description that will be shown in the preferences */
|
---|
44 | private String longText;
|
---|
45 | /** the key, the caller requested */
|
---|
46 | private final int requestedKey;
|
---|
47 | /** the group, the caller requested */
|
---|
48 | private final int requestedGroup;
|
---|
49 | /** the key that actually is used */
|
---|
50 | private int assignedKey;
|
---|
51 | /** the modifiers that are used */
|
---|
52 | private int assignedModifier;
|
---|
53 | /** true if it got assigned what was requested.
|
---|
54 | * (Note: modifiers will be ignored in favour of group when loading it from the preferences then.) */
|
---|
55 | private boolean assignedDefault;
|
---|
56 | /** true if the user changed this shortcut */
|
---|
57 | private boolean assignedUser;
|
---|
58 | /** true if the user cannot change this shortcut (Note: it also will not be saved into the preferences) */
|
---|
59 | private boolean automatic;
|
---|
60 | /** true if the user requested this shortcut to be set to its default value
|
---|
61 | * (will happen on next restart, as this shortcut will not be saved to the preferences) */
|
---|
62 | private boolean reset;
|
---|
63 |
|
---|
64 | // simple constructor
|
---|
65 | private Shortcut(String shortText, String longText, int requestedKey, int requestedGroup, int assignedKey, int assignedModifier,
|
---|
66 | boolean assignedDefault, boolean assignedUser) {
|
---|
67 | this.shortText = shortText;
|
---|
68 | this.longText = longText;
|
---|
69 | this.requestedKey = requestedKey;
|
---|
70 | this.requestedGroup = requestedGroup;
|
---|
71 | this.assignedKey = assignedKey;
|
---|
72 | this.assignedModifier = assignedModifier;
|
---|
73 | this.assignedDefault = assignedDefault;
|
---|
74 | this.assignedUser = assignedUser;
|
---|
75 | this.automatic = false;
|
---|
76 | this.reset = false;
|
---|
77 | }
|
---|
78 |
|
---|
79 | public String getShortText() {
|
---|
80 | return shortText;
|
---|
81 | }
|
---|
82 |
|
---|
83 | public String getLongText() {
|
---|
84 | return longText;
|
---|
85 | }
|
---|
86 |
|
---|
87 | // a shortcut will be renamed when it is handed out again, because the original name may be a dummy
|
---|
88 | private void setLongText(String longText) {
|
---|
89 | this.longText = longText;
|
---|
90 | }
|
---|
91 |
|
---|
92 | public int getAssignedKey() {
|
---|
93 | return assignedKey;
|
---|
94 | }
|
---|
95 |
|
---|
96 | public int getAssignedModifier() {
|
---|
97 | return assignedModifier;
|
---|
98 | }
|
---|
99 |
|
---|
100 | public boolean isAssignedDefault() {
|
---|
101 | return assignedDefault;
|
---|
102 | }
|
---|
103 |
|
---|
104 | public boolean isAssignedUser() {
|
---|
105 | return assignedUser;
|
---|
106 | }
|
---|
107 |
|
---|
108 | public boolean isAutomatic() {
|
---|
109 | return automatic;
|
---|
110 | }
|
---|
111 |
|
---|
112 | public boolean isChangeable() {
|
---|
113 | return !automatic && !"core:none".equals(shortText);
|
---|
114 | }
|
---|
115 |
|
---|
116 | private boolean isReset() {
|
---|
117 | return reset;
|
---|
118 | }
|
---|
119 |
|
---|
120 | /**
|
---|
121 | * FOR PREF PANE ONLY
|
---|
122 | */
|
---|
123 | public void setAutomatic() {
|
---|
124 | automatic = true;
|
---|
125 | }
|
---|
126 |
|
---|
127 | /**
|
---|
128 | * FOR PREF PANE ONLY.<p>
|
---|
129 | * Sets the modifiers that are used.
|
---|
130 | * @param assignedModifier assigned modifier
|
---|
131 | */
|
---|
132 | public void setAssignedModifier(int assignedModifier) {
|
---|
133 | this.assignedModifier = assignedModifier;
|
---|
134 | }
|
---|
135 |
|
---|
136 | /**
|
---|
137 | * FOR PREF PANE ONLY.<p>
|
---|
138 | * Sets the key that actually is used.
|
---|
139 | * @param assignedKey assigned key
|
---|
140 | */
|
---|
141 | public void setAssignedKey(int assignedKey) {
|
---|
142 | this.assignedKey = assignedKey;
|
---|
143 | }
|
---|
144 |
|
---|
145 | /**
|
---|
146 | * FOR PREF PANE ONLY.<p>
|
---|
147 | * Sets whether the user has changed this shortcut.
|
---|
148 | * @param assignedUser {@code true} if the user has changed this shortcut
|
---|
149 | */
|
---|
150 | public void setAssignedUser(boolean assignedUser) {
|
---|
151 | this.reset = (this.assignedUser || reset) && !assignedUser;
|
---|
152 | if (assignedUser) {
|
---|
153 | assignedDefault = false;
|
---|
154 | } else if (reset) {
|
---|
155 | assignedKey = requestedKey;
|
---|
156 | assignedModifier = findModifier(requestedGroup, null);
|
---|
157 | }
|
---|
158 | this.assignedUser = assignedUser;
|
---|
159 | }
|
---|
160 |
|
---|
161 | /**
|
---|
162 | * Use this to register the shortcut with Swing
|
---|
163 | * @return the key stroke
|
---|
164 | */
|
---|
165 | public KeyStroke getKeyStroke() {
|
---|
166 | if (assignedModifier != -1)
|
---|
167 | return KeyStroke.getKeyStroke(assignedKey, assignedModifier);
|
---|
168 | return null;
|
---|
169 | }
|
---|
170 |
|
---|
171 | // create a shortcut object from an string as saved in the preferences
|
---|
172 | private Shortcut(String prefString) {
|
---|
173 | List<String> s = new ArrayList<>(Config.getPref().getList(prefString));
|
---|
174 | this.shortText = prefString.substring(15);
|
---|
175 | this.longText = s.get(0);
|
---|
176 | this.requestedKey = Integer.parseInt(s.get(1));
|
---|
177 | this.requestedGroup = Integer.parseInt(s.get(2));
|
---|
178 | this.assignedKey = Integer.parseInt(s.get(3));
|
---|
179 | this.assignedModifier = Integer.parseInt(s.get(4));
|
---|
180 | this.assignedDefault = Boolean.parseBoolean(s.get(5));
|
---|
181 | this.assignedUser = Boolean.parseBoolean(s.get(6));
|
---|
182 | }
|
---|
183 |
|
---|
184 | private void saveDefault() {
|
---|
185 | Config.getPref().getList("shortcut.entry."+shortText, Arrays.asList(longText,
|
---|
186 | String.valueOf(requestedKey), String.valueOf(requestedGroup), String.valueOf(requestedKey),
|
---|
187 | String.valueOf(getGroupModifier(requestedGroup)), String.valueOf(true), String.valueOf(false)));
|
---|
188 | }
|
---|
189 |
|
---|
190 | // get a string that can be put into the preferences
|
---|
191 | private boolean save() {
|
---|
192 | if (isAutomatic() || isReset() || !isAssignedUser()) {
|
---|
193 | return Config.getPref().putList("shortcut.entry."+shortText, null);
|
---|
194 | } else {
|
---|
195 | return Config.getPref().putList("shortcut.entry."+shortText, Arrays.asList(longText,
|
---|
196 | String.valueOf(requestedKey), String.valueOf(requestedGroup), String.valueOf(assignedKey),
|
---|
197 | String.valueOf(assignedModifier), String.valueOf(assignedDefault), String.valueOf(assignedUser)));
|
---|
198 | }
|
---|
199 | }
|
---|
200 |
|
---|
201 | private boolean isSame(int isKey, int isModifier) {
|
---|
202 | // an unassigned shortcut is different from any other shortcut
|
---|
203 | return isKey == assignedKey && isModifier == assignedModifier && assignedModifier != getGroupModifier(NONE);
|
---|
204 | }
|
---|
205 |
|
---|
206 | public boolean isEvent(KeyEvent e) {
|
---|
207 | KeyStroke ks = getKeyStroke();
|
---|
208 | return ks != null && ks.equals(KeyStroke.getKeyStroke(e.getKeyCode(), e.getModifiersEx()));
|
---|
209 | }
|
---|
210 |
|
---|
211 | /**
|
---|
212 | * use this to set a menu's mnemonic
|
---|
213 | * @param menu menu
|
---|
214 | */
|
---|
215 | public void setMnemonic(JMenu menu) {
|
---|
216 | if (assignedModifier == getGroupModifier(MNEMONIC) && getKeyStroke() != null && KeyEvent.getKeyText(assignedKey).length() == 1) {
|
---|
217 | menu.setMnemonic(KeyEvent.getKeyText(assignedKey).charAt(0)); //getKeyStroke().getKeyChar() seems not to work here
|
---|
218 | }
|
---|
219 | }
|
---|
220 |
|
---|
221 | /**
|
---|
222 | * use this to set a buttons's mnemonic
|
---|
223 | * @param button button
|
---|
224 | */
|
---|
225 | public void setMnemonic(AbstractButton button) {
|
---|
226 | if (assignedModifier == getGroupModifier(MNEMONIC) && getKeyStroke() != null && KeyEvent.getKeyText(assignedKey).length() == 1) {
|
---|
227 | button.setMnemonic(KeyEvent.getKeyText(assignedKey).charAt(0)); //getKeyStroke().getKeyChar() seems not to work here
|
---|
228 | }
|
---|
229 | }
|
---|
230 |
|
---|
231 | /**
|
---|
232 | * Sets the mnemonic key on a text component.
|
---|
233 | * @param component component
|
---|
234 | */
|
---|
235 | public void setFocusAccelerator(JTextComponent component) {
|
---|
236 | if (assignedModifier == getGroupModifier(MNEMONIC) && getKeyStroke() != null && KeyEvent.getKeyText(assignedKey).length() == 1) {
|
---|
237 | component.setFocusAccelerator(KeyEvent.getKeyText(assignedKey).charAt(0));
|
---|
238 | }
|
---|
239 | }
|
---|
240 |
|
---|
241 | /**
|
---|
242 | * use this to set a actions's accelerator
|
---|
243 | * @param action action
|
---|
244 | */
|
---|
245 | public void setAccelerator(AbstractAction action) {
|
---|
246 | if (getKeyStroke() != null) {
|
---|
247 | action.putValue(AbstractAction.ACCELERATOR_KEY, getKeyStroke());
|
---|
248 | }
|
---|
249 | }
|
---|
250 |
|
---|
251 | /**
|
---|
252 | * Returns a human readable text for the shortcut.
|
---|
253 | * @return a human readable text for the shortcut
|
---|
254 | */
|
---|
255 | public String getKeyText() {
|
---|
256 | return getKeyText(getKeyStroke());
|
---|
257 | }
|
---|
258 |
|
---|
259 | /**
|
---|
260 | * Returns a human readable text for the key stroke.
|
---|
261 | * @param keyStroke key stroke to convert to human readable text
|
---|
262 | * @return a human readable text for the key stroke
|
---|
263 | * @since 12520
|
---|
264 | */
|
---|
265 | public static String getKeyText(KeyStroke keyStroke) {
|
---|
266 | if (keyStroke == null) return "";
|
---|
267 | String modifText = KeyEvent.getModifiersExText(keyStroke.getModifiers());
|
---|
268 | if ("".equals(modifText)) return KeyEvent.getKeyText(keyStroke.getKeyCode());
|
---|
269 | return modifText + '+' + KeyEvent.getKeyText(keyStroke.getKeyCode());
|
---|
270 | }
|
---|
271 |
|
---|
272 | @Override
|
---|
273 | public String toString() {
|
---|
274 | return getKeyText();
|
---|
275 | }
|
---|
276 |
|
---|
277 | ///////////////////////////////
|
---|
278 | // everything's static below //
|
---|
279 | ///////////////////////////////
|
---|
280 |
|
---|
281 | // here we store our shortcuts
|
---|
282 | private static ShortcutCollection shortcuts = new ShortcutCollection();
|
---|
283 |
|
---|
284 | private static class ShortcutCollection extends CopyOnWriteArrayList<Shortcut> {
|
---|
285 | private static final long serialVersionUID = 1L;
|
---|
286 | @Override
|
---|
287 | public boolean add(Shortcut shortcut) {
|
---|
288 | // expensive consistency check only in debug mode
|
---|
289 | if (Logging.isDebugEnabled()
|
---|
290 | && stream().map(Shortcut::getShortText).anyMatch(shortcut.getShortText()::equals)) {
|
---|
291 | Logging.warn(new AssertionError(shortcut.getShortText() + " already added"));
|
---|
292 | }
|
---|
293 | return super.add(shortcut);
|
---|
294 | }
|
---|
295 |
|
---|
296 | void replace(Shortcut newShortcut) {
|
---|
297 | final Optional<Shortcut> existing = findShortcutByKeyOrShortText(-1, NONE, newShortcut.shortText);
|
---|
298 | if (existing.isPresent()) {
|
---|
299 | replaceAll(sc -> existing.get() == sc ? newShortcut : sc);
|
---|
300 | } else {
|
---|
301 | add(newShortcut);
|
---|
302 | }
|
---|
303 | }
|
---|
304 | }
|
---|
305 |
|
---|
306 | // and here our modifier groups
|
---|
307 | private static Map<Integer, Integer> groups = new HashMap<>();
|
---|
308 |
|
---|
309 | // check if something collides with an existing shortcut
|
---|
310 |
|
---|
311 | /**
|
---|
312 | * Returns the registered shortcut fot the key and modifier
|
---|
313 | * @param requestedKey the requested key
|
---|
314 | * @param modifier the modifier
|
---|
315 | * @return an {@link Optional} registered shortcut, never {@code null}
|
---|
316 | */
|
---|
317 | public static Optional<Shortcut> findShortcut(int requestedKey, int modifier) {
|
---|
318 | return findShortcutByKeyOrShortText(requestedKey, modifier, null);
|
---|
319 | }
|
---|
320 |
|
---|
321 | private static Optional<Shortcut> findShortcutByKeyOrShortText(int requestedKey, int modifier, String shortText) {
|
---|
322 | final Predicate<Shortcut> sameKey = sc -> modifier != getGroupModifier(NONE) && sc.isSame(requestedKey, modifier);
|
---|
323 | final Predicate<Shortcut> sameShortText = sc -> sc.getShortText().equals(shortText);
|
---|
324 | return shortcuts.stream()
|
---|
325 | .filter(sameKey.or(sameShortText))
|
---|
326 | .sorted(Comparator.comparingInt(sc -> sameShortText.test(sc) ? 0 : 1))
|
---|
327 | .findAny();
|
---|
328 | }
|
---|
329 |
|
---|
330 | /**
|
---|
331 | * Returns a list of all shortcuts.
|
---|
332 | * @return a list of all shortcuts
|
---|
333 | */
|
---|
334 | public static List<Shortcut> listAll() {
|
---|
335 | return shortcuts.stream()
|
---|
336 | .filter(c -> !"core:none".equals(c.shortText))
|
---|
337 | .collect(Collectors.toList());
|
---|
338 | }
|
---|
339 |
|
---|
340 | /** None group: used with KeyEvent.CHAR_UNDEFINED if no shortcut is defined */
|
---|
341 | public static final int NONE = 5000;
|
---|
342 | public static final int MNEMONIC = 5001;
|
---|
343 | /** Reserved group: for system shortcuts only */
|
---|
344 | public static final int RESERVED = 5002;
|
---|
345 | /** Direct group: no modifier */
|
---|
346 | public static final int DIRECT = 5003;
|
---|
347 | /** Alt group */
|
---|
348 | public static final int ALT = 5004;
|
---|
349 | /** Shift group */
|
---|
350 | public static final int SHIFT = 5005;
|
---|
351 | /** Command group. Matches CTRL modifier on Windows/Linux but META modifier on OS X */
|
---|
352 | public static final int CTRL = 5006;
|
---|
353 | /** Alt-Shift group */
|
---|
354 | public static final int ALT_SHIFT = 5007;
|
---|
355 | /** Alt-Command group. Matches ALT-CTRL modifier on Windows/Linux but ALT-META modifier on OS X */
|
---|
356 | public static final int ALT_CTRL = 5008;
|
---|
357 | /** Command-Shift group. Matches CTRL-SHIFT modifier on Windows/Linux but META-SHIFT modifier on OS X */
|
---|
358 | public static final int CTRL_SHIFT = 5009;
|
---|
359 | /** Alt-Command-Shift group. Matches ALT-CTRL-SHIFT modifier on Windows/Linux but ALT-META-SHIFT modifier on OS X */
|
---|
360 | public static final int ALT_CTRL_SHIFT = 5010;
|
---|
361 |
|
---|
362 | /* for reassignment */
|
---|
363 | private static int[] mods = {ALT_CTRL, ALT_SHIFT, CTRL_SHIFT, ALT_CTRL_SHIFT};
|
---|
364 | private static int[] keys = {KeyEvent.VK_F1, KeyEvent.VK_F2, KeyEvent.VK_F3, KeyEvent.VK_F4,
|
---|
365 | KeyEvent.VK_F5, KeyEvent.VK_F6, KeyEvent.VK_F7, KeyEvent.VK_F8,
|
---|
366 | KeyEvent.VK_F9, KeyEvent.VK_F10, KeyEvent.VK_F11, KeyEvent.VK_F12};
|
---|
367 |
|
---|
368 | // bootstrap
|
---|
369 | private static boolean initdone;
|
---|
370 | private static void doInit() {
|
---|
371 | if (initdone) return;
|
---|
372 | initdone = true;
|
---|
373 | int commandDownMask = Main.platform.getMenuShortcutKeyMaskEx();
|
---|
374 | groups.put(NONE, -1);
|
---|
375 | groups.put(MNEMONIC, KeyEvent.ALT_DOWN_MASK);
|
---|
376 | groups.put(DIRECT, 0);
|
---|
377 | groups.put(ALT, KeyEvent.ALT_DOWN_MASK);
|
---|
378 | groups.put(SHIFT, KeyEvent.SHIFT_DOWN_MASK);
|
---|
379 | groups.put(CTRL, commandDownMask);
|
---|
380 | groups.put(ALT_SHIFT, KeyEvent.ALT_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK);
|
---|
381 | groups.put(ALT_CTRL, KeyEvent.ALT_DOWN_MASK | commandDownMask);
|
---|
382 | groups.put(CTRL_SHIFT, commandDownMask | KeyEvent.SHIFT_DOWN_MASK);
|
---|
383 | groups.put(ALT_CTRL_SHIFT, KeyEvent.ALT_DOWN_MASK | commandDownMask | KeyEvent.SHIFT_DOWN_MASK);
|
---|
384 |
|
---|
385 | // (1) System reserved shortcuts
|
---|
386 | Main.platform.initSystemShortcuts();
|
---|
387 | // (2) User defined shortcuts
|
---|
388 | Main.pref.getAllPrefixCollectionKeys("shortcut.entry.").stream()
|
---|
389 | .map(Shortcut::new)
|
---|
390 | .filter(sc -> !findShortcut(sc.getAssignedKey(), sc.getAssignedModifier()).isPresent())
|
---|
391 | .sorted(Comparator.comparing(sc -> sc.isAssignedUser() ? 1 : sc.isAssignedDefault() ? 2 : 3))
|
---|
392 | .forEachOrdered(shortcuts::replace);
|
---|
393 | }
|
---|
394 |
|
---|
395 | private static int getGroupModifier(int group) {
|
---|
396 | return Optional.ofNullable(groups.get(group)).orElse(-1);
|
---|
397 | }
|
---|
398 |
|
---|
399 | private static int findModifier(int group, Integer modifier) {
|
---|
400 | if (modifier == null) {
|
---|
401 | modifier = getGroupModifier(group);
|
---|
402 | if (modifier == null) { // garbage in, no shortcut out
|
---|
403 | modifier = getGroupModifier(NONE);
|
---|
404 | }
|
---|
405 | }
|
---|
406 | return modifier;
|
---|
407 | }
|
---|
408 |
|
---|
409 | // shutdown handling
|
---|
410 | public static boolean savePrefs() {
|
---|
411 | return shortcuts.stream()
|
---|
412 | .map(Shortcut::save)
|
---|
413 | .reduce(Boolean.FALSE, Boolean::logicalOr); // has changed
|
---|
414 | }
|
---|
415 |
|
---|
416 | /**
|
---|
417 | * FOR PLATFORMHOOK USE ONLY.
|
---|
418 | * <p>
|
---|
419 | * This registers a system shortcut. See PlatformHook for details.
|
---|
420 | * @param shortText an ID. re-use a {@code "system:*"} ID if possible, else use something unique.
|
---|
421 | * @param longText this will be displayed in the shortcut preferences dialog. Better
|
---|
422 | * use something the user will recognize...
|
---|
423 | * @param key the key. Use a {@link KeyEvent KeyEvent.VK_*} constant here.
|
---|
424 | * @param modifier the modifier. Use a {@link KeyEvent KeyEvent.*_MASK} constant here.
|
---|
425 | * @return the system shortcut
|
---|
426 | */
|
---|
427 | public static Shortcut registerSystemShortcut(String shortText, String longText, int key, int modifier) {
|
---|
428 | final Optional<Shortcut> existing = findShortcutByKeyOrShortText(key, modifier, shortText);
|
---|
429 | if (existing.isPresent() && shortText.equals(existing.get().getShortText())) {
|
---|
430 | return existing.get();
|
---|
431 | } else if (existing.isPresent()) {
|
---|
432 | // this always is a logic error in the hook
|
---|
433 | Logging.error("CONFLICT WITH SYSTEM KEY " + shortText + ": " + existing.get());
|
---|
434 | return null;
|
---|
435 | }
|
---|
436 | final Shortcut shortcut = new Shortcut(shortText, longText, key, RESERVED, key, modifier, true, false);
|
---|
437 | shortcuts.add(shortcut);
|
---|
438 | return shortcut;
|
---|
439 | }
|
---|
440 |
|
---|
441 | /**
|
---|
442 | * Register a shortcut.
|
---|
443 | *
|
---|
444 | * Here you get your shortcuts from. The parameters are:
|
---|
445 | *
|
---|
446 | * @param shortText an ID. re-use a {@code "system:*"} ID if possible, else use something unique.
|
---|
447 | * {@code "menu:*"} is reserved for menu mnemonics, {@code "core:*"} is reserved for
|
---|
448 | * actions that are part of JOSM's core. Use something like
|
---|
449 | * {@code <pluginname>+":"+<actionname>}.
|
---|
450 | * @param longText this will be displayed in the shortcut preferences dialog. Better
|
---|
451 | * use something the user will recognize...
|
---|
452 | * @param requestedKey the key you'd prefer. Use a {@link KeyEvent KeyEvent.VK_*} constant here.
|
---|
453 | * @param requestedGroup the group this shortcut fits best. This will determine the
|
---|
454 | * modifiers your shortcut will get assigned. Use the constants defined above.
|
---|
455 | * @return the shortcut
|
---|
456 | */
|
---|
457 | public static Shortcut registerShortcut(String shortText, String longText, int requestedKey, int requestedGroup) {
|
---|
458 | return registerShortcut(shortText, longText, requestedKey, requestedGroup, null);
|
---|
459 | }
|
---|
460 |
|
---|
461 | // and now the workhorse. same parameters as above, just one more
|
---|
462 | private static Shortcut registerShortcut(String shortText, String longText, int requestedKey, int requestedGroup, Integer modifier) {
|
---|
463 | doInit();
|
---|
464 | Integer defaultModifier = findModifier(requestedGroup, modifier);
|
---|
465 | final Optional<Shortcut> existing = findShortcutByKeyOrShortText(requestedKey, defaultModifier, shortText);
|
---|
466 | if (existing.isPresent() && shortText.equals(existing.get().getShortText())) {
|
---|
467 | // a re-register? maybe a sc already read from the preferences?
|
---|
468 | final Shortcut sc = existing.get();
|
---|
469 | sc.setLongText(longText); // or set by the platformHook, in this case the original longText doesn't match the real action
|
---|
470 | sc.saveDefault();
|
---|
471 | return sc;
|
---|
472 | } else if (existing.isPresent()) {
|
---|
473 | final Shortcut conflict = existing.get();
|
---|
474 | if (Main.isPlatformOsx()) {
|
---|
475 | // Try to reassign Meta to Ctrl
|
---|
476 | int newmodifier = findNewOsxModifier(requestedGroup);
|
---|
477 | if (!findShortcut(requestedKey, newmodifier).isPresent()) {
|
---|
478 | Logging.info("Reassigning OSX shortcut '" + shortText + "' from Meta to Ctrl because of conflict with " + conflict);
|
---|
479 | return reassignShortcut(shortText, longText, requestedKey, conflict, requestedGroup, requestedKey, newmodifier);
|
---|
480 | }
|
---|
481 | }
|
---|
482 | for (int m : mods) {
|
---|
483 | for (int k : keys) {
|
---|
484 | int newmodifier = getGroupModifier(m);
|
---|
485 | if (!findShortcut(k, newmodifier).isPresent()) {
|
---|
486 | Logging.info("Reassigning shortcut '" + shortText + "' from " + modifier + " to " + newmodifier +
|
---|
487 | " because of conflict with " + conflict);
|
---|
488 | return reassignShortcut(shortText, longText, requestedKey, conflict, m, k, newmodifier);
|
---|
489 | }
|
---|
490 | }
|
---|
491 | }
|
---|
492 | } else {
|
---|
493 | Shortcut newsc = new Shortcut(shortText, longText, requestedKey, requestedGroup, requestedKey, defaultModifier, true, false);
|
---|
494 | newsc.saveDefault();
|
---|
495 | shortcuts.add(newsc);
|
---|
496 | return newsc;
|
---|
497 | }
|
---|
498 |
|
---|
499 | return null;
|
---|
500 | }
|
---|
501 |
|
---|
502 | private static int findNewOsxModifier(int requestedGroup) {
|
---|
503 | switch (requestedGroup) {
|
---|
504 | case CTRL: return KeyEvent.CTRL_DOWN_MASK;
|
---|
505 | case ALT_CTRL: return KeyEvent.ALT_DOWN_MASK | KeyEvent.CTRL_DOWN_MASK;
|
---|
506 | case CTRL_SHIFT: return KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK;
|
---|
507 | case ALT_CTRL_SHIFT: return KeyEvent.ALT_DOWN_MASK | KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK;
|
---|
508 | default: return 0;
|
---|
509 | }
|
---|
510 | }
|
---|
511 |
|
---|
512 | private static Shortcut reassignShortcut(String shortText, String longText, int requestedKey, Shortcut conflict,
|
---|
513 | int m, int k, int newmodifier) {
|
---|
514 | Shortcut newsc = new Shortcut(shortText, longText, requestedKey, m, k, newmodifier, false, false);
|
---|
515 | Logging.info(tr("Silent shortcut conflict: ''{0}'' moved by ''{1}'' to ''{2}''.",
|
---|
516 | shortText, conflict.getShortText(), newsc.getKeyText()));
|
---|
517 | newsc.saveDefault();
|
---|
518 | shortcuts.add(newsc);
|
---|
519 | return newsc;
|
---|
520 | }
|
---|
521 |
|
---|
522 | /**
|
---|
523 | * Replies the platform specific key stroke for the 'Copy' command, i.e.
|
---|
524 | * 'Ctrl-C' on windows or 'Meta-C' on a Mac. null, if the platform specific
|
---|
525 | * copy command isn't known.
|
---|
526 | *
|
---|
527 | * @return the platform specific key stroke for the 'Copy' command
|
---|
528 | */
|
---|
529 | public static KeyStroke getCopyKeyStroke() {
|
---|
530 | return getKeyStrokeForShortKey("system:copy");
|
---|
531 | }
|
---|
532 |
|
---|
533 | /**
|
---|
534 | * Replies the platform specific key stroke for the 'Paste' command, i.e.
|
---|
535 | * 'Ctrl-V' on windows or 'Meta-V' on a Mac. null, if the platform specific
|
---|
536 | * paste command isn't known.
|
---|
537 | *
|
---|
538 | * @return the platform specific key stroke for the 'Paste' command
|
---|
539 | */
|
---|
540 | public static KeyStroke getPasteKeyStroke() {
|
---|
541 | return getKeyStrokeForShortKey("system:paste");
|
---|
542 | }
|
---|
543 |
|
---|
544 | /**
|
---|
545 | * Replies the platform specific key stroke for the 'Cut' command, i.e.
|
---|
546 | * 'Ctrl-X' on windows or 'Meta-X' on a Mac. null, if the platform specific
|
---|
547 | * 'Cut' command isn't known.
|
---|
548 | *
|
---|
549 | * @return the platform specific key stroke for the 'Cut' command
|
---|
550 | */
|
---|
551 | public static KeyStroke getCutKeyStroke() {
|
---|
552 | return getKeyStrokeForShortKey("system:cut");
|
---|
553 | }
|
---|
554 |
|
---|
555 | private static KeyStroke getKeyStrokeForShortKey(String shortKey) {
|
---|
556 | return shortcuts.stream()
|
---|
557 | .filter(sc -> shortKey.equals(sc.getShortText()))
|
---|
558 | .findAny()
|
---|
559 | .map(Shortcut::getKeyStroke)
|
---|
560 | .orElse(null);
|
---|
561 | }
|
---|
562 | }
|
---|