com.threerings.util

Class KeyboardManager

java.lang.Object

com.threerings.util.KeyboardManager

All Implemented Interfaces:

WindowFocusListener, KeyEventDispatcher, EventListener, AncestorListener

public class KeyboardManager
extends Object
implements KeyEventDispatcher, AncestorListener, WindowFocusListener

The keyboard manager observes keyboard actions on a particular component and posts commands associated with the key presses to the Controller hierarchy. It allows specifying the key repeat rate, and will begin repeating a key immediately after it is held down rather than depending on the system-specific key repeat delay/rate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyboardManager.KeyObserver An interface to be implemented by those that care to be notified whenever an event (either a key press or a key release) occurs for any key while the keyboard manager is active.

Constructor Summary

Constructors

Constructor and Description
KeyboardManager() Constructs a keyboard manager that is initially disabled.

Method Summary

Modifier and Type	Method and Description
void	ancestorAdded(AncestorEvent e)
void	ancestorMoved(AncestorEvent e)
void	ancestorRemoved(AncestorEvent e)
boolean	dispatchKeyEvent(KeyEvent e)
void	registerKeyObserver(KeyboardManager.KeyObserver obs) Registers a key observer that will be notified of all key events while the keyboard manager is active.
void	releaseAllKeys() Releases all keys and ceases any hot repeating action that may be going on.
void	removeKeyObserver(KeyboardManager.KeyObserver obs) Removes the supplied key observer from the list of observers to be notified of all key events while the keyboard manager is active.
void	reset() Resets the keyboard manager, clearing any target and key translator in use and disabling the keyboard manager if it is currently active.
void	setEnabled(boolean enabled) Sets whether the keyboard manager processes keyboard input.
void	setRepeatDelay(long delay) Sets the expected delay in milliseconds between each key press/release event the keyboard manager should expect to receive while a key is repeating.
void	setTarget(JComponent target, KeyTranslator xlate) Initializes the keyboard manager with the supplied target component and key translator and disables the keyboard manager if it is currently active.
void	windowGainedFocus(WindowEvent e)
void	windowLostFocus(WindowEvent e)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyboardManager

public KeyboardManager()

Constructs a keyboard manager that is initially disabled. The keyboard manager should not be enabled until it has been supplied with a target component and translator via setTarget(javax.swing.JComponent, com.threerings.util.KeyTranslator).

Method Detail

reset

public void reset()

Resets the keyboard manager, clearing any target and key translator in use and disabling the keyboard manager if it is currently active.

setTarget

public void setTarget(JComponent target,
                      KeyTranslator xlate)

Initializes the keyboard manager with the supplied target component and key translator and disables the keyboard manager if it is currently active.

Parameters:

target - the component whose keyboard events are to be observed.

xlate - the key translator used to map keyboard events to controller action commands.

registerKeyObserver

public void registerKeyObserver(KeyboardManager.KeyObserver obs)

Registers a key observer that will be notified of all key events while the keyboard manager is active.

removeKeyObserver

public void removeKeyObserver(KeyboardManager.KeyObserver obs)

Removes the supplied key observer from the list of observers to be notified of all key events while the keyboard manager is active.

setEnabled

public void setEnabled(boolean enabled)

Sets whether the keyboard manager processes keyboard input.

setRepeatDelay

public void setRepeatDelay(long delay)

Sets the expected delay in milliseconds between each key press/release event the keyboard manager should expect to receive while a key is repeating.

releaseAllKeys

public void releaseAllKeys()

Releases all keys and ceases any hot repeating action that may be going on.

dispatchKeyEvent

public boolean dispatchKeyEvent(KeyEvent e)

Specified by:

dispatchKeyEvent in interface KeyEventDispatcher

ancestorAdded

public void ancestorAdded(AncestorEvent e)

Specified by:

ancestorAdded in interface AncestorListener

ancestorMoved

public void ancestorMoved(AncestorEvent e)

Specified by:

ancestorMoved in interface AncestorListener

ancestorRemoved

public void ancestorRemoved(AncestorEvent e)

Specified by:

ancestorRemoved in interface AncestorListener

windowGainedFocus

public void windowGainedFocus(WindowEvent e)

Specified by:

windowGainedFocus in interface WindowFocusListener

windowLostFocus

public void windowLostFocus(WindowEvent e)

Specified by:

windowLostFocus in interface WindowFocusListener