001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui.preferences.shortcut;
003
004import static org.openstreetmap.josm.tools.I18n.marktr;
005import static org.openstreetmap.josm.tools.I18n.tr;
006
007import java.awt.Color;
008import java.awt.Component;
009import java.awt.Dimension;
010import java.awt.GridBagConstraints;
011import java.awt.GridBagLayout;
012import java.awt.GridLayout;
013import java.awt.Insets;
014import java.awt.Toolkit;
015import java.awt.event.KeyEvent;
016import java.lang.reflect.Field;
017import java.util.ArrayList;
018import java.util.LinkedHashMap;
019import java.util.List;
020import java.util.Map;
021import java.util.regex.PatternSyntaxException;
022
023import javax.swing.AbstractAction;
024import javax.swing.BorderFactory;
025import javax.swing.BoxLayout;
026import javax.swing.DefaultComboBoxModel;
027import javax.swing.JCheckBox;
028import javax.swing.JLabel;
029import javax.swing.JPanel;
030import javax.swing.JScrollPane;
031import javax.swing.JTable;
032import javax.swing.KeyStroke;
033import javax.swing.ListSelectionModel;
034import javax.swing.RowFilter;
035import javax.swing.SwingConstants;
036import javax.swing.UIManager;
037import javax.swing.event.DocumentEvent;
038import javax.swing.event.DocumentListener;
039import javax.swing.event.ListSelectionEvent;
040import javax.swing.event.ListSelectionListener;
041import javax.swing.table.AbstractTableModel;
042import javax.swing.table.DefaultTableCellRenderer;
043import javax.swing.table.TableColumnModel;
044import javax.swing.table.TableModel;
045import javax.swing.table.TableRowSorter;
046
047import org.openstreetmap.josm.Main;
048import org.openstreetmap.josm.gui.util.GuiHelper;
049import org.openstreetmap.josm.gui.widgets.JosmComboBox;
050import org.openstreetmap.josm.gui.widgets.JosmTextField;
051import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
052import org.openstreetmap.josm.tools.Shortcut;
053
054/**
055 * This is the keyboard preferences content.
056 */
057public class PrefJPanel extends JPanel {
058
059    // table of shortcuts
060    private final AbstractTableModel model;
061    // this are the display(!) texts for the checkboxes. Let the JVM do the i18n for us <g>.
062    // Ok, there's a real reason for this: The JVM should know best how the keys are labelled
063    // on the physical keyboard. What language pack is installed in JOSM is completely
064    // independent from the keyboard's labelling. But the operation system's locale
065    // usually matches the keyboard. This even works with my English Windows and my German keyboard.
066    private static final String SHIFT = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A,
067            KeyEvent.SHIFT_DOWN_MASK).getModifiers());
068    private static final String CTRL = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A,
069            KeyEvent.CTRL_DOWN_MASK).getModifiers());
070    private static final String ALT = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A,
071            KeyEvent.ALT_DOWN_MASK).getModifiers());
072    private static final String META = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A,
073            KeyEvent.META_DOWN_MASK).getModifiers());
074
075    // A list of keys to present the user. Sadly this really is a list of keys Java knows about,
076    // not a list of real physical keys. If someone knows how to get that list?
077    private static Map<Integer, String> keyList = setKeyList();
078
079    private final JCheckBox cbAlt = new JCheckBox();
080    private final JCheckBox cbCtrl = new JCheckBox();
081    private final JCheckBox cbMeta = new JCheckBox();
082    private final JCheckBox cbShift = new JCheckBox();
083    private final JCheckBox cbDefault = new JCheckBox();
084    private final JCheckBox cbDisable = new JCheckBox();
085    private final JosmComboBox<String> tfKey = new JosmComboBox<>();
086
087    private final JTable shortcutTable = new JTable();
088
089    private final JosmTextField filterField = new JosmTextField();
090
091    /** Creates new form prefJPanel */
092    public PrefJPanel() {
093        this.model = new ScListModel();
094        initComponents();
095    }
096
097    private static Map<Integer, String> setKeyList() {
098        Map<Integer, String> list = new LinkedHashMap<>();
099        String unknown = Toolkit.getProperty("AWT.unknown", "Unknown");
100        // Assume all known keys are declared in KeyEvent as "public static int VK_*"
101        for (Field field : KeyEvent.class.getFields()) {
102            if (field.getName().startsWith("VK_")) {
103                try {
104                    int i = field.getInt(null);
105                    String s = KeyEvent.getKeyText(i);
106                    if (s != null && s.length() > 0 && !s.contains(unknown)) {
107                        list.put(Integer.valueOf(i), s);
108                    }
109                } catch (IllegalArgumentException | IllegalAccessException e) {
110                    Main.error(e);
111                }
112            }
113        }
114        list.put(Integer.valueOf(-1), "");
115        return list;
116    }
117
118    /**
119     * Show only shortcuts with descriptions containing given substring
120     * @param substring The substring used to filter
121     */
122    public void filter(String substring) {
123        filterField.setText(substring);
124    }
125
126    private static class ScListModel extends AbstractTableModel {
127        private final String[] columnNames = new String[]{tr("Action"), tr("Shortcut")};
128        private final transient List<Shortcut> data;
129
130        /**
131         * Constructs a new {@code ScListModel}.
132         */
133        ScListModel() {
134            data = Shortcut.listAll();
135        }
136
137        @Override
138        public int getColumnCount() {
139            return columnNames.length;
140        }
141
142        @Override
143        public int getRowCount() {
144            return data.size();
145        }
146
147        @Override
148        public String getColumnName(int col) {
149            return columnNames[col];
150        }
151
152        @Override
153        public Object getValueAt(int row, int col) {
154            return (col == 0) ? data.get(row).getLongText() : data.get(row);
155        }
156    }
157
158    private class ShortcutTableCellRenderer extends DefaultTableCellRenderer {
159
160        private final boolean name;
161
162        ShortcutTableCellRenderer(boolean name) {
163            this.name = name;
164        }
165
166        @Override
167        public Component getTableCellRendererComponent(JTable table, Object value, boolean
168                isSelected, boolean hasFocus, int row, int column) {
169            int row1 = shortcutTable.convertRowIndexToModel(row);
170            Shortcut sc = (Shortcut) model.getValueAt(row1, -1);
171            if (sc == null)
172                return null;
173            JLabel label = (JLabel) super.getTableCellRendererComponent(
174                table, name ? sc.getLongText() : sc.getKeyText(), isSelected, hasFocus, row, column);
175            GuiHelper.setBackgroundReadable(label, UIManager.getColor("Table.background"));
176            if (sc.isAssignedUser()) {
177                GuiHelper.setBackgroundReadable(label, Main.pref.getColor(
178                        marktr("Shortcut Background: User"),
179                        new Color(200, 255, 200)));
180            } else if (!sc.isAssignedDefault()) {
181                GuiHelper.setBackgroundReadable(label, Main.pref.getColor(
182                        marktr("Shortcut Background: Modified"),
183                        new Color(255, 255, 200)));
184            }
185            return label;
186        }
187    }
188
189    private void initComponents() {
190        CbAction action = new CbAction(this);
191        setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
192        add(buildFilterPanel());
193
194        // This is the list of shortcuts:
195        shortcutTable.setModel(model);
196        shortcutTable.getSelectionModel().addListSelectionListener(action);
197        shortcutTable.setFillsViewportHeight(true);
198        shortcutTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
199        shortcutTable.setAutoCreateRowSorter(true);
200        TableColumnModel mod = shortcutTable.getColumnModel();
201        mod.getColumn(0).setCellRenderer(new ShortcutTableCellRenderer(true));
202        mod.getColumn(1).setCellRenderer(new ShortcutTableCellRenderer(false));
203        JScrollPane listScrollPane = new JScrollPane();
204        listScrollPane.setViewportView(shortcutTable);
205
206        JPanel listPane = new JPanel(new GridLayout());
207        listPane.add(listScrollPane);
208        add(listPane);
209
210        // and here follows the edit area. I won't object to someone re-designing it, it looks, um, "minimalistic" ;)
211
212        cbDefault.setAction(action);
213        cbDefault.setText(tr("Use default"));
214        cbShift.setAction(action);
215        cbShift.setText(SHIFT); // see above for why no tr()
216        cbDisable.setAction(action);
217        cbDisable.setText(tr("Disable"));
218        cbCtrl.setAction(action);
219        cbCtrl.setText(CTRL); // see above for why no tr()
220        cbAlt.setAction(action);
221        cbAlt.setText(ALT); // see above for why no tr()
222        tfKey.setAction(action);
223        tfKey.setModel(new DefaultComboBoxModel<>(keyList.values().toArray(new String[0])));
224        cbMeta.setAction(action);
225        cbMeta.setText(META); // see above for why no tr()
226
227        JPanel shortcutEditPane = new JPanel(new GridLayout(5, 2));
228
229        shortcutEditPane.add(cbDefault);
230        shortcutEditPane.add(new JLabel());
231        shortcutEditPane.add(cbShift);
232        shortcutEditPane.add(cbDisable);
233        shortcutEditPane.add(cbCtrl);
234        shortcutEditPane.add(new JLabel(tr("Key:"), SwingConstants.LEFT));
235        shortcutEditPane.add(cbAlt);
236        shortcutEditPane.add(tfKey);
237        shortcutEditPane.add(cbMeta);
238
239        shortcutEditPane.add(new JLabel(tr("Attention: Use real keyboard keys only!")));
240
241        action.actionPerformed(null); // init checkboxes
242
243        add(shortcutEditPane);
244    }
245
246    private JPanel buildFilterPanel() {
247        // copied from PluginPreference
248        JPanel pnl = new JPanel(new GridBagLayout());
249        pnl.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
250        GridBagConstraints gc = new GridBagConstraints();
251
252        gc.anchor = GridBagConstraints.NORTHWEST;
253        gc.fill = GridBagConstraints.HORIZONTAL;
254        gc.weightx = 0.0;
255        gc.insets = new Insets(0, 0, 0, 5);
256        pnl.add(new JLabel(tr("Search:")), gc);
257
258        gc.gridx = 1;
259        gc.weightx = 1.0;
260        pnl.add(filterField, gc);
261        filterField.setToolTipText(tr("Enter a search expression"));
262        SelectAllOnFocusGainedDecorator.decorate(filterField);
263        filterField.getDocument().addDocumentListener(new FilterFieldAdapter());
264        pnl.setMaximumSize(new Dimension(300, 10));
265        return pnl;
266    }
267
268    // this allows to edit shortcuts. it:
269    //  * sets the edit controls to the selected shortcut
270    //  * enabled/disables the controls as needed
271    //  * writes the user's changes to the shortcut
272    // And after I finally had it working, I realized that those two methods
273    // are playing ping-pong (politically correct: table tennis, I know) and
274    // even have some duplicated code. Feel free to refactor, If you have
275    // more experience with GUI coding than I have.
276    private static class CbAction extends AbstractAction implements ListSelectionListener {
277        private final PrefJPanel panel;
278
279        CbAction(PrefJPanel panel) {
280            this.panel = panel;
281        }
282
283        private void disableAllModifierCheckboxes() {
284            panel.cbDefault.setEnabled(false);
285            panel.cbDisable.setEnabled(false);
286            panel.cbShift.setEnabled(false);
287            panel.cbCtrl.setEnabled(false);
288            panel.cbAlt.setEnabled(false);
289            panel.cbMeta.setEnabled(false);
290        }
291
292        @Override
293        public void valueChanged(ListSelectionEvent e) {
294            ListSelectionModel lsm = panel.shortcutTable.getSelectionModel(); // can't use e here
295            if (!lsm.isSelectionEmpty()) {
296                int row = panel.shortcutTable.convertRowIndexToModel(lsm.getMinSelectionIndex());
297                Shortcut sc = (Shortcut) panel.model.getValueAt(row, -1);
298                panel.cbDefault.setSelected(!sc.isAssignedUser());
299                panel.cbDisable.setSelected(sc.getKeyStroke() == null);
300                panel.cbShift.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.SHIFT_DOWN_MASK) != 0);
301                panel.cbCtrl.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.CTRL_DOWN_MASK) != 0);
302                panel.cbAlt.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.ALT_DOWN_MASK) != 0);
303                panel.cbMeta.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.META_DOWN_MASK) != 0);
304                if (sc.getKeyStroke() != null) {
305                    panel.tfKey.setSelectedItem(keyList.get(sc.getKeyStroke().getKeyCode()));
306                } else {
307                    panel.tfKey.setSelectedItem(keyList.get(-1));
308                }
309                if (!sc.isChangeable()) {
310                    disableAllModifierCheckboxes();
311                    panel.tfKey.setEnabled(false);
312                } else {
313                    panel.cbDefault.setEnabled(true);
314                    actionPerformed(null);
315                }
316                panel.model.fireTableRowsUpdated(row, row);
317            } else {
318                disableAllModifierCheckboxes();
319                panel.tfKey.setEnabled(false);
320            }
321        }
322
323        @Override
324        public void actionPerformed(java.awt.event.ActionEvent e) {
325            ListSelectionModel lsm = panel.shortcutTable.getSelectionModel();
326            if (lsm != null && !lsm.isSelectionEmpty()) {
327                if (e != null) { // only if we've been called by a user action
328                    int row = panel.shortcutTable.convertRowIndexToModel(lsm.getMinSelectionIndex());
329                    Shortcut sc = (Shortcut) panel.model.getValueAt(row, -1);
330                    if (panel.cbDisable.isSelected()) {
331                        sc.setAssignedModifier(-1);
332                    } else if (panel.tfKey.getSelectedItem() == null || "".equals(panel.tfKey.getSelectedItem())) {
333                        sc.setAssignedModifier(KeyEvent.VK_CANCEL);
334                    } else {
335                        sc.setAssignedModifier(
336                                (panel.cbShift.isSelected() ? KeyEvent.SHIFT_DOWN_MASK : 0) |
337                                (panel.cbCtrl.isSelected() ? KeyEvent.CTRL_DOWN_MASK : 0) |
338                                (panel.cbAlt.isSelected() ? KeyEvent.ALT_DOWN_MASK : 0) |
339                                (panel.cbMeta.isSelected() ? KeyEvent.META_DOWN_MASK : 0)
340                        );
341                        for (Map.Entry<Integer, String> entry : keyList.entrySet()) {
342                            if (entry.getValue().equals(panel.tfKey.getSelectedItem())) {
343                                sc.setAssignedKey(entry.getKey());
344                            }
345                        }
346                    }
347                    sc.setAssignedUser(!panel.cbDefault.isSelected());
348                    valueChanged(null);
349                }
350                boolean state = !panel.cbDefault.isSelected();
351                panel.cbDisable.setEnabled(state);
352                state = state && !panel.cbDisable.isSelected();
353                panel.cbShift.setEnabled(state);
354                panel.cbCtrl.setEnabled(state);
355                panel.cbAlt.setEnabled(state);
356                panel.cbMeta.setEnabled(state);
357                panel.tfKey.setEnabled(state);
358            } else {
359                disableAllModifierCheckboxes();
360                panel.tfKey.setEnabled(false);
361            }
362        }
363    }
364
365    class FilterFieldAdapter implements DocumentListener {
366        private void filter() {
367            String expr = filterField.getText().trim();
368            if (expr.isEmpty()) {
369                expr = null;
370            }
371            try {
372                final TableRowSorter<? extends TableModel> sorter =
373                    (TableRowSorter<? extends TableModel>) shortcutTable.getRowSorter();
374                if (expr == null) {
375                    sorter.setRowFilter(null);
376                } else {
377                    expr = expr.replace("+", "\\+");
378                    // split search string on whitespace, do case-insensitive AND search
379                    List<RowFilter<Object, Object>> andFilters = new ArrayList<>();
380                    for (String word : expr.split("\\s+")) {
381                        andFilters.add(RowFilter.regexFilter("(?i)" + word));
382                    }
383                    sorter.setRowFilter(RowFilter.andFilter(andFilters));
384                }
385                model.fireTableDataChanged();
386            } catch (PatternSyntaxException | ClassCastException ex) {
387                Main.warn(ex);
388            }
389        }
390
391        @Override
392        public void changedUpdate(DocumentEvent e) {
393            filter();
394        }
395
396        @Override
397        public void insertUpdate(DocumentEvent e) {
398            filter();
399        }
400
401        @Override
402        public void removeUpdate(DocumentEvent e) {
403            filter();
404        }
405    }
406}