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

Tooltips for entry editor fields #6046

Merged
merged 18 commits into from
Mar 20, 2020
Merged

Tooltips for entry editor fields #6046

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
9a12d35
issue 5847
ShikunXiong Feb 29, 2020
a31f8ae
fix PR#6046 problems
ShikunXiong Mar 5, 2020
336b8c9
Update StandardField.java
ShikunXiong Mar 5, 2020
efc9ed3
Update FieldNameLabel.java
ShikunXiong Mar 5, 2020
7b38f6a
Code style update
ShikunXiong Mar 5, 2020
5876d28
update Localization
ShikunXiong Mar 5, 2020
0346795
Localization updated
ShikunXiong Mar 6, 2020
49ad3a2
Localization updated
ShikunXiong Mar 6, 2020
4e8c29f
Update JabRef_en.properties
ShikunXiong Mar 6, 2020
a9ae449
Update FieldNameLabel.java
ShikunXiong Mar 6, 2020
15d7b99
Update setTip() method in FieldNameLabel.java
ShikunXiong Mar 6, 2020
f3611a2
Update FieldNameLabel.java
ShikunXiong Mar 6, 2020
a6ec7aa
Codestyle problems fixed
ShikunXiong Mar 6, 2020
67790bc
Add descriptions for more fields
tobiasdiez Mar 20, 2020
b46c5be
Squashed commit of the following:
tobiasdiez Mar 20, 2020
824fd15
Add changelog entry
tobiasdiez Mar 20, 2020
5e9701d
Merge remote-tracking branch 'remotes/origin/master' into issue
tobiasdiez Mar 20, 2020
8855967
Fix merge conflict
tobiasdiez Mar 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/org/jabref/gui/entryeditor/FieldsEditorTab.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ private void setupPanel(BibEntry entry, boolean compressed) {
fieldEditor.bindToEntry(entry);

editors.put(field, fieldEditor);
labels.add(new FieldNameLabel(field));
labels.add(new FieldNameLabel(field, field.getName()));
ShikunXiong marked this conversation as resolved.
Show resolved Hide resolved
}

ColumnConstraints columnExpand = new ColumnConstraints();
Expand Down
25 changes: 24 additions & 1 deletion src/main/java/org/jabref/gui/fieldeditors/FieldNameLabel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,39 @@
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.control.Label;
import javafx.scene.control.Tooltip;

import org.jabref.logic.l10n.Localization;
import org.jabref.model.entry.field.Field;
import org.jabref.model.entry.field.StandardField;

public class FieldNameLabel extends Label {
private Tooltip tip;

public FieldNameLabel(Field field) {
public FieldNameLabel(Field field, String name) {
super(field.getDisplayName());

setPadding(new Insets(4, 0, 0, 0));
setAlignment(Pos.CENTER);
setPrefHeight(Double.POSITIVE_INFINITY);
setTip(name);
}

public void setTip(String name) {
tip = new Tooltip();
if (StandardField.AUTHOR.getName().equals(name)) {
Copy link
Member

@calixtus calixtus Mar 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Is there a reason for testing field.getName() instead of field directly?
I think you could use field as an argument for setTip and test field instead.

Suggested change
if (StandardField.AUTHOR.getName().equals(name)) {
switch (field) {
case AUTHOR:
tip.setText(etc...);
break;
case BIBTEXKEY:
etc...
default:
break;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think you could use field as an argument for setTip and test field instead

Thank you for the suggestion. I have changed it.

tip.setText(Localization.lang("AUTHOR TIP"));
} else if (StandardField.BIBTEXKEY.getName().equals(name)) {
tip.setText(Localization.lang("BIBTEXKEY TIP"));
} else if (StandardField.JOURNAL.getName().equals(name)) {
tip.setText(Localization.lang("JOURNAL TIP"));
} else if (StandardField.TITLE.getName().equals(name)) {
tip.setText(Localization.lang("TITLE TIP"));
} else if (StandardField.YEAR.getName().equals(name)) {
tip.setText(Localization.lang("YEAR TIP"));
Copy link
Member

Choose a reason for hiding this comment

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

Tests are failing because the l10n-key should be the same as the value.
E.g.: tip.setText(Localization.lang("Multiple authors separated with 'and', e.g. author1 and author2"));

} else {
return;
}
this.setTooltip(tip);
Copy link
Contributor

Choose a reason for hiding this comment

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

Currently, tooltips are only added for five fields (author, journal, title, year and key). It would be really great, if the other fields (e.g. in the other tabs of the entry editor) would get tooltips as well. Examples: date, editor, DOI, pages, number, language, volume, urldate, ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, what I made is just a start.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is really good to hear! Thank you for your effort! :)

}
}
1 change: 1 addition & 0 deletions src/main/java/org/jabref/model/entry/field/StandardField.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ public enum StandardField implements Field {
ARCHIVEPREFIX("archiveprefix"),
ASSIGNEE("assignee", FieldProperty.PERSON_NAMES),
AUTHOR("author", FieldProperty.PERSON_NAMES),
BIBTEXKEY("bibtexkey"),
BOOKAUTHOR("bookauthor", FieldProperty.PERSON_NAMES),
BOOKPAGINATION("bookpagination", FieldProperty.PAGINATION),
BOOKSUBTITLE("booksubtitle", FieldProperty.BOOK_NAME),
Expand Down
6 changes: 6 additions & 0 deletions src/main/resources/l10n/JabRef_en.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2117,3 +2117,9 @@ Entry\ type\ cannot\ be\ empty.\ Please\ enter\ a\ name.=Entry type cannot be em
Field\ cannot\ be\ empty.\ Please\ enter\ a\ name.=Field cannot be empty. Please enter a name.
Shared\ database=Shared database
Lookup=Lookup

AUTHOR\ TIP=Multiple authors separated with 'and', e.g. author1 and author2
BIBTEXKEY\ TIP =[First author'last name][Article year] e.g. Jones2020
JOURNAL\ TIP=The name of the journal
TITLE\ TIP=The title of the article
YEAR\ TIP=The year of publication, e.g. 2005