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.
Modifier and Type | Method and Description |
---|---|
String |
format(int key)
Formats an individual key into a human readable format.
|
String |
format(KeySequence keySequence)
Format the given key sequence into a string.
|
String |
format(KeyStroke keyStroke)
Format the given key strokes into a string.
|
String format(int key)
key
- The key to format.null
.String format(KeySequence keySequence)
keySequence
- The key sequence to convert; must not be null
.null
.String format(KeyStroke keyStroke)
keyStroke
- The key stroke to convert; must not be null
.
null
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.