com.threerings.util

Class KeyDispatcher

java.lang.Object

com.threerings.util.KeyDispatcher

All Implemented Interfaces:

WindowFocusListener, KeyEventDispatcher, EventListener, AncestorListener

public class KeyDispatcher
extends Object
implements KeyEventDispatcher, AncestorListener, WindowFocusListener

Handles dispatching special global key pressed and released events to those that care to monitor and process such things.

A JTextComponent may registered as a "chat grabber" via pushChatGrabber(javax.swing.text.JTextComponent) so as to capture typed chat characters regardless of which component currently has the focus.

Components may also register as global KeyListeners via addGlobalKeyListener(java.awt.event.KeyListener) to always be notified of key press and release events for all keys.

Constructor Summary

Constructors

Constructor and Description
KeyDispatcher(Window window) Constructs a key dispatcher.

Method Summary

Modifier and Type	Method and Description
void	addGlobalKeyListener(KeyListener listener) Adds the key listener to receive all key events at all times.
void	ancestorAdded(AncestorEvent ae)
void	ancestorMoved(AncestorEvent ae)
void	ancestorRemoved(AncestorEvent ae)
boolean	dispatchKeyEvent(KeyEvent e)
void	pushChatGrabber(JTextComponent comp) Makes the specified component the new grabber of key typed events that look like they're chat-related per isChatCharacter(char).
void	removeChatGrabber(JTextComponent comp) Removes the specified component from the list of chat grabbers so that it will no longer be notified of chat-like key events.
void	removeGlobalKeyListener(KeyListener listener) Removes the specified global key listener.
void	shutdown() Shuts down the key dispatcher.
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

KeyDispatcher

public KeyDispatcher(Window window)

Constructs a key dispatcher.

Method Detail

shutdown

public void shutdown()

Shuts down the key dispatcher.

pushChatGrabber

public void pushChatGrabber(JTextComponent comp)

Makes the specified component the new grabber of key typed events that look like they're chat-related per isChatCharacter(char).

removeChatGrabber

public void removeChatGrabber(JTextComponent comp)

Removes the specified component from the list of chat grabbers so that it will no longer be notified of chat-like key events.

addGlobalKeyListener

public void addGlobalKeyListener(KeyListener listener)

Adds the key listener to receive all key events at all times.

removeGlobalKeyListener

public void removeGlobalKeyListener(KeyListener listener)

Removes the specified global key listener.

dispatchKeyEvent

public boolean dispatchKeyEvent(KeyEvent e)

Specified by:

dispatchKeyEvent in interface KeyEventDispatcher

windowGainedFocus

public void windowGainedFocus(WindowEvent e)

Specified by:

windowGainedFocus in interface WindowFocusListener

windowLostFocus

public void windowLostFocus(WindowEvent e)

Specified by:

windowLostFocus in interface WindowFocusListener

ancestorAdded

public void ancestorAdded(AncestorEvent ae)

Specified by:

ancestorAdded in interface AncestorListener

ancestorMoved

public void ancestorMoved(AncestorEvent ae)

Specified by:

ancestorMoved in interface AncestorListener

ancestorRemoved

public void ancestorRemoved(AncestorEvent ae)

Specified by:

ancestorRemoved in interface AncestorListener