org.jdesktop.swingx
Class JXLoginPane.RemovableKeyEventDispatcher

java.lang.Object
  org.jdesktop.swingx.JXLoginPane.RemovableKeyEventDispatcher

All Implemented Interfaces:

KeyEventDispatcher

Enclosing class:

JXLoginPane

public class JXLoginPane.RemovableKeyEventDispatcher
extends Object
implements KeyEventDispatcher

Constructor Summary

JXLoginPane.RemovableKeyEventDispatcher(org.jdesktop.swingx.JXLoginPane.CapsOnTest capsOnTest)

Method Summary

boolean

dispatchKeyEvent(KeyEvent e) This method is called by the current KeyboardFocusManager requesting that this KeyEventDispatcher dispatch the specified event on its behalf.

Methods inherited from class java.lang.Object

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

Constructor Detail

JXLoginPane.RemovableKeyEventDispatcher

public JXLoginPane.RemovableKeyEventDispatcher(org.jdesktop.swingx.JXLoginPane.CapsOnTest capsOnTest)

Method Detail

dispatchKeyEvent

public boolean dispatchKeyEvent(KeyEvent e)

Description copied from interface: java.awt.KeyEventDispatcher

This method is called by the current KeyboardFocusManager requesting that this KeyEventDispatcher dispatch the specified event on its behalf. This KeyEventDispatcher is free to retarget the event, consume it, dispatch it itself, or make other changes. This capability is typically used to deliver KeyEvents to Components other than the focus owner. This can be useful when navigating children of non-focusable Windows in an accessible environment, for example. Note that if a KeyEventDispatcher dispatches the KeyEvent itself, it must use redispatchEvent to prevent the current KeyboardFocusManager from recursively requesting that this KeyEventDispatcher dispatch the event again.

If an implementation of this method returns false, then the KeyEvent is passed to the next KeyEventDispatcher in the chain, ending with the current KeyboardFocusManager. If an implementation returns true, the KeyEvent is assumed to have been dispatched (although this need not be the case), and the current KeyboardFocusManager will take no further action with regard to the KeyEvent. In such a case, KeyboardFocusManager.dispatchEvent should return true as well. If an implementation consumes the KeyEvent, but returns false, the consumed event will still be passed to the next KeyEventDispatcher in the chain. It is important for developers to check whether the KeyEvent has been consumed before dispatching it to a target. By default, the current KeyboardFocusManager will not dispatch a consumed KeyEvent.

Specified by:

dispatchKeyEvent in interface KeyEventDispatcher

Parameters:

e - the KeyEvent to dispatch

Returns:

true if the KeyboardFocusManager should take no further action with regard to the KeyEvent; false otherwise

See Also:

KeyboardFocusManager.redispatchEvent(java.awt.Component, java.awt.AWTEvent)