Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#1875 #2008

Open
wants to merge 41 commits into
base: master
Choose a base branch
from
Open

#1875 #2008

wants to merge 41 commits into from

Conversation

spica198
Copy link
Collaborator

@spica198 spica198 commented Apr 10, 2024 •
edited by antares1470
Loading

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

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

Applicable Issues

#1875

@spica198 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
OrionsGuardian
OrionsGuardian requested changes Apr 10, 2024
View reviewed changes
...iew/src/au/gov/asd/tac/constellation/views/dataaccess/io/DataAccessParametersIoProvider.java Outdated Show resolved Hide resolved
...iew/src/au/gov/asd/tac/constellation/views/dataaccess/io/DataAccessParametersIoProvider.java Outdated Show resolved Hide resolved
CoreDataAccessView/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPane.java Outdated Show resolved Hide resolved
CoreDataAccessView/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPane.java Outdated Show resolved Hide resolved
CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java Outdated Show resolved Hide resolved
CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIODialog.java Outdated Show resolved Hide resolved
...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java Outdated Show resolved Hide resolved
...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java Outdated
public class RecordKeyboardShortcut {

public Optional<String> start(Stage primaryStage) {
var label = new Label();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

final

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also declare as a Label rather than var

...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java Outdated Show resolved Hide resolved
...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java Outdated
}

private KeyCombination createCombo(KeyEvent event) {
var modifiers = new ArrayList<Modifier>();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

final

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we declare as List here?

@OrionsGuardian
Copy link
Collaborator

image
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.

@antares1470 antares1470 removed a link to an issue Apr 11, 2024
Shortcuts for Data Access View Workflow templates #1875
Open
1 task
antares1470
antares1470 requested changes Apr 16, 2024
View reviewed changes
...iew/src/au/gov/asd/tac/constellation/views/dataaccess/io/DataAccessParametersIoProvider.java Outdated Show resolved Hide resolved
CoreDataAccessView/src/au/gov/asd/tac/constellation/views/dataaccess/panes/DataAccessPane.java Outdated Show resolved Hide resolved
CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java Outdated Show resolved Hide resolved
CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java Outdated Show resolved Hide resolved
CoreUtilities/src/au/gov/asd/tac/constellation/utilities/genericjsonio/JsonIO.java Outdated Show resolved Hide resolved
...ties/src/au/gov/asd/tac/constellation/utilities/keyboardshortcut/RecordKeyboardShortcut.java Outdated
public class RecordKeyboardShortcut {

public Optional<String> start(Stage primaryStage) {
var label = new Label();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also declare as a Label rather than var

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

private KeyCombination createCombo(KeyEvent event) {
var modifiers = new ArrayList<Modifier>();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we declare as List here?

@spica198
Copy link
Collaborator Author

image 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.

@spica198 spica198 closed this Apr 16, 2024
@spica198 spica198 reopened this Apr 16, 2024
@OrionsGuardian
Copy link
Collaborator

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
Copy link
Collaborator

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:

image

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.

@OrionsGuardian OrionsGuardian added the verbose-logging test code in CI with verbose output label Jul 17, 2024
@spica198
#1875
26a643e 
review fixes
@spica198
#1875
93b394b 
review fixes
@spica198
Copy link
Collaborator Author

image

The warning message isn't being removed when you later choose an unused shortcut after first choosing a shortcut which is being used.

Also, while typing in a keystroke for a shortcut ... if you click 'Cancel', it is still accepting that keystroke as the new shortcut.

@spica198
Copy link
Collaborator Author

Updated with review fixes

@spica198
#1875
2a71dfc 
review fixes
@spica198
Copy link
Collaborator Author

saveJsonPreferencesWithKeyboardShortcut

Not able to reproduce from my local.. will keep trying though

@spica198
Copy link
Collaborator Author

If you leave the name empty, but do provide a keyboard shortcut and click OK, it will create an entry using a default name comprising of your username and the current date. It should not save anything if no name is provided.

That was an existing functionality here.. If no name is provided, save a template with default name which will be formated using username and the current date

@spica198
#1875
57682ec 
Review fixes
@spica198
Copy link
Collaborator Author

When entering a keyboard shortcut, after typing in your shortcut, if you then press instead of clicking OK, it will close the dialog and treat the key as the keyboard shortcut.

Fixed

@spica198
Copy link
Collaborator Author

The 'Keyboard Shortcut' popup dialog always appears on the primary display screen. When Constellation is run on a different screen, the dialog should appear on the same screen that Constellation is using.

I would say, Constellation had been behaving this way.

To fix for this screen selection is being bit tricky for me.. I use MousePointer but it doesn't go the expected way.. I would suggest to create a new card for this as it had been behaving like this before this change.

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Oct 22, 2024

Quality Gate Failed Quality Gate failed

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

See analysis details on SonarCloud

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 28, 2024

Quality Gate Failed Quality Gate failed

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

See analysis details on SonarQube Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OrionsGuardian OrionsGuardian OrionsGuardian requested changes

@Delphinus8821 Delphinus8821 Delphinus8821 requested changes

@antares1470 antares1470 antares1470 requested changes

Assignees
No one assigned
Labels
verbose-logging test code in CI with verbose output
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@spica198 @OrionsGuardian @antares1470 @Delphinus8821