org.eclipse.jface.bindings.keys
Class SWTKeySupport
java.lang.Object
org.eclipse.jface.bindings.keys.SWTKeySupport
-
public final class SWTKeySupport
- extends
Object
A utility class for converting SWT events into key strokes.
-
Since:
- 3.1
|
Constructor Summary
|
protected
|
SWTKeySupport
()
This class should never be instantiated. |
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
SWTKeySupport
protected SWTKeySupport()
- This class should never be instantiated.
convertAcceleratorToKeyStroke
public static final
KeyStroke convertAcceleratorToKeyStroke(int accelerator)
- Given an SWT accelerator value, provide the corresponding key stroke.
-
-
Parameters:
-
accelerator - The accelerator to convert; should be a valid SWT accelerator
value.
-
Returns:
- The equivalent key stroke; never
null.
convertEventToModifiedAccelerator
public static final int convertEventToModifiedAccelerator(
Event event)
-
Converts the given event into an SWT accelerator value -- considering the
modified character with the shift modifier. This is the third accelerator
value that should be checked when processing incoming key events.
For example, on a standard US keyboard, "Ctrl+Shift+5" would be viewed as
"Ctrl+Shift+%".
-
-
Parameters:
-
event - The event to be converted; must not be null.
-
Returns:
- The combination of the state mask and the unmodified character.
convertEventToUnmodifiedAccelerator
public static final int convertEventToUnmodifiedAccelerator(
Event event)
-
Converts the given event into an SWT accelerator value -- considering the
unmodified character with all modifier keys. This is the first
accelerator value that should be checked when processing incoming key
events. However, all alphabetic characters are considered as their
uppercase equivalents.
For example, on a standard US keyboard, "Ctrl+Shift+5" would be viewed as
"Ctrl+Shift+5".
-
-
Parameters:
-
event - The event to be converted; must not be null.
-
Returns:
- The combination of the state mask and the unmodified character.
convertEventToUnmodifiedAccelerator
public static final int convertEventToUnmodifiedAccelerator(
KeyEvent event)
-
Converts the given event into an SWT accelerator value -- considering the
unmodified character with all modifier keys. This is the first
accelerator value that should be checked. However, all alphabetic
characters are considered as their uppercase equivalents.
For example, on a standard US keyboard, "Ctrl+Shift+5" would be viewed as
"Ctrl+%".
-
-
Parameters:
-
event - The event to be converted; must not be null.
-
Returns:
- The combination of the state mask and the unmodified character.
convertEventToUnshiftedModifiedAccelerator
public static final int convertEventToUnshiftedModifiedAccelerator(
Event event)
- Converts the given event into an SWT accelerator value -- considering the
modified character without the shift modifier. This is the second
accelerator value that should be checked when processing incoming key
events. Key strokes with alphabetic natural keys are run through
convertEventToUnmodifiedAccelerator.
-
-
Parameters:
-
event - The event to be converted; must not be null.
-
Returns:
- The combination of the state mask without shift, and the modified
character.
convertKeyStrokeToAccelerator
public static final int convertKeyStrokeToAccelerator(
KeyStroke keyStroke)
- Given a key stroke, this method provides the equivalent SWT accelerator
value. The functional inverse of
convertAcceleratorToKeyStroke.
-
-
Parameters:
-
keyStroke - The key stroke to convert; must not be null.
-
Returns:
- The SWT accelerator value
getKeyFormatterForPlatform
public static
IKeyFormatter getKeyFormatterForPlatform()
- Provides an instance of
IKeyFormatter appropriate for the
current instance.
-
-
Returns:
- an instance of
IKeyFormatter appropriate for the
current instance; never null.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
