org.sikuli.basics

Class HotkeyManager

java.lang.Object

org.sikuli.basics.HotkeyManager

Direct Known Subclasses:

LinuxHotkeyManager, MacHotkeyManager, WindowsHotkeyManager

public abstract class HotkeyManager
extends Object

Singleton class to bind hotkeys to hotkey listeners

Constructor Summary

Constructors

Constructor and Description
HotkeyManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	_addHotkey(int keyCode, int modifiers, HotkeyListener callback)
abstract boolean	_removeHotkey(int keyCode, int modifiers)
boolean	addHotkey(char key, int modifiers, HotkeyListener callback) install a hotkey listener.
boolean	addHotkey(String hotkeyType, HotkeyListener callback) install a hotkey listener for a global hotkey (capture, abort, ...)
boolean	addHotkey(String key, int modifiers, HotkeyListener callback) install a hotkey listener.
abstract void	cleanUp()
String	getHotKeyText(String hotkeyType)
static HotkeyManager	getInstance()
boolean	removeHotkey(char key, int modifiers) remove a hotkey and uninstall a hotkey listener.
boolean	removeHotkey(String hotkeyType) remove a hotkey by type (not supported yet)
boolean	removeHotkey(String key, int modifiers) uninstall a hotkey listener.
static void	reset() remove all hotkeys

Methods inherited from class java.lang.Object

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

Constructor Detail

HotkeyManager

public HotkeyManager()

Method Detail

getInstance

public static HotkeyManager getInstance()

reset

public static void reset()

remove all hotkeys

addHotkey

public boolean addHotkey(String hotkeyType,
                         HotkeyListener callback)

install a hotkey listener for a global hotkey (capture, abort, ...)

Parameters:

hotkeyType - a type string

callback - HotkeyListener

Returns:

success

getHotKeyText

public String getHotKeyText(String hotkeyType)

addHotkey

public boolean addHotkey(char key,
                         int modifiers,
                         HotkeyListener callback)

install a hotkey listener.

Parameters:

key - key character (class Key)

modifiers - modifiers flag

callback - HotkeyListener

Returns:

true if success. false otherwise.

addHotkey

public boolean addHotkey(String key,
                         int modifiers,
                         HotkeyListener callback)

install a hotkey listener.

Parameters:

key - key character (class Key)

modifiers - modifiers flag

callback - HotkeyListener

Returns:

true if success. false otherwise.

removeHotkey

public boolean removeHotkey(String hotkeyType)

remove a hotkey by type (not supported yet)

Parameters:

hotkeyType - capture, abort, ...

Returns:

success

removeHotkey

public boolean removeHotkey(char key,
                            int modifiers)

remove a hotkey and uninstall a hotkey listener.

Parameters:

key - key character (class Key)

modifiers - modifiers flag

Returns:

true if success. false otherwise.

removeHotkey

public boolean removeHotkey(String key,
                            int modifiers)

uninstall a hotkey listener.

Parameters:

key - key string (class Key)

modifiers - modifiers flag

Returns:

true if success. false otherwise.

_addHotkey

public abstract boolean _addHotkey(int keyCode,
                                   int modifiers,
                                   HotkeyListener callback)

_removeHotkey

public abstract boolean _removeHotkey(int keyCode,
                                      int modifiers)

cleanUp

public abstract void cleanUp()