workbench.util

Class Hotkey

java.lang.Object

workbench.util.Hotkey

public class Hotkey
extends Object

Constructor Summary

Constructors

Constructor and Description
Hotkey(String keyS, String keyT, String sDesc, boolean flag, boolean fPrompt, String sData) constructor

Method Summary

Modifier and Type	Method and Description
String	getData() hotkey data
String	getDesc() description to be displayed in dialog box
boolean	getEnabled() is hotkey active
String	getKeyStroke() hotkey key stroke The string must have the following syntax: * ( | ) modifiers := shift | control | ctrl | meta | alt | button1 | button2 | button3 typedID := typed typedKey := string of length 1 giving Unicode character.
boolean	getPrompt() whether to display dialog box?
String	getType() type of hotkey
String	toString() get HotKey information

Methods inherited from class java.lang.Object

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

Constructor Detail

Hotkey

public Hotkey(String keyS,
              String keyT,
              String sDesc,
              boolean flag,
              boolean fPrompt,
              String sData)

constructor

Parameters:

keyS - key stroke

keyT - type of hotkey

sDesc - description

flag - active/inactive

fPrompt - display dialog box?

sData - data string

Method Detail

getData

public String getData()

hotkey data

Returns:

String value

getDesc

public String getDesc()

description to be displayed in dialog box

Returns:

String value

getEnabled

public boolean getEnabled()

is hotkey active

Returns:

true/false

getKeyStroke

public String getKeyStroke()

hotkey key stroke The string must have the following syntax: * ( | ) modifiers := shift | control | ctrl | meta | alt | button1 | button2 | button3 typedID := typed typedKey := string of length 1 giving Unicode character. pressedReleasedID := (pressed | released) key key := KeyEvent key code name, i.e. the name following "VK_". If typed, pressed or released is not specified, pressed is assumed. Here are some examples: 1. "INSERT" => getKeyStroke(KeyEvent.VK_INSERT, 0); 2. "control DELETE" => getKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK); 3. "alt shift X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK); 4. "alt shift released X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true); 5. "typed a" => getKeyStroke('a');

Returns:

String value

getPrompt

public boolean getPrompt()

whether to display dialog box?

Returns:

true/false

getType

public String getType()

type of hotkey

Returns:

String value

toString

public String toString()

get HotKey information

Overrides:

toString in class Object

Returns:

String value