org.sikuli.script.Key

public class Key
extends Object

this class implements an interface to the Java key system as represented by java.awt.event.KeyEvent. for the functions Region.type() and Region.write() by translating key constants for special keys and plain text per character.
for details consult the docs

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ADD`
`static String`	`ALT`
`static String`	`ALTGR`
`static String`	`BACKSPACE`
`static char`	`C_ADD`
`static char`	`C_ALT`
`static char`	`C_ALTGR`
`static char`	`C_CAPS_LOCK`
`static char`	`C_CMD`
`static char`	`C_CONTEXT`
`static char`	`C_CTRL`
`static char`	`C_DECIMAL`
`static char`	`C_DELETE`
`static char`	`C_DIVIDE`
`static char`	`C_DOWN`
`static char`	`C_END`
`static char`	`C_ESC`
`static char`	`C_F1`
`static char`	`C_F10`
`static char`	`C_F11`
`static char`	`C_F12`
`static char`	`C_F13`
`static char`	`C_F14`
`static char`	`C_F15`
`static char`	`C_F2`
`static char`	`C_F3`
`static char`	`C_F4`
`static char`	`C_F5`
`static char`	`C_F6`
`static char`	`C_F7`
`static char`	`C_F8`
`static char`	`C_F9`
`static char`	`C_HOME`
`static char`	`C_INSERT`
`static char`	`C_LEFT`
`static char`	`C_META`
`static char`	`C_MINUS`
`static char`	`C_MULTIPLY`
`static char`	`C_NEXT`
`static char`	`C_NUM_LOCK`
`static char`	`C_NUM0`
`static char`	`C_NUM1`
`static char`	`C_NUM2`
`static char`	`C_NUM3`
`static char`	`C_NUM4`
`static char`	`C_NUM5`
`static char`	`C_NUM6`
`static char`	`C_NUM7`
`static char`	`C_NUM8`
`static char`	`C_NUM9`
`static char`	`C_PAGE_DOWN`
`static char`	`C_PAGE_UP`
`static char`	`C_PAUSE`
`static char`	`C_PRINTSCREEN`
`static char`	`C_RIGHT`
`static char`	`C_SCROLL_LOCK`
`static char`	`C_SEPARATOR`
`static char`	`C_SHIFT`
`static char`	`C_UP`
`static char`	`C_WIN`
`static String`	`CAPS_LOCK`
`static char`	`cMax`
`static String`	`CMD`
`static char`	`cMin`
`static String`	`CONTEXT`
`static String`	`CTRL`
`static String`	`DECIMAL`
`static String`	`DELETE`
`static String`	`DIVIDE`
`static String`	`DOWN`
`static String`	`END`
`static String`	`ENTER`
`static String`	`ESC`
`static String`	`F1`
`static String`	`F10`
`static String`	`F11`
`static String`	`F12`
`static String`	`F13`
`static String`	`F14`
`static String`	`F15`
`static String`	`F2`
`static String`	`F3`
`static String`	`F4`
`static String`	`F5`
`static String`	`F6`
`static String`	`F7`
`static String`	`F8`
`static String`	`F9`
`static String`	`HOME`
`static String`	`INSERT`
`static String`	`keyboardUS`
`static int`	`keyMaxLength`
`static String`	`LEFT`
`static String`	`META`
`static String`	`MINUS`
`static String`	`MULTIPLY`
`static String`	`NEXT`
`static String`	`NUM_LOCK`
`static String`	`NUM0`
`static String`	`NUM1`
`static String`	`NUM2`
`static String`	`NUM3`
`static String`	`NUM4`
`static String`	`NUM5`
`static String`	`NUM6`
`static String`	`NUM7`
`static String`	`NUM8`
`static String`	`NUM9`
`static String`	`PAGE_DOWN`
`static String`	`PAGE_UP`
`static String`	`PAUSE`
`static String`	`PRINTSCREEN`
`static String`	`RIGHT`
`static String`	`SCROLL_LOCK`
`static String`	`SEPARATOR`
`static String`	`SHIFT`
`static String`	`SPACE`
`static String`	`TAB`
`static String`	`UP`
`static String`	`WIN`

Constructor Summary

Constructors

Constructor Description

Key()

Method Summary

Modifier and Type	Method	Description
`static boolean`	`addHotkey(char key, int modifiers, HotkeyListener listener)`	add a hotkey and listener
`static boolean`	`addHotkey(String key, int modifiers, HotkeyListener listener)`	add a hotkey and listener
`static String`	`convertKeyToText(int code, int mod)`	INTERNAL USE ONLY
`protected static int`	`convertModifiers(String mod)`
`static void`	`createKeyTable()`	INTERNAL USE ONLY create a table containing all relevant key, keycode and keytext settings for VK_xxx
`static void`	`dump()`
`static int`	`getHotkeyModifier()`	HotKey modifier to be used with Sikuli's HotKey feature
`static String`	`getTextFromKeycode(int key)`
`static boolean`	`isLockOn(char key)`	get the lock state of the given key
`static boolean`	`isModifier(String token)`
`static boolean`	`isRepeatable(String token)`
`static boolean`	`removeHotkey(char key, int modifiers)`	remove a hotkey and listener
`static boolean`	`removeHotkey(String key, int modifiers)`	remove a hotkey and listener
`static int[]`	`toJavaKeyCode(char key)`	Convert Sikuli Key to Java virtual key code
`static int[]`	`toJavaKeyCode(String key)`	Convert Sikuli Key to Java virtual key code
`static int`	`toJavaKeyCodeFromText(String key)`
`static String`	`toJavaKeyCodeText(char key)`

Methods inherited from class java.lang.Object

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

Field Details
- keyboardUS
  
  public static String keyboardUS
- SPACE
  
  public static final String SPACE
  
  See Also:
  
  Constant Field Values
- ENTER
  
  public static final String ENTER
  
  See Also:
  
  Constant Field Values
- BACKSPACE
  
  public static final String BACKSPACE
  
  See Also:
  
  Constant Field Values
- TAB
  
  public static final String TAB
  
  See Also:
  
  Constant Field Values
- ESC
  
  public static final String ESC
  
  See Also:
  
  Constant Field Values
- C_ESC
  
  public static final char C_ESC
  
  See Also:
  
  Constant Field Values
- UP
  
  public static final String UP
  
  See Also:
  
  Constant Field Values
- C_UP
  
  public static final char C_UP
  
  See Also:
  
  Constant Field Values
- RIGHT
  
  public static final String RIGHT
  
  See Also:
  
  Constant Field Values
- C_RIGHT
  
  public static final char C_RIGHT
  
  See Also:
  
  Constant Field Values
- DOWN
  
  public static final String DOWN
  
  See Also:
  
  Constant Field Values
- C_DOWN
  
  public static final char C_DOWN
  
  See Also:
  
  Constant Field Values
- LEFT
  
  public static final String LEFT
  
  See Also:
  
  Constant Field Values
- C_LEFT
  
  public static final char C_LEFT
  
  See Also:
  
  Constant Field Values
- PAGE_UP
  
  public static final String PAGE_UP
  
  See Also:
  
  Constant Field Values
- C_PAGE_UP
  
  public static final char C_PAGE_UP
  
  See Also:
  
  Constant Field Values
- PAGE_DOWN
  
  public static final String PAGE_DOWN
  
  See Also:
  
  Constant Field Values
- C_PAGE_DOWN
  
  public static final char C_PAGE_DOWN
  
  See Also:
  
  Constant Field Values
- DELETE
  
  public static final String DELETE
  
  See Also:
  
  Constant Field Values
- C_DELETE
  
  public static final char C_DELETE
  
  See Also:
  
  Constant Field Values
- END
  
  public static final String END
  
  See Also:
  
  Constant Field Values
- C_END
  
  public static final char C_END
  
  See Also:
  
  Constant Field Values
- HOME
  
  public static final String HOME
  
  See Also:
  
  Constant Field Values
- C_HOME
  
  public static final char C_HOME
  
  See Also:
  
  Constant Field Values
- INSERT
  
  public static final String INSERT
  
  See Also:
  
  Constant Field Values
- C_INSERT
  
  public static final char C_INSERT
  
  See Also:
  
  Constant Field Values
- F1
  
  public static final String F1
  
  See Also:
  
  Constant Field Values
- C_F1
  
  public static final char C_F1
  
  See Also:
  
  Constant Field Values
- F2
  
  public static final String F2
  
  See Also:
  
  Constant Field Values
- C_F2
  
  public static final char C_F2
  
  See Also:
  
  Constant Field Values
- F3
  
  public static final String F3
  
  See Also:
  
  Constant Field Values
- C_F3
  
  public static final char C_F3
  
  See Also:
  
  Constant Field Values
- F4
  
  public static final String F4
  
  See Also:
  
  Constant Field Values
- C_F4
  
  public static final char C_F4
  
  See Also:
  
  Constant Field Values
- F5
  
  public static final String F5
  
  See Also:
  
  Constant Field Values
- C_F5
  
  public static final char C_F5
  
  See Also:
  
  Constant Field Values
- F6
  
  public static final String F6
  
  See Also:
  
  Constant Field Values
- C_F6
  
  public static final char C_F6
  
  See Also:
  
  Constant Field Values
- F7
  
  public static final String F7
  
  See Also:
  
  Constant Field Values
- C_F7
  
  public static final char C_F7
  
  See Also:
  
  Constant Field Values
- F8
  
  public static final String F8
  
  See Also:
  
  Constant Field Values
- C_F8
  
  public static final char C_F8
  
  See Also:
  
  Constant Field Values
- F9
  
  public static final String F9
  
  See Also:
  
  Constant Field Values
- C_F9
  
  public static final char C_F9
  
  See Also:
  
  Constant Field Values
- F10
  
  public static final String F10
  
  See Also:
  
  Constant Field Values
- C_F10
  
  public static final char C_F10
  
  See Also:
  
  Constant Field Values
- F11
  
  public static final String F11
  
  See Also:
  
  Constant Field Values
- C_F11
  
  public static final char C_F11
  
  See Also:
  
  Constant Field Values
- F12
  
  public static final String F12
  
  See Also:
  
  Constant Field Values
- C_F12
  
  public static final char C_F12
  
  See Also:
  
  Constant Field Values
- F13
  
  public static final String F13
  
  See Also:
  
  Constant Field Values
- C_F13
  
  public static final char C_F13
  
  See Also:
  
  Constant Field Values
- F14
  
  public static final String F14
  
  See Also:
  
  Constant Field Values
- C_F14
  
  public static final char C_F14
  
  See Also:
  
  Constant Field Values
- F15
  
  public static final String F15
  
  See Also:
  
  Constant Field Values
- C_F15
  
  public static final char C_F15
  
  See Also:
  
  Constant Field Values
- SHIFT
  
  public static final String SHIFT
  
  See Also:
  
  Constant Field Values
- C_SHIFT
  
  public static final char C_SHIFT
  
  See Also:
  
  Constant Field Values
- CTRL
  
  public static final String CTRL
  
  See Also:
  
  Constant Field Values
- C_CTRL
  
  public static final char C_CTRL
  
  See Also:
  
  Constant Field Values
- ALT
  
  public static final String ALT
  
  See Also:
  
  Constant Field Values
- C_ALT
  
  public static final char C_ALT
  
  See Also:
  
  Constant Field Values
- ALTGR
  
  public static final String ALTGR
  
  See Also:
  
  Constant Field Values
- C_ALTGR
  
  public static final char C_ALTGR
  
  See Also:
  
  Constant Field Values
- META
  
  public static final String META
  
  See Also:
  
  Constant Field Values
- C_META
  
  public static final char C_META
  
  See Also:
  
  Constant Field Values
- CMD
  
  public static final String CMD
  
  See Also:
  
  Constant Field Values
- C_CMD
  
  public static final char C_CMD
  
  See Also:
  
  Constant Field Values
- WIN
  
  public static final String WIN
  
  See Also:
  
  Constant Field Values
- C_WIN
  
  public static final char C_WIN
  
  See Also:
  
  Constant Field Values
- PRINTSCREEN
  
  public static final String PRINTSCREEN
  
  See Also:
  
  Constant Field Values
- C_PRINTSCREEN
  
  public static final char C_PRINTSCREEN
  
  See Also:
  
  Constant Field Values
- SCROLL_LOCK
  
  public static final String SCROLL_LOCK
  
  See Also:
  
  Constant Field Values
- C_SCROLL_LOCK
  
  public static final char C_SCROLL_LOCK
  
  See Also:
  
  Constant Field Values
- PAUSE
  
  public static final String PAUSE
  
  See Also:
  
  Constant Field Values
- C_PAUSE
  
  public static final char C_PAUSE
  
  See Also:
  
  Constant Field Values
- CAPS_LOCK
  
  public static final String CAPS_LOCK
  
  See Also:
  
  Constant Field Values
- C_CAPS_LOCK
  
  public static final char C_CAPS_LOCK
  
  See Also:
  
  Constant Field Values
- NUM0
  
  public static final String NUM0
  
  See Also:
  
  Constant Field Values
- C_NUM0
  
  public static final char C_NUM0
  
  See Also:
  
  Constant Field Values
- NUM1
  
  public static final String NUM1
  
  See Also:
  
  Constant Field Values
- C_NUM1
  
  public static final char C_NUM1
  
  See Also:
  
  Constant Field Values
- NUM2
  
  public static final String NUM2
  
  See Also:
  
  Constant Field Values
- C_NUM2
  
  public static final char C_NUM2
  
  See Also:
  
  Constant Field Values
- NUM3
  
  public static final String NUM3
  
  See Also:
  
  Constant Field Values
- C_NUM3
  
  public static final char C_NUM3
  
  See Also:
  
  Constant Field Values
- NUM4
  
  public static final String NUM4
  
  See Also:
  
  Constant Field Values
- C_NUM4
  
  public static final char C_NUM4
  
  See Also:
  
  Constant Field Values
- NUM5
  
  public static final String NUM5
  
  See Also:
  
  Constant Field Values
- C_NUM5
  
  public static final char C_NUM5
  
  See Also:
  
  Constant Field Values
- NUM6
  
  public static final String NUM6
  
  See Also:
  
  Constant Field Values
- C_NUM6
  
  public static final char C_NUM6
  
  See Also:
  
  Constant Field Values
- NUM7
  
  public static final String NUM7
  
  See Also:
  
  Constant Field Values
- C_NUM7
  
  public static final char C_NUM7
  
  See Also:
  
  Constant Field Values
- NUM8
  
  public static final String NUM8
  
  See Also:
  
  Constant Field Values
- C_NUM8
  
  public static final char C_NUM8
  
  See Also:
  
  Constant Field Values
- NUM9
  
  public static final String NUM9
  
  See Also:
  
  Constant Field Values
- C_NUM9
  
  public static final char C_NUM9
  
  See Also:
  
  Constant Field Values
- SEPARATOR
  
  public static final String SEPARATOR
  
  See Also:
  
  Constant Field Values
- C_SEPARATOR
  
  public static final char C_SEPARATOR
  
  See Also:
  
  Constant Field Values
- NUM_LOCK
  
  public static final String NUM_LOCK
  
  See Also:
  
  Constant Field Values
- C_NUM_LOCK
  
  public static final char C_NUM_LOCK
  
  See Also:
  
  Constant Field Values
- ADD
  
  public static final String ADD
  
  See Also:
  
  Constant Field Values
- C_ADD
  
  public static final char C_ADD
  
  See Also:
  
  Constant Field Values
- MINUS
  
  public static final String MINUS
  
  See Also:
  
  Constant Field Values
- C_MINUS
  
  public static final char C_MINUS
  
  See Also:
  
  Constant Field Values
- MULTIPLY
  
  public static final String MULTIPLY
  
  See Also:
  
  Constant Field Values
- C_MULTIPLY
  
  public static final char C_MULTIPLY
  
  See Also:
  
  Constant Field Values
- DIVIDE
  
  public static final String DIVIDE
  
  See Also:
  
  Constant Field Values
- C_DIVIDE
  
  public static final char C_DIVIDE
  
  See Also:
  
  Constant Field Values
- DECIMAL
  
  public static final String DECIMAL
  
  See Also:
  
  Constant Field Values
- C_DECIMAL
  
  public static final char C_DECIMAL
  
  See Also:
  
  Constant Field Values
- CONTEXT
  
  public static final String CONTEXT
  
  See Also:
  
  Constant Field Values
- C_CONTEXT
  
  public static final char C_CONTEXT
  
  See Also:
  
  Constant Field Values
- NEXT
  
  public static final String NEXT
  
  See Also:
  
  Constant Field Values
- C_NEXT
  
  public static final char C_NEXT
  
  See Also:
  
  Constant Field Values
- cMax
  
  public static final char cMax
  
  See Also:
  
  Constant Field Values
- cMin
  
  public static final char cMin
  
  See Also:
  
  Constant Field Values
- keyMaxLength
  
  public static int keyMaxLength
Constructor Details
- Key
  
  public Key()
Method Details
- addHotkey
  
  public static boolean addHotkey(String key, int modifiers, HotkeyListener listener)
  
  add a hotkey and listener
  
  Parameters:
  
  key - respective key specifier according class Key
  
  modifiers - respective key specifier according class KeyModifiers
  
  listener - a HotKeyListener instance
  
  Returns:
  
  true if ok, false otherwise
- addHotkey
  
  public static boolean addHotkey(char key, int modifiers, HotkeyListener listener)
  
  add a hotkey and listener
  
  Parameters:
  
  key - respective key specifier according class Key
  
  modifiers - respective key specifier according class KeyModifiers
  
  listener - a HotKeyListener instance
  
  Returns:
  
  true if ok, false otherwise
- removeHotkey
  
  public static boolean removeHotkey(String key, int modifiers)
  
  remove a hotkey and listener
  
  Parameters:
  
  key - respective key specifier according class Key
  
  modifiers - respective key specifier according class KeyModifiers
  
  Returns:
  
  true if ok, false otherwise
- removeHotkey
  
  public static boolean removeHotkey(char key, int modifiers)
  
  remove a hotkey and listener
  
  Parameters:
  
  key - respective key specifier according class Key
  
  modifiers - respective key specifier according class KeyModifiers
  
  Returns:
  
  true if ok, false otherwise
- getTextFromKeycode
  
  public static String getTextFromKeycode(int key)
- isRepeatable
  
  public static boolean isRepeatable(String token)
- isModifier
  
  public static boolean isModifier(String token)
- toJavaKeyCodeFromText
  
  public static int toJavaKeyCodeFromText(String key)
- dump
  
  public static void dump()
- toJavaKeyCode
  
  public static int[] toJavaKeyCode(String key)
  
  Convert Sikuli Key to Java virtual key code
  
  Parameters:
  
  key - as String
  
  Returns:
  
  the Java KeyCodes
- toJavaKeyCode
  
  public static int[] toJavaKeyCode(char key)
  
  Convert Sikuli Key to Java virtual key code
  
  Parameters:
  
  key - as Character
  
  Returns:
  
  the Java KeyCodes
- toJavaKeyCodeText
  
  public static String toJavaKeyCodeText(char key)
  
  Parameters:
  
  key - as Character
  
  Returns:
  
  a printable version of a special key
- convertModifiers
  
  protected static int convertModifiers(String mod)
- isLockOn
  
  public static boolean isLockOn(char key)
  
  get the lock state of the given key
  
  Parameters:
  
  key - as Character (scroll, caps, num)
  
  Returns:
  
  true/false
- getHotkeyModifier
  
  public static int getHotkeyModifier()
  
  HotKey modifier to be used with Sikuli's HotKey feature
  
  Returns:
  
  META(CMD) on Mac, CTRL otherwise
- convertKeyToText
  
  public static String convertKeyToText(int code, int mod)
  
  INTERNAL USE ONLY
  
  Parameters:
  
  code - keycode
  
  mod - modifier
  
  Returns:
  
  readable key text
- createKeyTable
  
  public static void createKeyTable()
  
  INTERNAL USE ONLY create a table containing all relevant key, keycode and keytext settings for VK_xxx

Class Key

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details