bibliothek.gui.dock.control.focus
Interface MouseFocusObserver

All Known Implementing Classes:

AbstractMouseFocusObserver, DefaultMouseFocusObserver, SecureMouseFocusObserver

@Todo(compatibility=COMPATIBLE,
      priority=BUG,
      target=VERSION_1_1_1,
      description="Dockables moving on ScreenDockStation: should keep focus")
public interface MouseFocusObserver

A MouseFocusObserver tracks the movement and actions of the mouse and is responsible for transferring the focus by calling DockController.setFocusedDockable(Dockable, java.awt.Component, boolean, boolean, boolean) at an appropriate time.

Author:

Benjamin Sigg

Method Summary

void	check(java.awt.event.MouseEvent event) This method may be called at any time by any component that received the MouseEvent event.
void	check(java.awt.event.MouseWheelEvent event) This method may be called at any time by any component that received the MouseWheelEvent event.
DockController	getController() Gets the DockController whose Dockables are tracked by this observer.
void	kill() Stops this FocusController.

Method Detail

getController

DockController getController()

Gets the DockController whose Dockables are tracked by this observer.

Returns:

the controller

check

void check(java.awt.event.MouseEvent event)

This method may be called at any time by any component that received the MouseEvent event. This observer may transfer the focus because of this call.
If this application runs in a restricted environment than any DockStation of this framework will call this method.

Parameters:

event - the event to check

check

void check(java.awt.event.MouseWheelEvent event)

This method may be called at any time by any component that received the MouseWheelEvent event. This observer may transfer the focus because of this call.
If this application runs in a restricted environment than any DockStation of this framework will call this method.

Parameters:

event - the event to check

kill

@FrameworkOnly
void kill()

Stops this FocusController. This controller will remove all its listeners and become ready for the garbage collector.
This method should not be called by clients.