| /******************************************************************************* |
| * 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<KeyStroke> keyStrokeItr = keySequence.getKeyStrokes().iterator(); |
| while (keyStrokeItr.hasNext()) { |
| stringBuffer.append(format(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<ModifierKey> modifierKeys = new TreeSet<>(getModifierKeyComparator()); |
| modifierKeys.addAll(keyStroke.getModifierKeys()); |
| StringBuilder stringBuffer = new StringBuilder(); |
| Iterator<ModifierKey> modifierKeyItr = modifierKeys.iterator(); |
| while (modifierKeyItr.hasNext()) { |
| stringBuffer.append(format(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(); |
| |
| } |