org.eclipse.osbp.runtime.common.keystroke

Class KeyStrokeDefinition

java.lang.Object

org.eclipse.osbp.runtime.common.keystroke.KeyStrokeDefinition

public class KeyStrokeDefinition
extends Object

The Class KeyStrokeDefinition.

Constructor Summary

Constructors

Constructor and Description
KeyStrokeDefinition(String caption, int keyCode, int[] modifierKeys) Instantiates a new key stroke definition.

Method Summary

Modifier and Type	Method and Description
String	getCaption() Returns the caption of the keystroke definition.
int	getKeyCode() Returns the key code.
int[]	getModifierKeys() Returns the modifier keys.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStrokeDefinition

public KeyStrokeDefinition(String caption,
                           int keyCode,
                           int[] modifierKeys)

Instantiates a new key stroke definition.

Parameters:

caption - the caption

keyCode - the key code

modifierKeys - the modifier keys

Method Detail

getCaption

public String getCaption()

Returns the caption of the keystroke definition. Later it may use special characters to define keystrokes like ^&R which may define CRTL+ALT+R. But this feature is not supported yet.

Returns:

the caption

getKeyCode

public int getKeyCode()

Returns the key code. See See KeyCode.

Returns:

the key code

getModifierKeys

public int[] getModifierKeys()

Returns the modifier keys. See See ModifierKey.

Returns:

the modifier keys