source: josm/trunk/src/org/openstreetmap/josm/gui/preferences/shortcut/PrefJPanel.java@ 5049

Last change on this file since 5049 was 5049, checked in by akks, 12 years ago

fix #7484: Keyboard Preferences dialog looses scrollbars after search
  • Property svn:eol-style set to native
File size: 17.7 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.preferences.shortcut;
3
4import java.awt.Color;
5import java.awt.Component;
6import java.awt.Dimension;
7import java.awt.GridBagConstraints;
8import java.awt.GridBagLayout;
9import java.awt.Insets;
10import java.awt.Toolkit;
11
12import static org.openstreetmap.josm.tools.I18n.marktr;
13import static org.openstreetmap.josm.tools.I18n.tr;
14
15import java.awt.event.KeyEvent;
16import java.lang.reflect.Field;
17import java.util.ArrayList;
18import java.util.LinkedHashMap;
19import java.util.HashMap;
20import java.util.Map;
21
22import java.util.regex.PatternSyntaxException;
23import javax.swing.AbstractAction;
24import javax.swing.BorderFactory;
25import javax.swing.BoxLayout;
26import javax.swing.DefaultComboBoxModel;
27import javax.swing.JCheckBox;
28import javax.swing.JComboBox;
29import javax.swing.JEditorPane;
30import javax.swing.JLabel;
31import javax.swing.JPanel;
32import javax.swing.JScrollPane;
33import javax.swing.JTable;
34import javax.swing.JTextField;
35import javax.swing.KeyStroke;
36import javax.swing.ListSelectionModel;
37import javax.swing.RowFilter;
38import javax.swing.SwingConstants;
39import javax.swing.event.DocumentEvent;
40import javax.swing.event.DocumentListener;
41import javax.swing.event.ListSelectionEvent;
42import javax.swing.event.ListSelectionListener;
43import javax.swing.table.AbstractTableModel;
44import javax.swing.table.TableModel;
45import javax.swing.table.DefaultTableCellRenderer;
46import javax.swing.table.TableColumnModel;
47
48import javax.swing.table.TableRowSorter;
49import org.openstreetmap.josm.Main;
50import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
51import org.openstreetmap.josm.tools.Shortcut;
52
53/**
54 * This is the keyboard preferences content.
55 * If someone wants to merge it with ShortcutPreference.java, feel free.
56 */
57public class PrefJPanel extends JPanel {
58
59 // table of shortcuts
60 private AbstractTableModel model;
61 // comboboxes of modifier groups, mapping selectedIndex to real data
62 private static int[] modifInts = new int[]{
63 -1,
64 0,
65 KeyEvent.SHIFT_DOWN_MASK,
66 KeyEvent.CTRL_DOWN_MASK,
67 KeyEvent.ALT_DOWN_MASK,
68 KeyEvent.META_DOWN_MASK,
69 KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK,
70 KeyEvent.ALT_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK,
71 KeyEvent.META_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK,
72 KeyEvent.CTRL_DOWN_MASK | KeyEvent.ALT_DOWN_MASK,
73 KeyEvent.CTRL_DOWN_MASK | KeyEvent.META_DOWN_MASK,
74 KeyEvent.ALT_DOWN_MASK | KeyEvent.META_DOWN_MASK,
75 KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK | KeyEvent.ALT_DOWN_MASK,
76 KeyEvent.META_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK | KeyEvent.ALT_DOWN_MASK
77 };
78 // and here are the texts fro the comboboxes
79 private static String[] modifList = new String[] {
80 tr("disabled"),
81 tr("no modifier"),
82 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[2]).getModifiers()),
83 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[3]).getModifiers()),
84 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[4]).getModifiers()),
85 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[5]).getModifiers()),
86 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[6]).getModifiers()),
87 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[7]).getModifiers()),
88 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[8]).getModifiers()),
89 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[9]).getModifiers()),
90 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[10]).getModifiers()),
91 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[11]).getModifiers()),
92 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[12]).getModifiers()),
93 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[13]).getModifiers())
94 };
95 // this are the display(!) texts for the checkboxes. Let the JVM do the i18n for us <g>.
96 // Ok, there's a real reason for this: The JVM should know best how the keys are labelled
97 // on the physical keyboard. What language pack is installed in JOSM is completely
98 // independent from the keyboard's labelling. But the operation system's locale
99 // usually matches the keyboard. This even works with my English Windows and my German
100 // keyboard.
101 private static String SHIFT = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.SHIFT_DOWN_MASK).getModifiers());
102 private static String CTRL = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.CTRL_DOWN_MASK).getModifiers());
103 private static String ALT = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.ALT_DOWN_MASK).getModifiers());
104 private static String META = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.META_DOWN_MASK).getModifiers());
105
106 // A list of keys to present the user. Sadly this really is a list of keys Java knows about,
107 // not a list of real physical keys. If someone knows how to get that list?
108 private static Map<Integer, String> keyList = setKeyList();
109
110 private static Map<Integer, String> setKeyList() {
111 Map<Integer, String> list = new LinkedHashMap<Integer, String>();
112 String unknown = Toolkit.getProperty("AWT.unknown", "Unknown");
113 // Assume all known keys are declared in KeyEvent as "public static int VK_*"
114 for (Field field : KeyEvent.class.getFields()) {
115 if (field.getName().startsWith("VK_")) {
116 try {
117 int i = field.getInt(null);
118 String s = KeyEvent.getKeyText(i);
119 if (s != null && s.length() > 0 && !s.contains(unknown)) {
120 list.put(Integer.valueOf(i), s);
121 //System.out.println(i+": "+s);
122 }
123 } catch (Exception e) {
124 e.printStackTrace();
125 }
126 }
127 }
128 list.put(Integer.valueOf(-1), "");
129 return list;
130 }
131
132 private JCheckBox cbAlt = new JCheckBox();
133 private JCheckBox cbCtrl = new JCheckBox();
134 private JCheckBox cbMeta = new JCheckBox();
135 private JCheckBox cbShift = new JCheckBox();
136 private JCheckBox cbDefault = new JCheckBox();
137 private JCheckBox cbDisable = new JCheckBox();
138 private JComboBox tfKey = new JComboBox();
139
140 JTable shortcutTable = new JTable();
141
142 private JTextField filterField = new JTextField();
143
144 /** Creates new form prefJPanel */
145 // Ain't those auto-generated comments helpful or what? <g>
146 public PrefJPanel(AbstractTableModel model) {
147 this.model = model;
148 initComponents();
149 }
150
151 private static class ShortcutTableCellRenderer extends DefaultTableCellRenderer {
152
153 private boolean name;
154
155 public ShortcutTableCellRenderer(boolean name) {
156 this.name = name;
157 }
158
159 @Override
160 public Component getTableCellRendererComponent(JTable table, Object value, boolean
161 isSelected, boolean hasFocus, int row, int column) {
162 if(value instanceof Shortcut)
163 {
164 Shortcut sc = (Shortcut) value;
165 JLabel label = (JLabel) super.getTableCellRendererComponent(
166 table, name ? sc.getLongText() : sc.getKeyText(), isSelected, hasFocus, row, column);
167 label.setBackground(Main.pref.getUIColor("Table.background"));
168 if (isSelected) {
169 label.setForeground(Main.pref.getUIColor("Table.foreground"));
170 }
171 if(sc.getAssignedUser()) {
172 label.setBackground(Main.pref.getColor(
173 marktr("Shortcut Background: User"),
174 new Color(200,255,200)));
175 } else if(!sc.getAssignedDefault()) {
176 label.setBackground(Main.pref.getColor(
177 marktr("Shortcut Background: Modified"),
178 new Color(255,255,200)));
179 }
180 return label;
181 }
182 return null;
183 }
184 }
185
186 private void initComponents() {
187 JPanel listPane = new JPanel();
188 JScrollPane listScrollPane = new JScrollPane();
189 JPanel shortcutEditPane = new JPanel();
190
191 CbAction action = new CbAction(this);
192 setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
193 add(buildFilterPanel());
194 listPane.setLayout(new java.awt.GridLayout());
195
196 // This is the list of shortcuts:
197 shortcutTable.setModel(model);
198 shortcutTable.getSelectionModel().addListSelectionListener(new CbAction(this));
199 shortcutTable.setFillsViewportHeight(true);
200 shortcutTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
201 shortcutTable.setAutoCreateRowSorter(true);
202 TableColumnModel mod = shortcutTable.getColumnModel();
203 mod.getColumn(0).setCellRenderer(new ShortcutTableCellRenderer(true));
204 mod.getColumn(1).setCellRenderer(new ShortcutTableCellRenderer(false));
205 listScrollPane.setViewportView(shortcutTable);
206
207 listPane.add(listScrollPane);
208
209 add(listPane);
210
211 // and here follows the edit area. I won't object to someone re-designing it, it looks, um, "minimalistic" ;)
212 shortcutEditPane.setLayout(new java.awt.GridLayout(5, 2));
213
214 cbDefault.setAction(action);
215 cbDefault.setText(tr("Use default"));
216 cbShift.setAction(action);
217 cbShift.setText(SHIFT); // see above for why no tr()
218 cbDisable.setAction(action);
219 cbDisable.setText(tr("Disable"));
220 cbCtrl.setAction(action);
221 cbCtrl.setText(CTRL); // see above for why no tr()
222 cbAlt.setAction(action);
223 cbAlt.setText(ALT); // see above for why no tr()
224 tfKey.setAction(action);
225 tfKey.setModel(new DefaultComboBoxModel(keyList.values().toArray()));
226 cbMeta.setAction(action);
227 cbMeta.setText(META); // see above for why no tr()
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 private void disableAllModifierCheckboxes() {
269 cbDefault.setEnabled(false);
270 cbDisable.setEnabled(false);
271 cbShift.setEnabled(false);
272 cbCtrl.setEnabled(false);
273 cbAlt.setEnabled(false);
274 cbMeta.setEnabled(false);
275 }
276
277 // this allows to edit shortcuts. it:
278 // * sets the edit controls to the selected shortcut
279 // * enabled/disables the controls as needed
280 // * writes the user's changes to the shortcut
281 // And after I finally had it working, I realized that those two methods
282 // are playing ping-pong (politically correct: table tennis, I know) and
283 // even have some duplicated code. Feel free to refactor, If you have
284 // more expirience with GUI coding than I have.
285 private class CbAction extends AbstractAction implements ListSelectionListener {
286 private PrefJPanel panel;
287 public CbAction (PrefJPanel panel) {
288 this.panel = panel;
289 }
290 public void valueChanged(ListSelectionEvent e) {
291 ListSelectionModel lsm = panel.shortcutTable.getSelectionModel(); // can't use e here
292 if (!lsm.isSelectionEmpty()) {
293 int row = panel.shortcutTable.convertRowIndexToModel(lsm.getMinSelectionIndex());
294 Shortcut sc = (Shortcut)panel.model.getValueAt(row, -1);
295 panel.cbDefault.setSelected(!sc.getAssignedUser());
296 panel.cbDisable.setSelected(sc.getKeyStroke() == null);
297 panel.cbShift.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.SHIFT_DOWN_MASK) != 0);
298 panel.cbCtrl.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.CTRL_DOWN_MASK) != 0);
299 panel.cbAlt.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.ALT_DOWN_MASK) != 0);
300 panel.cbMeta.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.META_DOWN_MASK) != 0);
301 if (sc.getKeyStroke() != null) {
302 tfKey.setSelectedItem(keyList.get(sc.getKeyStroke().getKeyCode()));
303 } else {
304 tfKey.setSelectedItem(keyList.get(-1));
305 }
306 if (!sc.isChangeable()) {
307 disableAllModifierCheckboxes();
308 panel.tfKey.setEnabled(false);
309 } else {
310 panel.cbDefault.setEnabled(true);
311 actionPerformed(null);
312 }
313 model.fireTableRowsUpdated(row, row);
314 } else {
315 panel.disableAllModifierCheckboxes();
316 panel.tfKey.setEnabled(false);
317 }
318 }
319 public void actionPerformed(java.awt.event.ActionEvent e) {
320 ListSelectionModel lsm = panel.shortcutTable.getSelectionModel();
321 if (lsm != null && !lsm.isSelectionEmpty()) {
322 if (e != null) { // only if we've been called by a user action
323 int row = panel.shortcutTable.convertRowIndexToModel(lsm.getMinSelectionIndex());
324 Shortcut sc = (Shortcut)panel.model.getValueAt(row, -1);
325 if (panel.cbDisable.isSelected()) {
326 sc.setAssignedModifier(-1);
327 } else if (panel.tfKey.getSelectedItem().equals("")) {
328 sc.setAssignedModifier(KeyEvent.VK_CANCEL);
329 } else {
330 sc.setAssignedModifier(
331 (panel.cbShift.isSelected() ? KeyEvent.SHIFT_DOWN_MASK : 0) |
332 (panel.cbCtrl.isSelected() ? KeyEvent.CTRL_DOWN_MASK : 0) |
333 (panel.cbAlt.isSelected() ? KeyEvent.ALT_DOWN_MASK : 0) |
334 (panel.cbMeta.isSelected() ? KeyEvent.META_DOWN_MASK : 0)
335 );
336 for (Map.Entry<Integer, String> entry : keyList.entrySet()) {
337 if (entry.getValue().equals(panel.tfKey.getSelectedItem())) {
338 sc.setAssignedKey(entry.getKey());
339 }
340 }
341 }
342 sc.setAssignedUser(!panel.cbDefault.isSelected());
343 valueChanged(null);
344 }
345 boolean state = !panel.cbDefault.isSelected();
346 panel.cbDisable.setEnabled(state);
347 state = state && !panel.cbDisable.isSelected();
348 panel.cbShift.setEnabled(state);
349 panel.cbCtrl.setEnabled(state);
350 panel.cbAlt.setEnabled(state);
351 panel.cbMeta.setEnabled(state);
352 panel.tfKey.setEnabled(state);
353 } else {
354 panel.disableAllModifierCheckboxes();
355 panel.tfKey.setEnabled(false);
356 }
357 }
358 }
359
360 class FilterFieldAdapter implements DocumentListener {
361 public void filter() {
362 String expr = filterField.getText().trim();
363 if (expr.length()==0) { expr=null; }
364 try {
365 final TableRowSorter<? extends TableModel> sorter =
366 ((TableRowSorter<? extends TableModel> )shortcutTable.getRowSorter());
367 if (expr == null) {
368 sorter.setRowFilter(null);
369 } else {
370 expr = expr.replace("+", "\\+");
371 // split search string on whitespace, do case-insensitive AND search
372 ArrayList<RowFilter<Object, Object>> andFilters = new ArrayList<RowFilter<Object, Object>>();
373 for (String word : expr.split("\\s+")) {
374 andFilters.add(RowFilter.regexFilter("(?i)" + word));
375 }
376 sorter.setRowFilter(RowFilter.andFilter(andFilters));
377 }
378 model.fireTableDataChanged();
379 }
380 catch (PatternSyntaxException ex) { }
381 catch (ClassCastException ex2) { /* eliminate warning */ }
382 }
383
384 public void changedUpdate(DocumentEvent arg0) { filter(); }
385 public void insertUpdate(DocumentEvent arg0) { filter(); }
386 public void removeUpdate(DocumentEvent arg0) { filter(); }
387 }
388
389}
Note: See TracBrowser for help on using the repository browser.