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

Added icon picker in group dialog #7776

Merged
merged 16 commits into from
Aug 17, 2021
Merged

Added icon picker in group dialog #7776

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e89a710
Add a button for icon picker in GroupDialog.fxml, and leave openIconP…
NicholasBian May 21, 2021
0c5c8d3
Add a modal dialog box when clicking the icon picker button, the cont…
NicholasBian May 22, 2021
ec4c63f
Modified the structure of the icon picker modal box to make it scroll.
NicholasBian May 23, 2021
60b873d
Merge remote-tracking branch 'origin/main'
NicholasBian May 24, 2021
eafdca5
Use TabPane to restructure the icon picker modal box, show all icon b…
NicholasBian May 26, 2021
dc3fd82
Finished the icon picker function and waiting to be tested.
NicholasBian May 27, 2021
1bb2f36
Update CHANGELOG.md
BasilDimopoulos May 30, 2021
1b887c7
Merge remote-tracking branch 'upstream/main' into icon-picker
calixtus Aug 16, 2021
208941c
Fixed imports, applied intellij suggestions
calixtus Aug 16, 2021
7f8929c
Integrated controlsfx GridView
calixtus Aug 16, 2021
0369a2b
WIP
calixtus Aug 16, 2021
1b64deb
Fixed old workaround
calixtus Aug 16, 2021
656b154
Added searchbox and converted stage to popover
calixtus Aug 17, 2021
33b36d2
Added borders to icons, fixed changelog and l10n
calixtus Aug 17, 2021
d1ec503
Removed corner radius for consistency
calixtus Aug 17, 2021
ec0b7e8
Load ikons directly from the IkonProvider
calixtus Aug 17, 2021
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We added the option to copy the DOI of an entry directly from the context menu copy submenu. [#7826](https://github.com/JabRef/jabref/issues/7826)
- We added a fulltext search feature. [#2838](https://github.com/JabRef/jabref/pull/2838)
- We added unprotect_terms to the list of bracketed pattern modifiers [#7826](https://github.com/JabRef/jabref/pull/7960)
- We added an icon picker in group edit dialog. [#6142](https://github.com/JabRef/jabref/issues/6142)

### Changed

Expand Down
9 changes: 8 additions & 1 deletion src/main/java/org/jabref/gui/groups/GroupDialog.fxml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,14 @@
<HBox spacing="10.0">
<VBox HBox.hgrow="ALWAYS">
<Label text="%Icon"/>
<TextField fx:id="iconField"/>
<HBox>
<TextField fx:id="iconField"/>
<Button fx:id="iconPickerButton" onAction="#openIconPicker" styleClass="icon-button,narrow">
<graphic>
<JabRefIconView glyph="SELECT_ICONS"/>
</graphic>
</Button>
</HBox>
</VBox>
<VBox layoutX="10.0" layoutY="10.0" minWidth="130.0" maxWidth="130.0" prefWidth="130.0">
<Label text="%Color"/>
Expand Down
146 changes: 136 additions & 10 deletions src/main/java/org/jabref/gui/groups/GroupDialogView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,29 @@
import java.util.EnumSet;

import javafx.application.Platform;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.collections.transformation.FilteredList;
import javafx.event.ActionEvent;
import javafx.fxml.FXML;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.control.Button;
import javafx.scene.control.ButtonType;
import javafx.scene.control.CheckBox;
import javafx.scene.control.ColorPicker;
import javafx.scene.control.ComboBox;
import javafx.scene.control.RadioButton;
import javafx.scene.control.TextField;
import javafx.scene.layout.Border;
import javafx.scene.layout.BorderStroke;
import javafx.scene.layout.BorderStrokeStyle;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Color;

import org.jabref.gui.DialogService;
import org.jabref.gui.icon.IconTheme;
import org.jabref.gui.util.BaseDialog;
import org.jabref.gui.util.IconValidationDecorator;
import org.jabref.gui.util.ViewModelListCellFactory;
Expand All @@ -28,13 +40,48 @@

import com.airhacks.afterburner.views.ViewLoader;
import de.saxsys.mvvmfx.utils.validation.visualization.ControlsFxVisualizer;
import org.controlsfx.control.GridCell;
import org.controlsfx.control.GridView;
import org.controlsfx.control.PopOver;
import org.controlsfx.control.textfield.CustomTextField;
import org.kordamp.ikonli.Ikon;
import org.kordamp.ikonli.javafx.FontIcon;
import org.kordamp.ikonli.materialdesign2.MaterialDesignA;
import org.kordamp.ikonli.materialdesign2.MaterialDesignB;
import org.kordamp.ikonli.materialdesign2.MaterialDesignC;
import org.kordamp.ikonli.materialdesign2.MaterialDesignD;
import org.kordamp.ikonli.materialdesign2.MaterialDesignE;
import org.kordamp.ikonli.materialdesign2.MaterialDesignF;
import org.kordamp.ikonli.materialdesign2.MaterialDesignG;
import org.kordamp.ikonli.materialdesign2.MaterialDesignH;
import org.kordamp.ikonli.materialdesign2.MaterialDesignI;
import org.kordamp.ikonli.materialdesign2.MaterialDesignJ;
import org.kordamp.ikonli.materialdesign2.MaterialDesignK;
import org.kordamp.ikonli.materialdesign2.MaterialDesignL;
import org.kordamp.ikonli.materialdesign2.MaterialDesignM;
import org.kordamp.ikonli.materialdesign2.MaterialDesignN;
import org.kordamp.ikonli.materialdesign2.MaterialDesignO;
import org.kordamp.ikonli.materialdesign2.MaterialDesignP;
import org.kordamp.ikonli.materialdesign2.MaterialDesignQ;
import org.kordamp.ikonli.materialdesign2.MaterialDesignR;
import org.kordamp.ikonli.materialdesign2.MaterialDesignS;
import org.kordamp.ikonli.materialdesign2.MaterialDesignT;
import org.kordamp.ikonli.materialdesign2.MaterialDesignU;
import org.kordamp.ikonli.materialdesign2.MaterialDesignV;
import org.kordamp.ikonli.materialdesign2.MaterialDesignW;
import org.kordamp.ikonli.materialdesign2.MaterialDesignX;
import org.kordamp.ikonli.materialdesign2.MaterialDesignY;
import org.kordamp.ikonli.materialdesign2.MaterialDesignZ;

import static java.util.EnumSet.allOf;

public class GroupDialogView extends BaseDialog<AbstractGroup> {

// Basic Settings
@FXML private TextField nameField;
@FXML private TextField descriptionField;
@FXML private TextField iconField;
@FXML private Button iconPickerButton;
@FXML private ColorPicker colorField;
@FXML private ComboBox<GroupHierarchyType> hierarchicalContextCombo;

Expand Down Expand Up @@ -70,7 +117,11 @@ public class GroupDialogView extends BaseDialog<AbstractGroup> {
private final ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer();
private final GroupDialogViewModel viewModel;

public GroupDialogView(DialogService dialogService, BibDatabaseContext currentDatabase, PreferencesService preferencesService, AbstractGroup editedGroup, GroupDialogHeader groupDialogHeader) {
public GroupDialogView(DialogService dialogService,
BibDatabaseContext currentDatabase,
PreferencesService preferencesService,
AbstractGroup editedGroup,
GroupDialogHeader groupDialogHeader) {
viewModel = new GroupDialogViewModel(dialogService, currentDatabase, preferencesService, editedGroup, groupDialogHeader);

ViewLoader.view(this)
Expand All @@ -91,6 +142,7 @@ public GroupDialogView(DialogService dialogService, BibDatabaseContext currentDa
getDialogPane().getButtonTypes().setAll(ButtonType.OK, ButtonType.CANCEL);

final Button confirmDialogButton = (Button) getDialogPane().lookupButton(ButtonType.OK);
confirmDialogButton.disableProperty().bind(viewModel.validationStatus().validProperty().not());
// handle validation before closing dialog and calling resultConverter
confirmDialogButton.addEventFilter(ActionEvent.ACTION, viewModel::validationHandler);
}
Expand Down Expand Up @@ -168,15 +220,6 @@ public void initialize() {
validationVisualizer.initVisualization(viewModel.texGroupFilePathValidatonStatus(), texGroupFilePath);
nameField.requestFocus();
});

// Binding to the button throws a NPE, since it doesn't exist yet. Working around.
viewModel.validationStatus().validProperty().addListener((obs, _oldValue, validationStatus) -> {
if (validationStatus) {
getDialogPane().lookupButton(ButtonType.OK).setDisable(false);
} else {
getDialogPane().lookupButton(ButtonType.OK).setDisable(true);
}
});
}

@FXML
Expand All @@ -188,4 +231,87 @@ private void texGroupBrowse() {
private void openHelp() {
viewModel.openHelpPage();
}

@FXML
private void openIconPicker() {
ObservableList<Ikon> ikonList = FXCollections.observableArrayList();
FilteredList<Ikon> filteredList = new FilteredList<>(ikonList);

ikonList.addAll(allOf(MaterialDesignA.class));
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
ikonList.addAll(allOf(MaterialDesignA.class));
Set<IkonProvider<Ikon>> result = ServiceLoader.load(IkonProvider.class.getModule().getLayer(), IkonProvider.class).stream()
.filter(provider -> provider.get().getClass() != JabrefIconProvider.class)
.map(Provider::get).collect(Collectors.toSet());
for (IkonProvider provider: result) {
ikonList.addAll(allOf(provider.getIkon()));
}

Copy link
Member

Choose a reason for hiding this comment

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

Something seems to be odd. Works with eclipse, but not with gradlew / javac

                                                      .map(ServiceLoader.Provider::get).collect(Collectors.toSet());
                                                                                               ^
    (argument mismatch; Collector<IkonProvider<Ikon>,CAP#2,Set<IkonProvider<Ikon>>> cannot be converted to Collector<? super IkonProvider,CAP#2,Set<IkonProvider<Ikon>>>)
  where R,A,T#1,T#2 are type-variables:
    R extends Object declared in method <R,A>collect(Collector<? super T#1,A,R>)
    A extends Object declared in method <R,A>collect(Collector<? super T#1,A,R>)
    T#1 extends Object declared in interface Stream
    T#2 extends Object declared in method <T#2>toSet()
  where CAP#1,CAP#2 are fresh type-variables:
    CAP#1 extends Object from capture of ?
    CAP#2 extends Object from capture of ?```

ikonList.addAll(allOf(MaterialDesignB.class));
ikonList.addAll(allOf(MaterialDesignC.class));
ikonList.addAll(allOf(MaterialDesignD.class));
ikonList.addAll(allOf(MaterialDesignE.class));
ikonList.addAll(allOf(MaterialDesignF.class));
ikonList.addAll(allOf(MaterialDesignG.class));
ikonList.addAll(allOf(MaterialDesignI.class));
ikonList.addAll(allOf(MaterialDesignJ.class));
ikonList.addAll(allOf(MaterialDesignH.class));
ikonList.addAll(allOf(MaterialDesignK.class));
ikonList.addAll(allOf(MaterialDesignL.class));
ikonList.addAll(allOf(MaterialDesignM.class));
ikonList.addAll(allOf(MaterialDesignN.class));
ikonList.addAll(allOf(MaterialDesignO.class));
ikonList.addAll(allOf(MaterialDesignP.class));
ikonList.addAll(allOf(MaterialDesignQ.class));
ikonList.addAll(allOf(MaterialDesignR.class));
ikonList.addAll(allOf(MaterialDesignS.class));
ikonList.addAll(allOf(MaterialDesignT.class));
ikonList.addAll(allOf(MaterialDesignU.class));
ikonList.addAll(allOf(MaterialDesignV.class));
ikonList.addAll(allOf(MaterialDesignW.class));
ikonList.addAll(allOf(MaterialDesignX.class));
ikonList.addAll(allOf(MaterialDesignY.class));
ikonList.addAll(allOf(MaterialDesignZ.class));

CustomTextField searchBox = new CustomTextField();
searchBox.setPromptText(Localization.lang("Search") + "...");
searchBox.setLeft(IconTheme.JabRefIcons.SEARCH.getGraphicNode());
searchBox.textProperty().addListener((obs, oldValue, newValue) ->
filteredList.setPredicate(ikon -> newValue.isEmpty() || ikon.getDescription().toLowerCase()
.contains(newValue.toLowerCase())));

GridView<Ikon> ikonGridView = new GridView<>(FXCollections.observableArrayList());
ikonGridView.setCellFactory(gridView -> new IkonliCell());
ikonGridView.setPrefWidth(520);
ikonGridView.setPrefHeight(400);
ikonGridView.setHorizontalCellSpacing(4);
ikonGridView.setVerticalCellSpacing(4);
ikonGridView.setItems(filteredList);

VBox vBox = new VBox(10, searchBox, ikonGridView);
vBox.setPadding(new Insets(10));

PopOver popOver = new PopOver(vBox);
popOver.setDetachable(false);
popOver.setArrowSize(0);
popOver.setCornerRadius(0);
popOver.setTitle("Icon picker");
popOver.show(iconPickerButton);
}

public class IkonliCell extends GridCell<Ikon> {
@Override
protected void updateItem(Ikon ikon, boolean empty) {
super.updateItem(ikon, empty);
if (empty || ikon == null) {
setText(null);
setGraphic(null);
} else {
FontIcon fontIcon = FontIcon.of(ikon);
fontIcon.getStyleClass().setAll("font-icon");
fontIcon.setIconSize(22);
setGraphic(fontIcon);
setAlignment(Pos.BASELINE_CENTER);
setPadding(new Insets(1));
setBorder(new Border(new BorderStroke(Color.BLACK, BorderStrokeStyle.SOLID, CornerRadii.EMPTY, BorderStroke.THIN)));

setOnMouseClicked(event -> {
iconField.textProperty().setValue(String.valueOf(fontIcon.getIconCode()));
PopOver stage = (PopOver) this.getGridView().getParent().getScene().getWindow();
stage.hide();
});
}
}
}
}
3 changes: 2 additions & 1 deletion src/main/java/org/jabref/gui/icon/IconTheme.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,8 @@ public enum JabRefIcons implements JabRefIcon {
HOME(MaterialDesignH.HOME),
LINK(MaterialDesignL.LINK),
LINK_VARIANT(MaterialDesignL.LINK_VARIANT),
PROTECT_STRING(MaterialDesignC.CODE_BRACES);
PROTECT_STRING(MaterialDesignC.CODE_BRACES),
SELECT_ICONS(MaterialDesignA.APPS);

private final JabRefIcon icon;

Expand Down