package org.jabref.gui.preftabs;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.JCheckBox;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.JToolBar;
import javax.swing.ScrollPaneConstants;
import javax.swing.SwingConstants;
import javax.swing.table.AbstractTableModel;
import javax.swing.table.TableColumnModel;
import javax.swing.table.TableModel;
import org.jabref.gui.IconTheme;
import org.jabref.gui.OSXCompatibleToolbar;
import org.jabref.logic.l10n.Localization;
import org.jabref.preferences.JabRefPreferences;
import com.jgoodies.forms.builder.DefaultFormBuilder;
import com.jgoodies.forms.layout.FormLayout;
/**
* Preference Tab for XMP.
*
* Allows the user to enable and configure the XMP privacy filter.
*/
class XmpPrefsTab extends JPanel implements PrefsTab {
private final JabRefPreferences prefs;
private boolean tableChanged;
private int rowCount;
private final JTable table;
private final JCheckBox privacyFilterCheckBox = new JCheckBox(
Localization.lang("Do not write the following fields to XMP Metadata:"));
private final List<Object> tableRows = new ArrayList<>(10);
/**
* Customization of external program paths.
*/
public XmpPrefsTab(JabRefPreferences prefs) {
this.prefs = Objects.requireNonNull(prefs);
setLayout(new BorderLayout());
TableModel tableModel = new AbstractTableModel() {
@Override
public int getRowCount() {
return rowCount;
}
@Override
public int getColumnCount() {
return 1;
}
@Override
public Object getValueAt(int row, int column) {
if (row >= tableRows.size()) {
return "";
}
Object rowContent = tableRows.get(row);
if (rowContent == null) {
return "";
}
return rowContent;
}
@Override
public String getColumnName(int col) {
return Localization.lang("Field to filter");
}
@Override
public Class<?> getColumnClass(int column) {
return String.class;
}
@Override
public boolean isCellEditable(int row, int col) {
return true;
}
@Override
public void setValueAt(Object value, int row, int col) {
tableChanged = true;
if (tableRows.size() <= row) {
((ArrayList<Object>) tableRows).ensureCapacity(row + 1);
}
tableRows.set(row, value);
}
};
table = new JTable(tableModel);
TableColumnModel columnModel = table.getColumnModel();
columnModel.getColumn(0).setPreferredWidth(140);
FormLayout layout = new FormLayout("1dlu, 8dlu, left:pref, 4dlu, fill:pref", "");
DefaultFormBuilder builder = new DefaultFormBuilder(layout);
JPanel pan = new JPanel();
JPanel tablePanel = new JPanel();
tablePanel.setLayout(new BorderLayout());
JScrollPane scrollPane = new JScrollPane(table, ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED,
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
table.setPreferredScrollableViewportSize(new Dimension(250, 200));
scrollPane.setMinimumSize(new Dimension(250, 300));
tablePanel.add(scrollPane, BorderLayout.CENTER);
JToolBar toolbar = new OSXCompatibleToolbar(SwingConstants.VERTICAL);
toolbar.setFloatable(false);
toolbar.setBorder(null);
toolbar.add(new AddRowAction());
toolbar.add(new DeleteRowAction());
tablePanel.add(toolbar, BorderLayout.EAST);
// Build Prefs Tabs
builder.appendSeparator(Localization.lang("XMP export privacy settings"));
builder.nextLine();
builder.append(pan);
builder.append(privacyFilterCheckBox);
builder.nextLine();
builder.append(pan);
builder.append(tablePanel);
builder.nextLine();
pan = builder.getPanel();
pan.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
add(pan, BorderLayout.CENTER);
}
class DeleteRowAction extends AbstractAction {
public DeleteRowAction() {
super("Delete row", IconTheme.JabRefIcon.REMOVE_NOBOX.getIcon());
putValue(Action.SHORT_DESCRIPTION, Localization.lang("Delete rows"));
}
@Override
public void actionPerformed(ActionEvent e) {
int[] rows = table.getSelectedRows();
if (rows.length == 0) {
return;
}
for (int i = rows.length - 1; i >= 0; i--) {
if (rows[i] < tableRows.size()) {
tableRows.remove(rows[i]);
}
}
rowCount -= rows.length;
if (rows.length > 1) {
table.clearSelection();
}
table.revalidate();
table.repaint();
tableChanged = true;
}
}
class AddRowAction extends AbstractAction {
public AddRowAction() {
super("Add row", IconTheme.JabRefIcon.ADD_NOBOX.getIcon());
putValue(Action.SHORT_DESCRIPTION, Localization.lang("Insert rows"));
}
@Override
public void actionPerformed(ActionEvent e) {
int[] rows = table.getSelectedRows();
if (rows.length == 0) {
// No rows selected, so we just add one at the end.
rowCount++;
table.revalidate();
table.repaint();
return;
}
for (int i = 0; i < rows.length; i++) {
if ((rows[i] + i) < tableRows.size()) {
tableRows.add(rows[i] + i, "");
}
}
rowCount += rows.length;
if (rows.length > 1) {
table.clearSelection();
}
table.revalidate();
table.repaint();
tableChanged = true;
}
}
/**
* Load settings from the preferences and initialize the table.
*/
@Override
public void setValues() {
tableRows.clear();
List<String> names = JabRefPreferences.getInstance().getStringList(JabRefPreferences.XMP_PRIVACY_FILTERS);
tableRows.addAll(names);
rowCount = tableRows.size() + 5;
privacyFilterCheckBox.setSelected(JabRefPreferences.getInstance().getBoolean(
JabRefPreferences.USE_XMP_PRIVACY_FILTER));
}
/**
* Store changes to table preferences. This method is called when the user
* clicks Ok.
*
*/
@Override
public void storeSettings() {
if (table.isEditing()) {
int col = table.getEditingColumn();
int row = table.getEditingRow();
table.getCellEditor(row, col).stopCellEditing();
}
// Now we need to make sense of the contents the user has made to the
// table setup table. This needs to be done either if changes were made, or
// if the checkbox is checked and no field values have been stored previously:
if (tableChanged ||
(privacyFilterCheckBox.isSelected() && !prefs.hasKey(JabRefPreferences.XMP_PRIVACY_FILTERS))) {
// First we remove all rows with empty names.
for (int i = tableRows.size() - 1; i >= 0; i--) {
if ((tableRows.get(i) == null) || tableRows.get(i).toString().isEmpty()) {
tableRows.remove(i);
}
}
// Finally, we store the new preferences.
JabRefPreferences.getInstance().putStringList(JabRefPreferences.XMP_PRIVACY_FILTERS,
tableRows.stream().map(Object::toString).collect(Collectors.toList()));
}
JabRefPreferences.getInstance().putBoolean(JabRefPreferences.USE_XMP_PRIVACY_FILTER, privacyFilterCheckBox.isSelected());
}
@Override
public boolean validateSettings() {
return true;
}
@Override
public String getTabName() {
return Localization.lang("XMP-metadata");
}
}