blob: 867c983b7206d7fbe0645527ccf73a8e7e04c431 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.internal.keys;
import java.util.Comparator;
import java.util.Iterator;
import java.util.ResourceBundle;
import java.util.SortedSet;
import java.util.TreeSet;
import org.eclipse.ui.internal.util.Util;
import org.eclipse.ui.keys.IKeyFormatter;
import org.eclipse.ui.keys.Key;
import org.eclipse.ui.keys.KeySequence;
import org.eclipse.ui.keys.KeyStroke;
import org.eclipse.ui.keys.ModifierKey;
import org.eclipse.ui.keys.NaturalKey;
/**
* An abstract implementation of a key formatter that provides a lot of common
* key formatting functionality. It is recommended that those people
* implementing their own key formatters subclass from here, rather than
* implementing <code>KeyFormatter</code> directly.
*
* @since 3.0
*/
public abstract class AbstractKeyFormatter implements IKeyFormatter {
/**
* The key for the delimiter between keys. This is used in the
* internationalization bundles.
*/
protected static final String KEY_DELIMITER_KEY = "KEY_DELIMITER"; //$NON-NLS-1$
/**
* The key for the delimiter between key strokes. This is used in the
* internationalization bundles.
*/
protected static final String KEY_STROKE_DELIMITER_KEY = "KEY_STROKE_DELIMITER"; //$NON-NLS-1$
/**
* The bundle in which to look up the internationalized text for all of the
* individual keys in the system. This is the platform-agnostic version of
* the internationalized strings. Some platforms (namely Carbon) provide
* special Unicode characters and glyphs for some keys.
*/
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(AbstractKeyFormatter.class.getName());
@Override
public String format(Key key) {
String name = key.toString();
return Util.translateString(RESOURCE_BUNDLE, name, name, false, false);
}
@Override
public String format(KeySequence keySequence) {
StringBuilder stringBuffer = new StringBuilder();
Iterator keyStrokeItr = keySequence.getKeyStrokes().iterator();
while (keyStrokeItr.hasNext()) {
stringBuffer.append(format((KeyStroke) keyStrokeItr.next()));
if (keyStrokeItr.hasNext()) {
stringBuffer.append(getKeyStrokeDelimiter());
}
}
return stringBuffer.toString();
}
@Override
public String format(KeyStroke keyStroke) {
String keyDelimiter = getKeyDelimiter();
// Format the modifier keys, in sorted order.
SortedSet modifierKeys = new TreeSet(getModifierKeyComparator());
modifierKeys.addAll(keyStroke.getModifierKeys());
StringBuilder stringBuffer = new StringBuilder();
Iterator modifierKeyItr = modifierKeys.iterator();
while (modifierKeyItr.hasNext()) {
stringBuffer.append(format((ModifierKey) modifierKeyItr.next()));
stringBuffer.append(keyDelimiter);
}
// Format the natural key, if any.
NaturalKey naturalKey = keyStroke.getNaturalKey();
if (naturalKey != null) {
stringBuffer.append(format(naturalKey));
}
return stringBuffer.toString();
}
/**
* An accessor for the delimiter you wish to use between keys. This is used
* by the default format implementations to determine the key delimiter.
*
* @return The delimiter to use between keys; should not be <code>null</code>.
*/
protected abstract String getKeyDelimiter();
/**
* An accessor for the delimiter you wish to use between key strokes. This
* used by the default format implementations to determine the key stroke
* delimiter.
*
* @return The delimiter to use between key strokes; should not be <code>null</code>.
*/
protected abstract String getKeyStrokeDelimiter();
/**
* An accessor for the comparator to use for sorting modifier keys. This is
* used by the default format implementations to sort the modifier keys
* before formatting them into a string.
*
* @return The comparator to use to sort modifier keys; must not be <code>null</code>.
*/
protected abstract Comparator getModifierKeyComparator();
}
|
