zdm/envoy
zdm/envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity

Apply suggestions by @kske

Browse Source
This commit is contained in:
Leon Hofmeister 2020-10-12 09:50:00 +02:00
parent fbdcbf4500
commit 7477f9dbd9
Signed by: delvh
GPG Key ID: 3DECE05F6D9A647C
6 changed files with 15 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
client/src/main/java/envoy/client/data/shortcuts/EnvoyShortcutConfig.java
View File

@ -26,7 +26,8 @@ public class EnvoyShortcutConfig {
public static void initializeEnvoyShortcuts() {
final var instance = GlobalKeyShortcuts.getInstance();
// Add the option to exit Linux-like with "Control" + "Q" or "Alt" + "F4"
// Add the option to exit with "Control" + "Q" or "Alt" + "F4" as offered by
// some desktop environments
instance.add(new KeyCodeCombination(KeyCode.Q, KeyCombination.CONTROL_DOWN), ShutdownHelper::exit);
// Add the option to logout using "Control"+"Shift"+"L" if not in login scene

56
client/src/main/java/envoy/client/data/shortcuts/GlobalKeyShortcuts.java
View File

@ -1,64 +1,26 @@
package envoy.client.data.shortcuts;
import java.util.*;
import java.util.Map.Entry;
import javafx.scene.input.KeyCombination;
import envoy.client.ui.SceneContext.SceneInfo;
/**
* Contains all KeyBoardshotcuts used throughout the application.
* Contains all keyboard shortcuts used throughout the application.
*
* @author Leon Hofmeister
* @since Envoy Client v0.3-beta
*/
public final class GlobalKeyShortcuts {
/**
* Helper class for the Entry interface.
*
* @author Leon Hofmeister
* @since Envoy Client v0.3-beta
*/
public final class KeyCombinationAction implements Entry<KeyCombination, Runnable> {
private final KeyCombination keys;
private final Runnable action;
/**
* Creates a new {@code KeyCombinationAction}.
*
* @param keys the keys to press to perform the given action
* @param action the action to perform
* @since Envoy Client v0.3-beta
*/
public KeyCombinationAction(KeyCombination keys, Runnable action) {
if (keys == null || action == null) throw new NullPointerException("Cannot create key combination action");
this.keys = keys;
this.action = action;
}
@Override
public KeyCombination getKey() { return keys; }
@Override
public Runnable getValue() { return action; }
@Override
public Runnable setValue(Runnable none) {
throw new UnsupportedOperationException("Reassignment of keyboard shortcut actions is not supported");
}
}
private final EnumMap<SceneInfo, Collection<KeyCombinationAction>> shortcuts = new EnumMap<>(SceneInfo.class);
private final EnumMap<SceneInfo, Map<KeyCombination, Runnable>> shortcuts = new EnumMap<>(SceneInfo.class);
private static GlobalKeyShortcuts instance = new GlobalKeyShortcuts();
private GlobalKeyShortcuts() {
for (final var sceneInfo : SceneInfo.values())
shortcuts.put(sceneInfo, new HashSet<KeyCombinationAction>());
shortcuts.put(sceneInfo, new HashMap<KeyCombination, Runnable>());
}
/**
@ -74,10 +36,7 @@ public final class GlobalKeyShortcuts {
* @param action the action to perform
* @since Envoy Client v0.3-beta
*/
public void add(KeyCombination keys, Runnable action) {
final var keyCombinationAction = new KeyCombinationAction(keys, action);
shortcuts.values().forEach(collection -> collection.add(keyCombinationAction));
}
public void add(KeyCombination keys, Runnable action) { shortcuts.values().forEach(collection -> collection.put(keys, action)); }
/**
* Adds the given keyboard shortcut and its action to all scenes that are not
@ -102,17 +61,16 @@ public final class GlobalKeyShortcuts {
}
// Adding the action to the remaining sceneInfos
final var keyCombinationAction = new KeyCombinationAction(keys, action);
for (final var sceneInfo : include)
shortcuts.get(sceneInfo).add(keyCombinationAction);
shortcuts.get(sceneInfo).put(keys, action);
}
/**
* Returns all stored keyboard shortcuts for the given scene constant
* Returns all stored keyboard shortcuts for the given scene constant.
*
* @param sceneInfo the currently loading scene
* @return all stored keyboard shortcuts for this scene
* @since Envoy Client v0.3-beta
*/
public Collection<KeyCombinationAction> getKeyboardShortcuts(SceneInfo sceneInfo) { return shortcuts.get(sceneInfo); }
public Map<KeyCombination, Runnable> getKeyboardShortcuts(SceneInfo sceneInfo) { return shortcuts.get(sceneInfo); }
}

4
client/src/main/java/envoy/client/data/shortcuts/KeyboardMapping.java
View File

@ -8,9 +8,9 @@ import envoy.client.ui.SceneContext;
/**
* Provides methods to set the keyboard shortcuts for a specific scene.
* Should only be implemented by Controllers of Scenes so that these methods can
* Should only be implemented by controllers of scenes so that these methods can
* automatically be called inside {@link SceneContext} as soon
* as the underlying fxml file has been loaded.
* as the underlying FXML file has been loaded.
*
* @author Leon Hofmeister
* @since Envoy Client v0.3-beta

3
client/src/main/java/envoy/client/ui/SceneContext.java
View File

@ -106,8 +106,7 @@ public final class SceneContext implements EventListener {
stage.setScene(scene);
// Supply the global custom keyboard shortcuts for that scene
for (final var shortcut : GlobalKeyShortcuts.getInstance().getKeyboardShortcuts(sceneInfo))
scene.getAccelerators().put(shortcut.getKey(), shortcut.getValue());
scene.getAccelerators().putAll(GlobalKeyShortcuts.getInstance().getKeyboardShortcuts(sceneInfo));
// Supply the scene specific keyboard shortcuts
if (controller instanceof KeyboardMapping) scene.getAccelerators().putAll(((KeyboardMapping) controller).getKeyboardShortcuts());

2
client/src/main/java/envoy/client/ui/Startup.java
View File

@ -85,7 +85,7 @@ public final class Startup extends Application {
stage.setTitle("Envoy");
stage.getIcons().add(IconUtil.loadIcon("envoy_logo"));
// Configure global shortcuts used
// Configure global shortcuts
EnvoyShortcutConfig.initializeEnvoyShortcuts();
// Create scene context

6
client/src/main/java/envoy/client/ui/controller/SettingsScene.java
View File

@ -1,6 +1,6 @@
package envoy.client.ui.controller;
import java.util.*;
import java.util.Map;
import javafx.fxml.FXML;
import javafx.scene.control.*;
@ -45,8 +45,6 @@ public final class SettingsScene implements KeyboardMapping {
@Override
public Map<KeyCombination, Runnable> getKeyboardShortcuts() {
final var map = new HashMap<KeyCombination, Runnable>();
map.put(new KeyCodeCombination(KeyCode.B, KeyCombination.CONTROL_DOWN), this::backButtonClicked);
return map;
return Map.of(new KeyCodeCombination(KeyCode.B, KeyCombination.CONTROL_DOWN), this::backButtonClicked);
}
}