|
 |
|
| |
org.eclipse.jface.action
Class LegacyActionTools
java.lang.Object
org.eclipse.jface.action.LegacyActionTools
-
public final class LegacyActionTools
- extends
Object
Some static utility methods for handling labels on actions. This includes
mnemonics and accelerators.
Clients may neither instantiate this class nor extend.
-
Since:
- 3.2
|
Field Summary
|
static char
|
MNEMONIC_NONE
The constant to use if there is no mnemonic for this location. |
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
MNEMONIC_NONE
public static final char MNEMONIC_NONE
- The constant to use if there is no mnemonic for this location.
-
See Also:
-
Constant Field Values
convertAccelerator
public static final
String convertAccelerator(int keyCode)
- Converts an accelerator key code to a string representation.
-
-
Parameters:
-
keyCode - the key code to be translated
-
Returns:
- a string representation of the key code
convertAccelerator
public static final int convertAccelerator(
String acceleratorText)
- Parses the given accelerator text, and converts it to an accelerator key
code.
-
-
Parameters:
-
acceleratorText - the accelerator text
-
Returns:
- the SWT key code, or 0 if there is no accelerator
extractAcceleratorText
public static final
String extractAcceleratorText(
String text)
- Extracts the accelerator text from the given text. Returns
null if there is no accelerator text, and the empty string
if there is no text after the accelerator delimeter (tab or '@').
-
-
Parameters:
-
text - the text for the action; may be null.
-
Returns:
- the accelerator text, or
null
extractMnemonic
public static final char extractMnemonic(
String text)
- Extracts the mnemonic text from the given string.
-
-
Parameters:
-
text - The text from which the mnemonic should be extracted; may be
null
-
Returns:
- The text of the mnemonic; will be
MNEMONIC_NONE if there
is no mnemonic;
findKeyCode
public static final int findKeyCode(
String token)
- Maps a standard keyboard key name to an SWT key code. Key names are
converted to upper case before comparison. If the key name is a single
letter, for example "S", its character code is returned.
The following key names are known (case is ignored):
-
"BACKSPACE"
-
"TAB"
-
"RETURN"
-
"ENTER"
-
"ESC"
-
"ESCAPE"
-
"DELETE"
-
"SPACE"
-
"ARROW_UP", "ARROW_DOWN",
"ARROW_LEFT", and "ARROW_RIGHT"
-
"PAGE_UP" and "PAGE_DOWN"
-
"HOME"
-
"END"
-
"INSERT"
-
"F1", "F2" through "F12"
-
-
Parameters:
-
token - the key name
-
Returns:
- the SWT key code,
-1 if no match was found -
See Also:
-
SWT
findKeyString
public static final
String findKeyString(int keyCode)
- Maps an SWT key code to a standard keyboard key name. The key code is
stripped of modifiers (SWT.CTRL, SWT.ALT, SWT.SHIFT, and SWT.COMMAND). If
the key code is not an SWT code (for example if it a key code for the key
'S'), a string containing a character representation of the key code is
returned.
-
-
Parameters:
-
keyCode - the key code to be translated
-
Returns:
- the string representation of the key code
-
Since:
- 2.0
-
See Also:
-
SWT
findModifier
public static final int findModifier(
String token)
- Maps standard keyboard modifier key names to the corresponding SWT
modifier bit. The following modifier key names are recognized (case is
ignored):
"CTRL", "SHIFT",
"ALT", and "COMMAND". The given modifier
key name is converted to upper case before comparison.
-
-
Parameters:
-
token - the modifier key name
-
Returns:
- the SWT modifier bit, or
0 if no match was found -
See Also:
-
SWT
findModifierString
public static final
String findModifierString(int keyCode)
- Returns a string representation of an SWT modifier bit (SWT.CTRL,
SWT.ALT, SWT.SHIFT, and SWT.COMMAND). Returns
null if the
key code is not an SWT modifier bit.
-
-
Parameters:
-
keyCode - the SWT modifier bit to be translated
-
Returns:
- the string representation of the SWT modifier bit, or
null if the key code was not an SWT modifier bit -
See Also:
-
SWT
removeAcceleratorText
public static final
String removeAcceleratorText(
String text)
- Convenience method for removing any optional accelerator text from the
given string. The accelerator text appears at the end of the text, and is
separated from the main part by a single tab character
'\t'.
-
-
Parameters:
-
text - the text
-
Returns:
- the text sans accelerator
removeMnemonics
public static final
String removeMnemonics(
String text)
- Convenience method for removing any mnemonics from the given string. For
example,
removeMnemonics("&Open") will return
"Open".
-
-
Parameters:
-
text - the text
-
Returns:
- the text sans mnemonics
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
