Display "Show in Folder" notification after exporting entries

[HoussemNasri]

Is your suggestion for improvement related to a problem? Please describe.
Users will likely wanna open the file they exported as soon as possible, it's common among other applications to have this feature so implementing it will improve user experience because users expect it

Describe the solution you'd like
solution 1: show a notification bar with a button to open the directory where the file was exported (Like Typora)
solution 2: open the exported file immediately (Like MS Word)

Additional context
Screenshot from Typora

[LingZhang22]

Hi, I'm Ling and I am a student majoring in computer science. I am new to open source and am interested in this issue. I have some basic knowledge of Java and Web development. Could you give me some suggestions on where to start? Thanks a lot!

[k3KAW8Pnf7mkmdSMPHz27]

Hello @LingZhang22 !
I am not too familiar with these parts of the code, and not sure how I'd put the pieces together, but I'd start looking at the export command (which also happens to be based on the command design pattern).
Then look at how other parts of the code is using the JabRef dialog service (or its interface), e.g., by go to declaration or usage or find everywhere.
Probably you'll need the JabRefDesktop at some point as well

[LingZhang22]

Hi @k3KAW8Pnf7mkmdSMPHz27, thank you so much for your guide! I will look into those code and info!

[LingZhang22]

Hi @k3KAW8Pnf7mkmdSMPHz27 !
I created a PR for this issue. However, I think that this fix might need some improvement.

Firstly, the layout of the dialog is not well designed. The dialog pops up in the center of the main window as follows. It might be better if show a notification bar like Typora on the top of the window. But I didn't find an API for that. Could you give me some hints on where I can find such an API or how should I write such a function?

Secondly, when the users click "YES", the saved file folder rather than the file will pop up. However, I also didn't find that API. Could you please give me some hints for that too?

Many thanks!

[ThiloteE]

Maybe a popover would be suitable for this? https://github.com/controlsfx/controlsfx/wiki/ControlsFX-Features#popover

[LingZhang22]

@ThiloteE Thanks! I will look into this material!

[Siedlerchr]

For the change detection dialog we use a NotificationPane from Controlsfx, that looks like one in Typora https://controlsfx.github.io/features/notificationspane/

[LingZhang22]

Hi @Siedlerchr, thank you for your instruction. And I got stuck, is it possible to get some help to go forward?

What I did so far:
I wrap the splitPane (which is the center of the JabRefFrame) into the NotificationPane. (And I tested that the bar can show on the page if I made some actions in the JabRefFrame class. )

My question:
In the ExportCommand class, I want to call and add actions to the notificationPane when the user click save. But I don't know how to can I get the notificationPane instance. Is it possible to get a notificationPane instance from the JabRefFrame in the ExportCommand or I am in the wrong direction?

Thanks a lot!

[k3KAW8Pnf7mkmdSMPHz27]

In the ExportCommand class, I want to call and add actions to the notificationPane when the user click save.

If I am understanding you correctly, you are creating the notificationpane inside of JabRefFrame, in which case you probably want to pass it as an additional argument to the ExportCommand's constructor

[LingZhang22]

Hi @k3KAW8Pnf7mkmdSMPHz27 Thank you so much for your guide!

I have implemented the NotificationPane for the light theme and dark theme.

When I clicked the save button, the notification bar will show on the top.
And if I click open, the folder will open with the file selected and then the bar will disappear.
In addition, if the user doesn't take action, the notification bar will disappear in 10 seconds.

In light theme:
Step1:

Step2：

Step3:

In dark theme：
Step1:

Step2:

Step3:

I have pushed my commits to GitHub. I am not sure whether there is something wrong or missing. If there is, could you please let me know? I will modify it.

Thanks!

[ThiloteE]

I think the wording could be phrased slightly different:

Instead of "Do you want to open the file in folder?"
it could be: "Press "open" to reveal the folder holding the saved file"
(or shorter: "Open the folder holding the saved file"),
since not actually the file is opened, but rather the folder :-)

[LingZhang22]

@ThiloteE Thank you for your suggestions. I have changed the text. Thanks :)