Reorderable columns in maintable for groups, URI, file and eprint #5544

calixtus · 2019-10-29T23:56:27Z

JabRef did not distinguish yet between columns in mainTable and fields. Thats why I had to create an ExtraFilePseudoField-Class in one of my recent PRs. But this was an ugly hack.
JabRef should store instead in the columnPreferences not the fields, but the columns e.g. "groups" or "special:rank" or "field:author". The result would be, that the user is able to have a clickable uri-column "linked_id" in one column, and in another "field:url" the uri printed out.
Also they should finally be reorderable.

Thoughts?

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?)

calixtus · 2019-11-01T11:06:07Z

This is ready to review, but there is probably much to talk about.
I believe JabRef should automatically adapt the new settings (by default it should parse a corrupt entry in the preferences as a normal field). Then you only have to add the groups and the linked_id column. If not, it can be fixed by resetting the preferences.

Siedlerchr · 2019-11-01T17:30:00Z

src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java

+
+        public static Type parse(String text) {
+            switch (text) {
+                case "groups": return GROUPS;


You can use Enum.valueOf() to parse enum keys stored in strings (see for example the group mode union/intersection) thing.

I will look into this. A very first try did not work. I probably have to put the enum in an extra file.

You have to call .name() on the enum keys for storing.
like here:

public void setGroupViewMode(GroupViewMode mode) { put(GROUP_INTERSECT_UNION_VIEW_MODE, mode.name()); }

valueOf did not really work, as it parses only the name of the constant, but the text is different from the constant name ("linked_id" instead of "LINKED_IDENTIFIER" and "field" instead of "NORMALFIELD"). But I found another solution (with a little inspiration of stackoverflow) which should be somewhat a generic approach.

Siedlerchr · 2019-11-01T17:33:42Z

This is already a huge PR. Need to look more into detail about it. Could you maybe add a simple screen record or some screenshots how it works?
but it would also be cool if you could look into applying the saved sort order at startup (without decreasing performance that much as I had)
#4327

calixtus · 2019-11-01T18:29:11Z

This is already a huge PR. Need to look more into detail about it. Could you maybe add a simple screen record or some screenshots how it works?
but it would also be cool if you could look into applying the saved sort order at startup (without decreasing performance that much as I had)
#4327

Hi, i know, this one is huge... again. I really was surprised myself, as it did not really went as easy as I thought it would in the first place. Modifiying the MainTableFactory was easy, but the preferences really showed, that I had to distinguish between fields and columns.

There is nothing I can really show by a screen record or screen shot, as nothing really changed on the optics, besides the integration of the "very special columns" in the preferences into the TableView. The PR is all about the hard wired columns "groups", "url", "files" and "extrafile" in the ColumnFactory. I had to modify the preferences to distinguish them from the other field-columns. They follow the scheme "groups", "linked_id" or "field:author", "special:readstatus" or "extrafile:pdf". They all should now behave all the same.

(The column-headers just after startup. Note that I reordered the url column before restarting JabRef.)

(The EntryTableColumnsTab in the preferences. Note that the silly checkboxes on the right "Show groups column", "Show file column" and "Show URL column" as well as the radiobuttons for "Show DOI first" are gone integrated in the ComboBox on the bottom.)

I merged the icon for URL, URI, DOI and ePrint in one column. By clicking on the icon in that column a context menu pulls out presenting the links. The MainTableColumnModel was introduced to avoid the boilerplate of a TableColumn for use in the preferences.

It's now possible to have both kind of columns: One colum showing an icon, if clicked, opening the link "linked_id", and also a column showing just the text of the url "field:url".

I also looked into you PR #4327. I believe, my PR should integrate just fine with your modifications.

calixtus · 2019-11-01T19:23:17Z

Sorry, it does affect the sort order. Im looking into this.

Siedlerchr · 2019-11-01T19:25:19Z

Note that the sort order is not restored after opening JabRef. It is saved but not applied on startup. I had to disable it because it was a performance killer

calixtus · 2019-11-01T19:28:49Z

I just tested the current master, sort order is somehow broken too.
To be sure we are on the same page: Order of the columns means the title column is to the right (or left) of the authors column and sort order means ascending or descending?
The first one is working persistent for all the columns with my PR, the latter is not working in the current master.

calixtus · 2019-11-01T19:29:41Z

Note that the sort order is not restored after opening JabRef. It is saved but not applied on startup. I had to disable it because it was a performance killer

Aaah, i get it. Yes, ok

Siedlerchr · 2019-11-01T19:41:28Z

To be sure we are on the same page: Order of the columns means the title column is to the right (or left) of the authors column and sort order means ascending or descending?

Exactly. If you hold the shift key while pressing on the column title, you can define a primay, seconday and tertiary sort order (ascending/descending) group.

calixtus · 2019-11-02T21:58:44Z

I took the liberty to abstract a magic string on my way: ';' is now Character STRINGLIST_DELIMITER.
Im thinking of integrating the column width into the MainTableColumnModel class, so I could get rid of the TableColumnsItemModel class and make the preferences list display directly the ColumnModel.

src/main/java/org/jabref/gui/maintable/FieldColumn.java

src/main/java/org/jabref/gui/maintable/MainTableColumn.java

src/main/java/org/jabref/preferences/JabRefPreferences.java

koppor · 2019-11-03T19:44:15Z

Refs #4919 and maybe #4224.

calixtus · 2019-11-03T20:18:44Z

#4424 not yet, @Siedlerchr already asked me to give it a shot. I'm thinking of integrating the sort type into the ColumnModel and the sort order into the ColumnPreferences, so this bottleneck can be avoided.
Also the persistent ColumnPreferences should only be saved when exiting JabRef.

…_rework

calixtus · 2019-11-04T12:59:00Z

Well, I managed to get the storing and reloading of the sort criteria running and saw no greater perfomance drop. But I dont have any profiler running here, so its just a very subjective opinion. As this would include more refactoring, I would rather like to do this in another PR, as this is already almost too large.

I saw no quick and easy way to save the columnpreferences on exiting jabref.

So it's ready to review again.

tobiasdiez

This part of the code was still one of the most hacky and unorganized in JabRef's code base. It's much clearer now. Good job!

I've only a few minor remarks. It would be nice if you could also add a few tests, at least for the most complex operations (especially the preference migration as this is crucial).

src/main/java/org/jabref/gui/maintable/FieldColumn.java

src/main/java/org/jabref/gui/maintable/MainTableColumnFactory.java

src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java

src/main/java/org/jabref/gui/preferences/TableColumnsTabView.java

koppor

Some minor comments. Can be merged as is.

koppor · 2019-11-10T14:13:42Z

src/main/resources/l10n/JabRef_en.properties

@@ -2103,7 +2094,6 @@ List\ must\ not\ be\ empty.=List must not be empty.
 Add\ field\ to\ filter\ list=Add field to filter list
 Add\ formatter\ to\ list=Add formatter to list
 Filter\ List=Filter List
-New\ column=New column


Oh, this was never used?

This was formerly the name for a new column created by an constructor which was never used, as new columns always had by design the name of a field.
This constructor was removed and new columns now always get created by a specified name.

koppor · 2019-11-10T14:13:58Z

src/main/resources/l10n/JabRef_en.properties

@@ -1929,8 +1922,6 @@ Move\ panel\ down=Move panel down
 Linked\ files=Linked files
 Group\ view\ mode\ set\ to\ intersection=Group view mode set to intersection
 Group\ view\ mode\ set\ to\ union=Group view mode set to union
-Open\ %0\ URL\ (%1)=Open %0 URL (%1)
-Open\ URL\ (%0)=Open URL (%0)


Oh, these two were never used?

The identifier icon column now collects every url, uri, eprint and doi. On click, the identifier icon column ("linked_id") opens a submenu, like the file icon column. The menuitems of the submenu present the whole link of the collected identifiers (uri etc.) printed out. The removed lines were part of the tooltip, which now presents all the collected links printed out in a very brief form ("URL = ...\nURI = ...\n" etc.).
The icon column is now independet from the field column ("field:url" or "field:doi" etc.) They can print out the stored text of the field in a column.

koppor · 2019-11-10T14:15:32Z

src/main/java/org/jabref/migrations/PreferencesMigrations.java

+
+    /**
+     * The former preferences default of columns was a simple list of strings ("author;title;year;..."). Since 5.0
+     * the preferences store the type of the column too, so that the formerly hardwired columns like the graphic groups


I don't see the type of the column in the preferences. Is the comment still true?

The new form how columns are stored is divided in to parts divided by a colon. First is the column type, the second is, if existent, the qualifier. The new form is in example "groups;linked_id;field:author;field:title:special:readstatus;extrafile:chm".

koppor · 2019-11-10T14:15:59Z

src/main/java/org/jabref/migrations/PreferencesMigrations.java

+        String columnNames = preferences.get(JabRefPreferences.COLUMN_NAMES);
+
+        if (!columnNames.isEmpty() &&
+                !columnNames.contains(MainTableColumnModel.Type.NORMALFIELD.getName() // "field:"


Could you expand the comment "field:" or remove it?

koppor · 2019-11-10T14:16:30Z

src/main/java/org/jabref/gui/specialfields/SpecialFieldsPreferences.java

+
+public class SpecialFieldsPreferences {
+
+    public static final int COLUMN_RANKING_WIDTH = 5 * 16; // Width of Ranking Icon Column


Could you put the comment above the line?

tobiasdiez · 2019-11-10T19:58:13Z

Thanks again for your work on this!

calixtus · 2019-11-10T20:02:17Z

You were too quick for me, i was just working on the last remark @koppor made. But I can do this in a later PR. 😄

koppor · 2019-11-11T05:58:40Z

@calixtus: Just a follow-up PR. - Sorry that I did not see the type/name thing. Too little spaces there 😅. Refs koppor#232

Initial

2136362

calixtus changed the title ~~Reorderable Columns in Maintable for Groups, URI, File and eprint~~ [WIP] Reorderable columns in maintable for groups, URI, file and eprint Oct 30, 2019

calixtus added 5 commits October 30, 2019 15:10

Added combined identifier column

9759a5a

Removed superfluous properties

8fb708b

Added display names and refactored

090fe51

Fixed persistent state

bf4b02e

changelog

7a5a09f

calixtus added 2 commits November 1, 2019 12:18

Added columns to available set

8edfbe0

checkstyle

59551c0

calixtus marked this pull request as ready for review November 1, 2019 12:25

calixtus changed the title ~~[WIP] Reorderable columns in maintable for groups, URI, file and eprint~~ Reorderable columns in maintable for groups, URI, file and eprint Nov 1, 2019

Siedlerchr reviewed Nov 1, 2019

View reviewed changes

calixtus added 2 commits November 1, 2019 22:03

Fixed bug in persistent view

18af535

Refactored parse, rewording, cleanups

f94f87e

calixtus commented Nov 2, 2019

View reviewed changes

src/main/java/org/jabref/gui/maintable/FieldColumn.java Show resolved Hide resolved

Removed TableColumnsItemModel, cleanups

0a4e3f7

calixtus commented Nov 3, 2019

View reviewed changes

src/main/java/org/jabref/gui/maintable/MainTableColumn.java Outdated Show resolved Hide resolved

Siedlerchr reviewed Nov 3, 2019

View reviewed changes

src/main/java/org/jabref/preferences/JabRefPreferences.java Show resolved Hide resolved

calixtus added 2 commits November 3, 2019 11:45

Added migration and some minor tweaks

ae0821b

Removed superfluous method getHeaderLabel

e9caf51

Merge remote-tracking branch 'upstream/master' into maintable_columns…

63333d6

…_rework

calixtus changed the title ~~Reorderable columns in maintable for groups, URI, file and eprint~~ [WIP] Reorderable columns in maintable for groups, URI, file and eprint Nov 3, 2019

Cleanups, seperating specialFieldsPreferences, added width-binding

dd01025

calixtus changed the title ~~[WIP] Reorderable columns in maintable for groups, URI, file and eprint~~ Reorderable columns in maintable for groups, URI, file and eprint Nov 4, 2019

tobiasdiez requested changes Nov 4, 2019

View reviewed changes

calixtus added 2 commits November 4, 2019 21:19

Refactored according to remarks

68119ec

Added Tests

e34cbee

tobiasdiez added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Nov 5, 2019

koppor approved these changes Nov 10, 2019

View reviewed changes

tobiasdiez merged commit d1484f8 into JabRef:master Nov 10, 2019

calixtus deleted the maintable_columns_rework branch November 10, 2019 20:02

calixtus mentioned this pull request Dec 10, 2019

Persistent column sortorder #5730

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reorderable columns in maintable for groups, URI, file and eprint #5544

Reorderable columns in maintable for groups, URI, file and eprint #5544

calixtus commented Oct 29, 2019 •

edited

Loading

calixtus commented Nov 1, 2019 •

edited

Loading

Siedlerchr Nov 1, 2019

calixtus Nov 1, 2019

Siedlerchr Nov 1, 2019

calixtus Nov 2, 2019 •

edited

Loading

Siedlerchr commented Nov 1, 2019

calixtus commented Nov 1, 2019 •

edited

Loading

calixtus commented Nov 1, 2019

Siedlerchr commented Nov 1, 2019

calixtus commented Nov 1, 2019

calixtus commented Nov 1, 2019 •

edited

Loading

Siedlerchr commented Nov 1, 2019 •

edited

Loading

calixtus commented Nov 2, 2019

koppor commented Nov 3, 2019

calixtus commented Nov 3, 2019 •

edited by koppor

Loading

calixtus commented Nov 4, 2019

tobiasdiez left a comment

koppor left a comment

koppor Nov 10, 2019

calixtus Nov 10, 2019

koppor Nov 10, 2019

calixtus Nov 10, 2019

koppor Nov 10, 2019

calixtus Nov 10, 2019

koppor Nov 10, 2019

koppor Nov 10, 2019

tobiasdiez commented Nov 10, 2019

calixtus commented Nov 10, 2019

koppor commented Nov 11, 2019


		public class SpecialFieldsPreferences {

		public static final int COLUMN_RANKING_WIDTH = 5 * 16; // Width of Ranking Icon Column

Reorderable columns in maintable for groups, URI, file and eprint #5544

Reorderable columns in maintable for groups, URI, file and eprint #5544

Conversation

calixtus commented Oct 29, 2019 • edited Loading

calixtus commented Nov 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calixtus Nov 2, 2019 • edited Loading

Choose a reason for hiding this comment

Siedlerchr commented Nov 1, 2019

calixtus commented Nov 1, 2019 • edited Loading

calixtus commented Nov 1, 2019

Siedlerchr commented Nov 1, 2019

calixtus commented Nov 1, 2019

calixtus commented Nov 1, 2019 • edited Loading

Siedlerchr commented Nov 1, 2019 • edited Loading

calixtus commented Nov 2, 2019

koppor commented Nov 3, 2019

calixtus commented Nov 3, 2019 • edited by koppor Loading

calixtus commented Nov 4, 2019

tobiasdiez left a comment

Choose a reason for hiding this comment

koppor left a 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

tobiasdiez commented Nov 10, 2019

calixtus commented Nov 10, 2019

koppor commented Nov 11, 2019

calixtus commented Oct 29, 2019 •

edited

Loading

calixtus commented Nov 1, 2019 •

edited

Loading

calixtus Nov 2, 2019 •

edited

Loading

calixtus commented Nov 1, 2019 •

edited

Loading

calixtus commented Nov 1, 2019 •

edited

Loading

Siedlerchr commented Nov 1, 2019 •

edited

Loading

calixtus commented Nov 3, 2019 •

edited by koppor

Loading