#1875 #2008

spica198 · 2024-04-10T00:01:11Z

Prerequisites

Reviewed the checklist
Reviewed feedback from the "Sonar Cloud" bot. Note that you have to wait
for the "CI / Unit Tests") to complete first. Failed Unit tests can be
debugged by adding the label "verbose logging" to the GitHub PR.

Description of the Change

In the Data Access View, map keyboard shortcuts to templates. Default is from ctrl-1 to ctrl-5 and after that user can provide shortcut of their choice

Alternate Designs

Why Should This Be In Core?

Benefits

Possible Drawbacks

Verification Process

Save a template in Data acccess view with keyboard shortcut
Should be able to load template by pressing keyboard shortcut

Applicable Issues

#1875

...iew/src/au/gov/asd/tac/constellation/views/dataaccess/io/DataAccessParametersIoProvider.java

CoreDataAccessView/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPane.java

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIODialog.java

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

OrionsGuardian · 2024-04-10T04:11:34Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

+public class RecordKeyboardShortcut {
+
+    public Optional<String> start(Stage primaryStage) {
+        var label = new Label();


can we also declare as a Label rather than var

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

OrionsGuardian · 2024-04-10T04:11:55Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

+    }
+
+    private KeyCombination createCombo(KeyEvent event) {
+        var modifiers = new ArrayList<Modifier>();


can we declare as List here?

OrionsGuardian · 2024-04-10T04:59:37Z

Each new template that I save has a Ctrl 1 prefix attached to it.
How do we set a differently numbered shortcut when saving the template ?
Pressing Ctrl 1 does correctly activate the first entry that has Ctrl 1 as it's prefix.

...iew/src/au/gov/asd/tac/constellation/views/dataaccess/io/DataAccessParametersIoProvider.java

CoreDataAccessView/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPane.java

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java

antares1470 · 2024-04-16T03:53:47Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

+public class RecordKeyboardShortcut {
+
+    public Optional<String> start(Stage primaryStage) {
+        var label = new Label();


can we also declare as a Label rather than var

antares1470 · 2024-04-16T03:54:10Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

+    }
+
+    private KeyCombination createCombo(KeyEvent event) {
+        var modifiers = new ArrayList<Modifier>();


can we declare as List here?

spica198 · 2024-04-16T04:06:00Z

Each new template that I save has a Ctrl 1 prefix attached to it. How do we set a differently numbered shortcut when saving the template ? Pressing Ctrl 1 does correctly activate the first entry that has Ctrl 1 as it's prefix.

OrionsGuardian · 2024-04-16T05:45:39Z

The Additional Information section of ticket #1875 suggests the functionality should allow the user to assign the shortcuts to the templates they want to use.
Currently, it will assign shortcuts (1 through to 5) to the first 5 templates saved.
Saving future templates won't assign any further shortcuts until one of the previous templates are deleted.

The functionality should allow the user to select a shortcut number when saving a template, and also reassign/remove shortcut numbers when loading templates.

OrionsGuardian · 2024-04-17T23:59:42Z

The core functionality now seems to be working fine, but it feels like too many popup dialogs appearing to achieve this.
I've mocked up a sample alternative layout:

So you can optionally set a shortcut, where it pops up the dialog to get the keystroke, then returns to this Saving dialog.
Use a warning symbol (!) to indicate that the chosen Shortcut is already being used.
The orange warning message can either be shown as a line in the dialog, or set as a tooltip for the warning symbol.
Then, when you click OK it uses the shortcut (if one was chosen), and removes the shortcut from any old template that was using it.

…ow-templates

CoreDataAccessView/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPane.java

.../test/unit/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPaneNGTest.java

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java

...d/tac/constellation/utilities/keyboardshortcut/TextInputDialogWithKeybordShortcutNGTest.java

sonarqubecloud · 2025-02-25T01:16:01Z

Quality Gate failed

Failed conditions
72.5% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

Delphinus8821 · 2025-02-27T22:16:31Z

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2024 Australian Signals Directorate
+ * Copyright 2010-2021 Australian Signals Directorate


Update copyright to 2025

Delphinus8821 · 2025-02-27T22:16:47Z

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/SystemUtilities.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright 2010-2024 Australian Signals Directorate


Update copyright to 2025

Delphinus8821 · 2025-02-27T22:17:02Z

CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java

@@ -182,6 +191,22 @@ public static void saveJsonPreferences(final Optional<String> saveDir, final Opt
        }
    }

+    public static Optional<String> getDefaultKeyboardShortcut(File preferenceDirectory) {


parameter final

Delphinus8821 · 2025-02-27T22:18:11Z

...ilities/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/KeyPressLabelDialog.java

@@ -0,0 +1,136 @@
+/*
+ * Copyright 2010-2024 Australian Signals Directorate


Update copyright year

Delphinus8821 · 2025-02-27T22:18:41Z

...ilities/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/KeyPressLabelDialog.java

+import org.apache.commons.lang3.StringUtils;
+
+/**
+ *


Can a description of what the class does be added?

Delphinus8821 · 2025-02-27T22:18:59Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

@@ -0,0 +1,130 @@
+/*
+ * Copyright 2010-2024 Australian Signals Directorate


Update copyright year

Delphinus8821 · 2025-02-27T22:19:20Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

+import org.apache.commons.lang3.StringUtils;
+
+/**
+ *


Add description for the class

Delphinus8821 · 2025-02-27T22:19:30Z

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java

+    }
+
+    //For unit test
+    public RecordKeyboardShortcut(KeyPressLabelDialog td) {


parameter final

Delphinus8821 · 2025-02-27T22:19:53Z

...gov/asd/tac/constellation/utilities/keyboardshortcut/TextInputDialogWithKeybordShortcut.java

@@ -0,0 +1,266 @@
+/*
+ * Copyright 2010-2024 Australian Signals Directorate


Update copyright year

Delphinus8821 · 2025-02-27T22:20:04Z

...gov/asd/tac/constellation/utilities/keyboardshortcut/TextInputDialogWithKeybordShortcut.java

+import org.apache.commons.lang3.StringUtils;
+
+/**
+ *


Add description for class

#1875

c336aa4

spica198 linked an issue Apr 10, 2024 that may be closed by this pull request

Shortcuts for Data Access View Workflow templates #1875

Open

1 task

spica198 requested a review from OrionsGuardian April 10, 2024 00:01

OrionsGuardian requested changes Apr 10, 2024

View reviewed changes

spica198 added 2 commits April 11, 2024 10:47

#1875

81a2b48

#1875

b0e34ee

antares1470 removed a link to an issue Apr 11, 2024

Shortcuts for Data Access View Workflow templates #1875

Open

1 task

antares1470 requested review from antares1470 and Delphinus8821 April 16, 2024 03:45

antares1470 requested changes Apr 16, 2024

View reviewed changes

#1875

9607b0f

spica198 closed this Apr 16, 2024

spica198 reopened this Apr 16, 2024

spica198 added 5 commits April 17, 2024 15:30

#1875

9e25b39

#1875

68f6963

#1875

ae7d9d2

#1875

6b6d54c

#1875

33c5fd9

spica198 added 5 commits June 3, 2024 11:47

Merge branch 'master' into 1875-shortcuts-for-data-access-view-workfl…

dedc328

…ow-templates

#1875

0f1f8f2

#1875

c5cccf9

#1875

b26e676

Merge branch 'master' into 1875-shortcuts-for-data-access-view-workfl…

03105f5

…ow-templates

OrionsGuardian added the verbose-logging test code in CI with verbose output label Jul 17, 2024

spica198 added 2 commits August 6, 2024 10:29

#1875

61ae599

#1875

e4c7f74

spica198 added 18 commits December 18, 2024 13:42

#1875

60b4883

#1875

9a120cc

#1875

27e82d2

#1875

367587c

#1875

6aeb92e

#1875

a5e50c1

#1875

7698733

#1875

28ec150

#1875

f85abf8

#1875

3dbf014

#1875

7cc9348

#1875

cafa28f

#1875

12f07ed

#1875

bf694c2

#1875

65ed812

#1875

b42a44d

Merge branch 'master' into 1875-shortcuts-for-data-access-view-workfl…

868730d

…ow-templates

#1875

4141b60

OrionsGuardian requested changes Jan 14, 2025

View reviewed changes

spica198 added 9 commits January 21, 2025 11:07

#1875

48fb7e1

#1875

aff875d

#1875

508e471

#1875

41cc5b6

#1875

170ff95

#1875

27d2cfb

#1875

a8d1128

#1875

0a266b4

#1875

a9be3fe

Delphinus8821 requested changes Feb 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#1875 #2008

#1875 #2008

spica198 commented Apr 10, 2024 •

edited by antares1470

Loading

OrionsGuardian Apr 10, 2024

antares1470 Apr 16, 2024

OrionsGuardian Apr 10, 2024

antares1470 Apr 16, 2024

OrionsGuardian commented Apr 10, 2024

antares1470 Apr 16, 2024

antares1470 Apr 16, 2024

spica198 commented Apr 16, 2024

OrionsGuardian commented Apr 16, 2024

OrionsGuardian commented Apr 17, 2024

sonarqubecloud bot commented Feb 25, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

Delphinus8821 Feb 27, 2025

		@@ -0,0 +1,114 @@
		/*
		* Copyright 2010-2024 Australian Signals Directorate

		@@ -0,0 +1,136 @@
		/*
		* Copyright 2010-2024 Australian Signals Directorate

		@@ -0,0 +1,130 @@
		/*
		* Copyright 2010-2024 Australian Signals Directorate

		@@ -0,0 +1,266 @@
		/*
		* Copyright 2010-2024 Australian Signals Directorate

#1875 #2008

Are you sure you want to change the base?

#1875 #2008

Conversation

spica198 commented Apr 10, 2024 • edited by antares1470 Loading

Prerequisites

Description of the Change

Alternate Designs

Why Should This Be In Core?

Benefits

Possible Drawbacks

Verification Process

Applicable Issues

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OrionsGuardian commented Apr 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spica198 commented Apr 16, 2024

OrionsGuardian commented Apr 16, 2024

OrionsGuardian commented Apr 17, 2024

sonarqubecloud bot commented Feb 25, 2025

Quality Gate failed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spica198 commented Apr 10, 2024 •

edited by antares1470

Loading