Add option for direct attached file renaming #4887

kaiquekk · 2019-04-14T23:59:41Z

Add option on the Linked File Editor context menu to directly rename an entry's attached file. The option opens a dialog with a textfield that allows to change the name or the path of the attached file.

This PR fixes #4844

Change in CHANGELOG.md described
Tests created for changes
Manually tested changed features in running JabRef
Screenshots added in PR description (for bigger UI changes)
Ensured that the git commit message is a good one
Check documentation status (Issue created for outdated help page at help.jabref.org?)

Siedlerchr · 2019-04-15T07:14:20Z

src/main/java/org/jabref/gui/filelist/LinkedFileRenameDialogView.java

+                .load()
+                .setAsContent(this.getDialogPane());
+
+        this.getDialogPane().getButtonTypes().addAll(ButtonType.APPLY, ButtonType.CANCEL);


you can put these directly in the fxml, see some other fxml files. But don't forget the ButtonType import declaration in the fxml

Siedlerchr · 2019-04-15T07:18:09Z

Thanks for the contribution, for the dialog I think it would make more sense to actually only change the filename and not the whole path. This would be confusing And I would rename the link label to "New Filename"
https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html#getFileName--

kaiquekk · 2019-04-15T21:08:50Z

Thanks for the reply. We tried to do the proposed alterations. Now it doesn't change the whole path, just the filename.

tobiasdiez

Thanks for your contribution.

tobiasdiez · 2019-04-15T22:43:32Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

    }

+    public void renameFile() {
+        LinkedFileRenameDialogView dialog = new LinkedFileRenameDialogView(this.linkedFile);


I'm really sorry for your work, but in my opinion a simple TextInputDialog should be sufficient (instead of a custom dialog):

jabref/src/main/java/org/jabref/gui/JabRefDialogService.java

Line 132 in 9ab59d0

public Optional<String> showInputDialogAndWait(String title, String content) {

@tobiasdiez A TextInputDialog does not have a browse button....

tobiasdiez · 2019-04-15T22:46:27Z

src/main/java/org/jabref/gui/fieldeditors/LinkedFileViewModel.java

+        Path subPath = Paths.get(oldFile).subpath(0, nameCount - 1);
+        Optional<LinkedFile> editedFile = dialog.showAndWait();
+        editedFile.ifPresent(file -> {
+            String newFile = System.getProperty("file.separator") + subPath.toString() + System.getProperty("file.separator") + file.getLink();


You can use the Path.resolveSibling method to construct the new path more easily.

Add RENAME action on Standard Actions and add an item for it on the right click menu of the Base Panel. Signed-off-by: kaiquekk <[email protected]>

Signed-off-by: yurickyh <[email protected]>

Signed-off-by: kaiquekk <[email protected]>

Remove the Rename button from the main table and add it on the linked files editor table. Signed-off-by: kaiquekk <[email protected]>

Signed-off-by: yurickyh <[email protected]>

Signed-off-by: kaiquekk <[email protected]>

Change the attached file rename dialog to only alter the filename and not the whole file path. Signed-off-by: kaiquekk <[email protected]>

Signed-off-by: kaiquekk <[email protected]>

…ecreased. Signed-off-by: yurickyh <[email protected]>

…re converted to ButtonType. Signed-off-by: yurickyh <[email protected]>

Signed-off-by: kaiquekk <[email protected]>

kaiquekk · 2019-04-16T18:12:36Z

As the intention is to only rename the file and not change the link, we thought that it makes sense to only have the textfield on the dialog. So, we changed it to a simple TextInputDialog like @tobiasdiez requested.

matthiasgeiger

Thanks for the follow-up!

But now I have another request ;-) Could you please add the old file name as the default text in the TextInputDialog?

As this option is currently not available in our DialogService I would suggest to add another method Optional<String> showInputDialogWithDefaultAndWait(String title, String content, String defaultValue);

As this is directly support by Java FX's TextInputDialog the implementation of the method is super easy.

Another aspect: looking at the screenshots I think we should consider relabeling also the old "Rename file" option - because for me this is not really self-explanatory. What about "Rename file to defined pattern"? Or "Rename to pattern" to have it shorter?
@tobiasdiez, @Siedlerchr WDYT?

Best regards,
Matthias

tobiasdiez · 2019-04-17T10:53:15Z

@kaiquekk Thanks for the follow-up!
@matthiasgeiger Good suggestion. Rename file to defined pattern is ok for me (although a bit lengthy).

Signed-off-by: yurickyh <[email protected]>

…extfield the old filename. Signed-off-by: yurickyh <[email protected]>

Signed-off-by: yurickyh <[email protected]>

…ndWait. Signed-off-by: yurickyh <[email protected]>

Signed-off-by: yurickyh <[email protected]>

yurickyh · 2019-04-17T14:01:39Z

@tobiasdiez @matthiasgeiger : Thanks for your reply. We implemented what you suggested, so the text field has the old filename as its default value. Also, the 'Rename file' option was changed to 'Rename file to defined pattern' as asked.

matthiasgeiger

Perfect! Thank you very much!

tobiasdiez

Thanks again

* upstream/master: Add option for direct attached file renaming (#4887) Fixed Closing of the Shared Database Login Dialog if the user enters wrong authentication details - #4857 (#4892) # Conflicts: # src/main/resources/l10n/JabRef_en.properties

Siedlerchr reviewed Apr 15, 2019

View reviewed changes

tobiasdiez requested changes Apr 15, 2019

View reviewed changes

kaiquekk and others added 17 commits April 16, 2019 14:02

Add Rename file item on right click menu.

9f066f3

Add RENAME action on Standard Actions and add an item for it on the right click menu of the Base Panel. Signed-off-by: kaiquekk <[email protected]>

Create a function to rename the file on button click.

a4de3ce

Signed-off-by: yurickyh <[email protected]>

Implement direct file renaming

c33fa3f

Signed-off-by: kaiquekk <[email protected]>

Change Rename button location

95277f7

Remove the Rename button from the main table and add it on the linked files editor table. Signed-off-by: kaiquekk <[email protected]>

Remove useless imports.

66d637b

Signed-off-by: yurickyh <[email protected]>

Import and use the new class 'LinkedFileRenameDialogView'

b3bd9fe

Signed-off-by: yurickyh <[email protected]>

Create a fxml file for the Rename Dialog.

c5f4d5a

Signed-off-by: yurickyh <[email protected]>

Create a view class for the Rename Dialog.

bb158ec

Signed-off-by: yurickyh <[email protected]>

Create a Model for the Rename Dialog.

a490d6a

Signed-off-by: yurickyh <[email protected]>

Add changes to CHANGELOG

ad1bf8b

Signed-off-by: kaiquekk <[email protected]>

Fix no newline on the end of properties file

f7cca2f

Signed-off-by: kaiquekk <[email protected]>

Adjust dialog to change only filename

c8bc1ab

Change the attached file rename dialog to only alter the filename and not the whole file path. Signed-off-by: kaiquekk <[email protected]>

Rename link label to "New Filename"

41ab5ed

Signed-off-by: kaiquekk <[email protected]>

Add the two ButtonType ('Apply' and 'Cancel'). Also, the height was d…

83919e9

…ecreased. Signed-off-by: yurickyh <[email protected]>

The definition of the buttons was moved to the .fxml file and they we…

b9cf37c

…re converted to ButtonType. Signed-off-by: yurickyh <[email protected]>

Remove unnecessary lines

4cf8d8d

Signed-off-by: kaiquekk <[email protected]>

Simplify the code to get the new path

169af5c

Signed-off-by: kaiquekk <[email protected]>

kaiquekk force-pushed the fix-for-issue-4844 branch from 3748c65 to 169af5c Compare April 16, 2019 17:16

Change rename dialog to a simple TextInputDialog

29a3c5c

Signed-off-by: kaiquekk <[email protected]>

matthiasgeiger suggested changes Apr 16, 2019

View reviewed changes

yurickyh added 4 commits April 17, 2019 10:28

Relabel the 'Rename file' option to 'Rename file to defined pattern'.

417e654

Signed-off-by: yurickyh <[email protected]>

Use the new method showInputDialogWithDefaultAndWait and set in the t…

dd87b00

…extfield the old filename. Signed-off-by: yurickyh <[email protected]>

Implement the new method showInputDialogWithDefaultAndWait.

0448faa

Signed-off-by: yurickyh <[email protected]>

Create a new interface for the new method showInputDialogWithDefaultA…

44edc83

…ndWait. Signed-off-by: yurickyh <[email protected]>

Add the 'Rename file to defined pattern' string.

4d80247

Signed-off-by: yurickyh <[email protected]>

matthiasgeiger approved these changes Apr 17, 2019

View reviewed changes

tobiasdiez approved these changes Apr 17, 2019

View reviewed changes

tobiasdiez merged commit e230a95 into JabRef:master Apr 17, 2019

matthiasgeiger mentioned this pull request May 4, 2019

fixes remaining issues in #4844 #4950

Merged

6 tasks

Uh oh!

Add option for direct attached file renaming #4887

Add option for direct attached file renaming #4887

Uh oh!

Conversation

kaiquekk commented Apr 14, 2019

Uh oh!

Siedlerchr Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

Siedlerchr commented Apr 15, 2019

Uh oh!

kaiquekk commented Apr 15, 2019

Uh oh!

tobiasdiez left a comment

Choose a reason for hiding this comment

Uh oh!

tobiasdiez Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

Siedlerchr Apr 16, 2019

Choose a reason for hiding this comment

Uh oh!

tobiasdiez Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

kaiquekk commented Apr 16, 2019

Uh oh!

matthiasgeiger left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tobiasdiez commented Apr 17, 2019

Uh oh!

yurickyh commented Apr 17, 2019

Uh oh!

matthiasgeiger left a comment

Choose a reason for hiding this comment

Uh oh!

tobiasdiez left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

matthiasgeiger left a comment •

edited

Loading