org.eclipse.jface.bindings.keys.formatting
Interface IKeyFormatter
-
All Known Implementing Classes:
-
AbstractKeyFormatter,
EmacsKeyFormatter,
FormalKeyFormatter,
NativeKeyFormatter
-
public interface IKeyFormatter
Any formatter capable of taking a key sequence or a key stroke and converting
it into a string. These formatters are used to produce the strings that the
user sees in the keys preference page and the menus, as well as the strings
that are used for persistent storage.
-
Since:
- 3.1
format
String format(int key)
- Formats an individual key into a human readable format. This uses an
internationalization resource bundle to look up the key. This does not do
any platform-specific formatting (e.g., Carbon's command character).
-
-
Parameters:
-
key - The key to format.
-
Returns:
- The key formatted as a string; should not be
null.
format
String format(
KeySequence keySequence)
- Format the given key sequence into a string. The manner of the conversion
is dependent on the formatter. It is required that unequal key sequences
return unequal strings.
-
-
Parameters:
-
keySequence - The key sequence to convert; must not be null.
-
Returns:
- A string representation of the key sequence; must not be
null.
format
String format(
KeyStroke keyStroke)
- Format the given key strokes into a string. The manner of the conversion
is dependent on the formatter. It is required that unequal key strokes
return unequal strings.
-
-
Parameters:
-
keyStroke - The key stroke to convert; must not be null.
-
Returns:
- A string representation of the key stroke; must not be
null
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
