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