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

Last change on this file since 6248 was 6248, checked in by Don-vip, 11 years ago

Rework console output:

  • new log level "error"
  • Replace nearly all calls to system.out and system.err to Main.(error|warn|info|debug)
  • Remove some unnecessary debug output
  • Some messages are modified (removal of "Info", "Warning", "Error" from the message itself -> notable i18n impact but limited to console error messages not seen by the majority of users, so that's ok)
  • Property svn:eol-style set to native
File size: 17.9 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.preferences.shortcut;
3
4import static org.openstreetmap.josm.tools.I18n.marktr;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.Color;
8import java.awt.Component;
9import java.awt.Dimension;
10import java.awt.GridBagConstraints;
11import java.awt.GridBagLayout;
12import java.awt.Insets;
13import java.awt.Toolkit;
14import java.awt.event.KeyEvent;
15import java.lang.reflect.Field;
16import java.util.ArrayList;
17import java.util.LinkedHashMap;
18import java.util.Map;
19import java.util.regex.PatternSyntaxException;
20
21import javax.swing.AbstractAction;
22import javax.swing.BorderFactory;
23import javax.swing.BoxLayout;
24import javax.swing.DefaultComboBoxModel;
25import javax.swing.JCheckBox;
26import javax.swing.JLabel;
27import javax.swing.JPanel;
28import javax.swing.JScrollPane;
29import javax.swing.JTable;
30import javax.swing.KeyStroke;
31import javax.swing.ListSelectionModel;
32import javax.swing.RowFilter;
33import javax.swing.SwingConstants;
34import javax.swing.event.DocumentEvent;
35import javax.swing.event.DocumentListener;
36import javax.swing.event.ListSelectionEvent;
37import javax.swing.event.ListSelectionListener;
38import javax.swing.table.AbstractTableModel;
39import javax.swing.table.DefaultTableCellRenderer;
40import javax.swing.table.TableColumnModel;
41import javax.swing.table.TableModel;
42import javax.swing.table.TableRowSorter;
43
44import org.openstreetmap.josm.Main;
45import org.openstreetmap.josm.gui.widgets.JosmComboBox;
46import org.openstreetmap.josm.gui.widgets.JosmTextField;
47import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
48import org.openstreetmap.josm.tools.Shortcut;
49
50/**
51 * This is the keyboard preferences content.
52 * If someone wants to merge it with ShortcutPreference.java, feel free.
53 */
54public class PrefJPanel extends JPanel {
55
56 // table of shortcuts
57 private AbstractTableModel model;
58 // comboboxes of modifier groups, mapping selectedIndex to real data
59 private static int[] modifInts = new int[]{
60 -1,
61 0,
62 KeyEvent.SHIFT_DOWN_MASK,
63 KeyEvent.CTRL_DOWN_MASK,
64 KeyEvent.ALT_DOWN_MASK,
65 KeyEvent.META_DOWN_MASK,
66 KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK,
67 KeyEvent.ALT_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK,
68 KeyEvent.META_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK,
69 KeyEvent.CTRL_DOWN_MASK | KeyEvent.ALT_DOWN_MASK,
70 KeyEvent.CTRL_DOWN_MASK | KeyEvent.META_DOWN_MASK,
71 KeyEvent.ALT_DOWN_MASK | KeyEvent.META_DOWN_MASK,
72 KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK | KeyEvent.ALT_DOWN_MASK,
73 KeyEvent.META_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK | KeyEvent.ALT_DOWN_MASK
74 };
75 // and here are the texts fro the comboboxes
76 private static String[] modifList = new String[] {
77 tr("disabled"),
78 tr("no modifier"),
79 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[2]).getModifiers()),
80 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[3]).getModifiers()),
81 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[4]).getModifiers()),
82 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[5]).getModifiers()),
83 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[6]).getModifiers()),
84 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[7]).getModifiers()),
85 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[8]).getModifiers()),
86 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[9]).getModifiers()),
87 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[10]).getModifiers()),
88 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[11]).getModifiers()),
89 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[12]).getModifiers()),
90 KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, modifInts[13]).getModifiers())
91 };
92 // this are the display(!) texts for the checkboxes. Let the JVM do the i18n for us <g>.
93 // Ok, there's a real reason for this: The JVM should know best how the keys are labelled
94 // on the physical keyboard. What language pack is installed in JOSM is completely
95 // independent from the keyboard's labelling. But the operation system's locale
96 // usually matches the keyboard. This even works with my English Windows and my German
97 // keyboard.
98 private static String SHIFT = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.SHIFT_DOWN_MASK).getModifiers());
99 private static String CTRL = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.CTRL_DOWN_MASK).getModifiers());
100 private static String ALT = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.ALT_DOWN_MASK).getModifiers());
101 private static String META = KeyEvent.getKeyModifiersText(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.META_DOWN_MASK).getModifiers());
102
103 // A list of keys to present the user. Sadly this really is a list of keys Java knows about,
104 // not a list of real physical keys. If someone knows how to get that list?
105 private static Map<Integer, String> keyList = setKeyList();
106
107 private static Map<Integer, String> setKeyList() {
108 Map<Integer, String> list = new LinkedHashMap<Integer, String>();
109 String unknown = Toolkit.getProperty("AWT.unknown", "Unknown");
110 // Assume all known keys are declared in KeyEvent as "public static int VK_*"
111 for (Field field : KeyEvent.class.getFields()) {
112 if (field.getName().startsWith("VK_")) {
113 try {
114 int i = field.getInt(null);
115 String s = KeyEvent.getKeyText(i);
116 if (s != null && s.length() > 0 && !s.contains(unknown)) {
117 list.put(Integer.valueOf(i), s);
118 }
119 } catch (Exception e) {
120 e.printStackTrace();
121 }
122 }
123 }
124 list.put(Integer.valueOf(-1), "");
125 return list;
126 }
127
128 private JCheckBox cbAlt = new JCheckBox();
129 private JCheckBox cbCtrl = new JCheckBox();
130 private JCheckBox cbMeta = new JCheckBox();
131 private JCheckBox cbShift = new JCheckBox();
132 private JCheckBox cbDefault = new JCheckBox();
133 private JCheckBox cbDisable = new JCheckBox();
134 private JosmComboBox tfKey = new JosmComboBox();
135
136 JTable shortcutTable = new JTable();
137
138 private JosmTextField filterField = new JosmTextField();
139
140 /** Creates new form prefJPanel */
141 // Ain't those auto-generated comments helpful or what? <g>
142 public PrefJPanel(AbstractTableModel model) {
143 this.model = model;
144 initComponents();
145 }
146
147 /**
148 * Show only shortcuts with descriptions coontaing given substring
149 */
150 public void filter(String substring) {
151 filterField.setText(substring);
152 }
153
154 private class ShortcutTableCellRenderer extends DefaultTableCellRenderer {
155
156 private boolean name;
157
158 public ShortcutTableCellRenderer(boolean name) {
159 this.name = name;
160 }
161
162 @Override
163 public Component getTableCellRendererComponent(JTable table, Object value, boolean
164 isSelected, boolean hasFocus, int row, int column) {
165 int row1 = shortcutTable.convertRowIndexToModel(row);
166 Shortcut sc = (Shortcut)model.getValueAt(row1, -1);
167 if (sc==null) return null;
168 JLabel label = (JLabel) super.getTableCellRendererComponent(
169 table, name ? sc.getLongText() : sc.getKeyText(), isSelected, hasFocus, row, column);
170 label.setBackground(Main.pref.getUIColor("Table.background"));
171 if (isSelected) {
172 label.setForeground(Main.pref.getUIColor("Table.foreground"));
173 }
174 if(sc.getAssignedUser()) {
175 label.setBackground(Main.pref.getColor(
176 marktr("Shortcut Background: User"),
177 new Color(200,255,200)));
178 } else if(!sc.getAssignedDefault()) {
179 label.setBackground(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()));
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 PrefJPanel panel;
288 public CbAction (PrefJPanel panel) {
289 this.panel = panel;
290 }
291 @Override
292 public void valueChanged(ListSelectionEvent e) {
293 ListSelectionModel lsm = panel.shortcutTable.getSelectionModel(); // can't use e here
294 if (!lsm.isSelectionEmpty()) {
295 int row = panel.shortcutTable.convertRowIndexToModel(lsm.getMinSelectionIndex());
296 Shortcut sc = (Shortcut)panel.model.getValueAt(row, -1);
297 panel.cbDefault.setSelected(!sc.getAssignedUser());
298 panel.cbDisable.setSelected(sc.getKeyStroke() == null);
299 panel.cbShift.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.SHIFT_DOWN_MASK) != 0);
300 panel.cbCtrl.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.CTRL_DOWN_MASK) != 0);
301 panel.cbAlt.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.ALT_DOWN_MASK) != 0);
302 panel.cbMeta.setSelected(sc.getAssignedModifier() != -1 && (sc.getAssignedModifier() & KeyEvent.META_DOWN_MASK) != 0);
303 if (sc.getKeyStroke() != null) {
304 tfKey.setSelectedItem(keyList.get(sc.getKeyStroke().getKeyCode()));
305 } else {
306 tfKey.setSelectedItem(keyList.get(-1));
307 }
308 if (!sc.isChangeable()) {
309 disableAllModifierCheckboxes();
310 panel.tfKey.setEnabled(false);
311 } else {
312 panel.cbDefault.setEnabled(true);
313 actionPerformed(null);
314 }
315 model.fireTableRowsUpdated(row, row);
316 } else {
317 panel.disableAllModifierCheckboxes();
318 panel.tfKey.setEnabled(false);
319 }
320 }
321 @Override
322 public void actionPerformed(java.awt.event.ActionEvent e) {
323 ListSelectionModel lsm = panel.shortcutTable.getSelectionModel();
324 if (lsm != null && !lsm.isSelectionEmpty()) {
325 if (e != null) { // only if we've been called by a user action
326 int row = panel.shortcutTable.convertRowIndexToModel(lsm.getMinSelectionIndex());
327 Shortcut sc = (Shortcut)panel.model.getValueAt(row, -1);
328 if (panel.cbDisable.isSelected()) {
329 sc.setAssignedModifier(-1);
330 } else if (panel.tfKey.getSelectedItem() == null || panel.tfKey.getSelectedItem().equals("")) {
331 sc.setAssignedModifier(KeyEvent.VK_CANCEL);
332 } else {
333 sc.setAssignedModifier(
334 (panel.cbShift.isSelected() ? KeyEvent.SHIFT_DOWN_MASK : 0) |
335 (panel.cbCtrl.isSelected() ? KeyEvent.CTRL_DOWN_MASK : 0) |
336 (panel.cbAlt.isSelected() ? KeyEvent.ALT_DOWN_MASK : 0) |
337 (panel.cbMeta.isSelected() ? KeyEvent.META_DOWN_MASK : 0)
338 );
339 for (Map.Entry<Integer, String> entry : keyList.entrySet()) {
340 if (entry.getValue().equals(panel.tfKey.getSelectedItem())) {
341 sc.setAssignedKey(entry.getKey());
342 }
343 }
344 }
345 sc.setAssignedUser(!panel.cbDefault.isSelected());
346 valueChanged(null);
347 }
348 boolean state = !panel.cbDefault.isSelected();
349 panel.cbDisable.setEnabled(state);
350 state = state && !panel.cbDisable.isSelected();
351 panel.cbShift.setEnabled(state);
352 panel.cbCtrl.setEnabled(state);
353 panel.cbAlt.setEnabled(state);
354 panel.cbMeta.setEnabled(state);
355 panel.tfKey.setEnabled(state);
356 } else {
357 panel.disableAllModifierCheckboxes();
358 panel.tfKey.setEnabled(false);
359 }
360 }
361 }
362
363 class FilterFieldAdapter implements DocumentListener {
364 public void filter() {
365 String expr = filterField.getText().trim();
366 if (expr.length()==0) { expr=null; }
367 try {
368 final TableRowSorter<? extends TableModel> sorter =
369 ((TableRowSorter<? extends TableModel> )shortcutTable.getRowSorter());
370 if (expr == null) {
371 sorter.setRowFilter(null);
372 } else {
373 expr = expr.replace("+", "\\+");
374 // split search string on whitespace, do case-insensitive AND search
375 ArrayList<RowFilter<Object, Object>> andFilters = new ArrayList<RowFilter<Object, Object>>();
376 for (String word : expr.split("\\s+")) {
377 andFilters.add(RowFilter.regexFilter("(?i)" + word));
378 }
379 sorter.setRowFilter(RowFilter.andFilter(andFilters));
380 }
381 model.fireTableDataChanged();
382 }
383 catch (PatternSyntaxException ex) { }
384 catch (ClassCastException ex2) { /* eliminate warning */ }
385 }
386
387 @Override
388 public void changedUpdate(DocumentEvent arg0) { filter(); }
389 @Override
390 public void insertUpdate(DocumentEvent arg0) { filter(); }
391 @Override
392 public void removeUpdate(DocumentEvent arg0) { filter(); }
393 }
394
395}
Note: See TracBrowser for help on using the repository browser.