bibliothek.gui.dock.control
Interface KeyboardController

All Known Implementing Classes:

AbstractKeyboardController, DefaultKeyboardController, SecureKeyboardController

public interface KeyboardController

An observer of all KeyEvent, forwarding them to registered listeners. The listeners are only informed about events that occurred in a part of the dock-tree below them.

Author:

Benjamin Sigg

Method Summary

void	addGlobalListener(java.awt.event.KeyListener listener) Adds a global key listener to this controller.
void	addListener(KeyboardListener listener) Adds a listener to this controller.
DockController	getController() Gets the DockController in whose realm this KeyboardController works.
void	kill() Stops this controller.
void	removeGlobalListener(java.awt.event.KeyListener listener) Removes a listener from this controller.
void	removeListener(KeyboardListener listener) Removes a listener from this controller.

Method Detail

addGlobalListener

void addGlobalListener(java.awt.event.KeyListener listener)

Adds a global key listener to this controller. Global KeyListeners will receive a notification for every event that this controller handles. The listeners will also be informed about events that are consumed.

Parameters:

listener - the new listener

removeGlobalListener

void removeGlobalListener(java.awt.event.KeyListener listener)

Removes a listener from this controller.

Parameters:

listener - the listener to remove

addListener

void addListener(KeyboardListener listener)

Adds a listener to this controller. The listener will be invoked when a KeyEvent occurs in the subtree below the listeners DockElement.

Parameters:

listener - the new listener

removeListener

void removeListener(KeyboardListener listener)

Removes a listener from this controller.

Parameters:

listener - the listener to remove

getController

DockController getController()

Gets the DockController in whose realm this KeyboardController works.

Returns:

the owner of this controller

kill

@FrameworkOnly
void kill()

Stops this controller. This controller has to remove any resources it uses and has not to be useful any further.
This method should no be called by clients