Fix for issue 6601: Add right click menu for main table header #8762

pratt33k · 2022-05-07T14:29:32Z

We are able to remove the column from the maintable using a right click menu. And it also updates the Entry Table in Preferences.

Inspired from #7729

Screenshots:

When the user right clicks on the maintable, a context menu (right click menu) appears with the maintable columns in it.

After clicking 'Journal/Booktitle' in the right click menu, it gets deleted from the maintable (2a) and entry table (2b) accessible through show preferences.

2a

2b

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Added Right Click Menu & Need help for Remove Column

pratt33k · 2022-05-07T14:36:41Z

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

+        TableTab tableTab = new TableTab();
+        TableTabViewModel tableTabViewModel = new TableTabViewModel(dialogService, preferencesService);
+
+//        tableTabViewModel.removeColumn(tableTab.getList().getSelectionModel().getSelectedItem());


We know how to access the column name but not sure if we can somehow use it in removeColumn( ).

Or is there a different way to remove a particular column from the preferences/entry table and maintable if we know the column name.

Any suggestions would be highly appreciated!

I would operate on the ColumnPreferences here as follows.
In MainTable you have the columns in this.columns and can map them to the MainTableColumnModel. And then you can create a new TablecolumnPreferences

this.getColumns().stream() .map(column -> (MainTableColumn<?>) column)

e.g. (see PersistenceVisualStateTable)

preferences.storeMainTableColumnPreferences(new ColumnPreferences( mainTable.getColumns().stream() .filter(col -> col instanceof MainTableColumn<?>) .map(column -> ((MainTableColumn<?>) column).getModel()) .collect(Collectors.toList()), preferences.getColumnPreferences().getColumnSortOrder()));

Thank you! We had a bit of confusion understanding how to create a new TablecolumnPreferences. We found another way to remove column though. Let us know if it works, thanks!

…lick that column right context menu

Remove column

@sj30001

(credit to @sj30001)

…/jabref into fix-for-issue-6601-test

Added Show Preferences button & an attempt to solve add column in right click menu

Siedlerchr · 2022-05-30T18:53:18Z

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

+    static MainTable mT = null;
+
+    public void show(MainTable mainTable, LibraryTab libraryTab, DialogService dialogService) {
+        System.out.println("show()");


Please remove these System.out statements...

Siedlerchr · 2022-05-30T18:54:04Z

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

+import org.jabref.logic.l10n.Localization;
+
+public class MainTableHeaderRightClickMenu extends ContextMenu {
+    static MainTable mT = null;


Why is this static? You could simply declare it as normal member variable.
I would pass the MainTable argument in the constructor and assign it there.

Please do not abbreviate variable names.

Siedlerchr · 2022-05-30T18:55:28Z

src/main/java/org/jabref/gui/preferences/table/TableTab.java

@@ -147,4 +146,8 @@ public void sortColumnDown() {
    public void addColumn() {
        viewModel.insertColumnInList();
    }
+
+    public TableView<MainTableColumnModel> getList() {


I would give this a meaningful name

Please do not use a getter for the TableView, instead inject the columnslist of the table into your new class RightClickMenu and work on that. We need to untangle all the callbacks, otherwise the classes are untestable.

calixtus · 2022-05-30T19:42:10Z

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

+    public ListView<PreferencesTab> getPreferenceTabList() {
+        return preferenceTabList;
+    }


Do not touch the PreferencesDialog. Changes must happen in the Preferences, not in the Dialog

Or perhaps make the method more generic, so a new method could open any specific preferences tab.

calixtus

Pushed the wrong button

calixtus · 2022-05-30T19:44:33Z

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

-                    .map(column -> (MainTableColumn<?>) column)
-                    .filter(column -> column.getModel().equals(columnModel))
-                    .findFirst()
-                    .ifPresent(column -> this.getSortOrder().add(column)));
+                        .map(column -> (MainTableColumn<?>) column)
+                        .filter(column -> column.getModel().equals(columnModel))
+                        .findFirst()
+                        .ifPresent(column -> this.getSortOrder().add(column)));


Please undo all your whitespace changes and use our checkstyle config for your jabref workspace.

calixtus · 2022-05-30T19:45:28Z

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

+    /**
+     * Create any single column
+     */
+    public TableColumn<BibEntryTableViewModel, ?> createColumn(MainTableColumnModel columnModel) {
+        switch (columnModel.getType()) {
+            case INDEX:
+                return createIndexColumn(columnModel);
+            case GROUPS:
+                return createGroupColumn(columnModel);
+            case FILES:
+                return createFilesColumn(columnModel);
+            case LINKED_IDENTIFIER:
+                return createIdentifierColumn(columnModel);
+            case LIBRARY_NAME:
+                return createLibraryColumn(columnModel);
+            case EXTRAFILE:
+                if (columnModel.getQualifier().isBlank()) {
+                    return createExtraFileColumn(columnModel);
+                }
+                break;
+            case SPECIALFIELD:
+                if (!columnModel.getQualifier().isBlank()) {
+                    Field field = FieldFactory.parseField(columnModel.getQualifier());
+                    if (field instanceof SpecialField) {
+                        return createSpecialFieldColumn(columnModel);
+                    } else {
+                        LOGGER.warn("Special field type '{}' is unknown. Using normal column type.", columnModel.getQualifier());
+                        return createFieldColumn(columnModel);
+                    }
+                }
+                break;
+            default:
+            case NORMALFIELD:
+                if (!columnModel.getQualifier().isBlank()) {
+                    return createFieldColumn(columnModel);
+                }
+                break;
+        }
+        return null;
+    }


If you introduce this method, you need to adjust the constructor of the MainTableColumnFactory to reduce code duplication

calixtus · 2022-05-30T19:52:21Z

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

+            // Click on the tableColumns
+            if (!(clickEvent.getTarget() instanceof StackPane)) {
+                System.out.println("Click on the tableColumns");
+                // Create radioMenuItemList from tableColumnList


Please avoid code-describing comments, instead try to write self-explaining code and put your ratilonale into a comment.

calixtus · 2022-06-04T12:43:10Z

Any update here?

ThiloteE · 2022-07-14T13:57:11Z

To ease organizational workflows I have linked the pull-request to the issue with syntax as described in https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

close

closes

closed

fix

fixes

fixed

resolve

resolves

resolved

If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request.

The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

calixtus · 2022-08-14T05:00:55Z

any update here?

calixtus · 2022-09-17T13:50:00Z

Closing this issue due to inactivity 💤
Maybe someone eventually will continue your good work already and push it forward.

pratt33k and others added 10 commits March 30, 2022 15:42

Update issue templates

6b91159

Merge branch 'JabRef:main' into main

cef3afa

Merge branch 'JabRef:main' into main

ce929a3

Add MainTableHeaderRightClickMenu class

2644a9b

Merge branch 'JabRef:main' into fix-for-issue-6601

923ad41

Add MainTableHeaderRightClickMenu.show() to MainTable class

953304e

rearrange import classes

be4cc17

Create getList() in TableTab and new MainTableHeaderRightClickMenu

22b30e9

Merge branch 'JabRef:main' into contextmenu

9e4dd73

Merge pull request #3 from pratt33k/contextmenu

4f39dfa

Added Right Click Menu & Need help for Remove Column

pratt33k commented May 7, 2022

View reviewed changes

pratt33k added 2 commits May 8, 2022 01:34

Deleted unneccessary files

331778c

Fix for checkstyle errors & Disabled optimize imports on the fly

3c13860

ThiloteE added ui maintable type: enhancement labels May 7, 2022

a1781326 and others added 10 commits May 14, 2022 20:26

Added function that will remove the column in the mainTable when we c…

e72683c

…lick that column right context menu

Fixed checkstyle errors

1bb667b

Fixed checkstyle errors & optimized deletion of column

6ad1276

Merge pull request #4 from pratt33k/fix-for-issue-6601-test

0569388

Remove column

Uncommented clear() to avoid having duplicate columns

2463878

Add link to the preferences entry table in context menu.

18c6761

(credit to @sj30001)

Merge branch 'fix-for-issue-6601-test' of https://github.com/pratt33k…

bcdf26c

…/jabref into fix-for-issue-6601-test

Created a new function to create any type of column

a02f962

Merge branch 'fix-for-issue-6601-test' of https://github.com/pratt33k…

fc3be4a

…/jabref into fix-for-issue-6601-test

Merge pull request #5 from pratt33k/fix-for-issue-6601-test

6163d4c

Added Show Preferences button & an attempt to solve add column in right click menu

pratt33k marked this pull request as ready for review May 24, 2022 03:59

pratt33k requested a review from Siedlerchr May 26, 2022 00:42

ShaunChang force-pushed the fix-for-issue-6601 branch from 6f4ffba to 6163d4c Compare May 26, 2022 10:19

Siedlerchr requested changes May 30, 2022

View reviewed changes

Siedlerchr requested a review from calixtus May 30, 2022 18:58

Siedlerchr added the status: changes required Pull requests that are not yet complete label May 30, 2022

calixtus reviewed May 30, 2022

View reviewed changes

calixtus approved these changes May 30, 2022

View reviewed changes

calixtus requested changes May 30, 2022

View reviewed changes

calixtus reviewed May 30, 2022

View reviewed changes

ThiloteE changed the title ~~Fix for issue 6601: Right click menu for main table header~~ Fix for issue 6601: Add right click menu for main table header Jul 16, 2022

calixtus closed this Sep 17, 2022

ethantr mentioned this pull request Oct 21, 2022

Fix for issue: right click menu 6601 #9271

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix for issue 6601: Add right click menu for main table header #8762

Fix for issue 6601: Add right click menu for main table header #8762

pratt33k commented May 7, 2022 •

edited by ThiloteE

Loading

pratt33k May 7, 2022

Siedlerchr May 7, 2022

pratt33k May 24, 2022

Siedlerchr May 30, 2022

Siedlerchr May 30, 2022

calixtus May 30, 2022

Siedlerchr May 30, 2022

calixtus May 30, 2022

calixtus May 30, 2022

calixtus May 30, 2022

calixtus left a comment

calixtus May 30, 2022

calixtus May 30, 2022

calixtus May 30, 2022

calixtus commented Jun 4, 2022

ThiloteE commented Jul 14, 2022

Linking a pull request to an issue using a keyword

calixtus commented Aug 14, 2022

calixtus commented Sep 17, 2022

Fix for issue 6601: Add right click menu for main table header #8762

Fix for issue 6601: Add right click menu for main table header #8762

Conversation

pratt33k commented May 7, 2022 • edited by ThiloteE Loading

Screenshots:

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

Choose a reason for hiding this comment

calixtus 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

calixtus commented Jun 4, 2022

ThiloteE commented Jul 14, 2022

Linking a pull request to an issue using a keyword

calixtus commented Aug 14, 2022

calixtus commented Sep 17, 2022

pratt33k commented May 7, 2022 •

edited by ThiloteE

Loading