se.entra.phantom.client

Class PFocusManager

java.lang.Object

java.awt.KeyboardFocusManager

java.awt.DefaultKeyboardFocusManager

javax.swing.FocusManager

javax.swing.DefaultFocusManager

se.entra.phantom.client.PFocusManager

All Implemented Interfaces:

WindowListener, KeyEventDispatcher, KeyEventPostProcessor, Runnable, EventListener

public class PFocusManager
extends DefaultFocusManager
implements WindowListener, Runnable

Overrides the default swing focus manager implementation.

Field Summary

Fields inherited from class javax.swing.FocusManager

FOCUS_MANAGER_CLASS_PROPERTY

Fields inherited from class java.awt.KeyboardFocusManager

BACKWARD_TRAVERSAL_KEYS, DOWN_CYCLE_TRAVERSAL_KEYS, FORWARD_TRAVERSAL_KEYS, UP_CYCLE_TRAVERSAL_KEYS

Constructor Summary

Constructors

Constructor and Description
PFocusManager(Phantom p) Called when creating the Phantom instance.

Method Summary

Modifier and Type	Method and Description
static void	clearSelectedMenuPath() Clears a selected menu path.
boolean	compareTabOrder(Component a, Component b) Overridden to remove exception.
static boolean	focusControl(PControl pc) Checks if the focus can be set to a component, and if so does it.
static boolean	focusControl(PControl pc, KeyEvent event) Checks if the focus can be set to a component, and if so does it.
static boolean	focusControl(PControl pc, KeyEvent event, boolean checkForTabSkipped, boolean doit) Checks if the focus can be set to a component, and if so does it.
static boolean	focusControl(PControl pc, KeyEvent event, PControl pcPrevious, boolean checkForTabSkipped, boolean doit) Checks if the focus can be set to a component, and if so does it.
void	focusNextComponent(Component c) Cause the focus manager to set the focus on the next focusable component You can call this method to cause the focus manager to focus the next component.
static boolean	focusNextComponent2(Component c) Cause the focus manager to set the focus on the next focusable component.
void	focusPreviousComponent(Component c) Cause the focus manager to set the focus on the previous focusable component You can call this method to cause the focus manager to focus the previous component.
Component	getComponentAfter(Container cnr, Component comp) Returns the Component that should receive the focus after aComponent.
Component	getComponentBefore(Container cnr, Component comp) Returns the Component that should receive the focus before aComponent.
Component	getFirstComponent(Container cnr) Returns the first Component in the traversal cycle.
Component	getLastComponent(Container cnr) Returns the last Component in the traversal cycle.
static PControl	getPControl(Component c) Gets the PControl instance of a component in a Phantom panel.
void	processKeyEvent(Component c, KeyEvent e) This method is called by JComponents when a key event occurs.
static void	processKeyEvent2(Component c, KeyEvent e) This method is called by JComponents when a key event occurs.
void	run() Focus a component later.
static void	setFocus(JComponent jc) Sets focus to the component and bringing the frame/dialog window to the front.
void	super_focusNextComponent(Component c) Calls the method "super.focusNextComponent(c)", i.e.
void	super_focusPreviousComponent(Component c) Calls the method "super.focusPreviousComponent(c)", i.e.
void	super_processKeyEvent(Component c, KeyEvent e) Calls the method "super.processKeyEvent(c,e)", i.e.
void	windowActivated(WindowEvent e)
void	windowClosed(WindowEvent e)
void	windowClosing(WindowEvent e)
void	windowDeactivated(WindowEvent e) Checks for deactivation for single Alt-keystrokes to activate the menu bar.
void	windowDeiconified(WindowEvent e)
void	windowIconified(WindowEvent e)
void	windowOpened(WindowEvent e)

Methods inherited from class javax.swing.FocusManager

disableSwingFocusManager, getCurrentManager, isFocusManagerEnabled, setCurrentManager

Methods inherited from class java.awt.DefaultKeyboardFocusManager

dequeueKeyEvents, discardKeyEvents, dispatchEvent, dispatchKeyEvent, downFocusCycle, enqueueKeyEvents, postProcessKeyEvent, upFocusCycle

Methods inherited from class java.awt.KeyboardFocusManager

addKeyEventDispatcher, addKeyEventPostProcessor, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, clearFocusOwner, clearGlobalFocusOwner, downFocusCycle, firePropertyChange, fireVetoableChange, focusNextComponent, focusPreviousComponent, getActiveWindow, getCurrentFocusCycleRoot, getCurrentKeyboardFocusManager, getDefaultFocusTraversalKeys, getDefaultFocusTraversalPolicy, getFocusedWindow, getFocusOwner, getGlobalActiveWindow, getGlobalCurrentFocusCycleRoot, getGlobalFocusedWindow, getGlobalFocusOwner, getGlobalPermanentFocusOwner, getKeyEventDispatchers, getKeyEventPostProcessors, getPermanentFocusOwner, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, redispatchEvent, removeKeyEventDispatcher, removeKeyEventPostProcessor, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setCurrentKeyboardFocusManager, setDefaultFocusTraversalKeys, setDefaultFocusTraversalPolicy, setGlobalActiveWindow, setGlobalCurrentFocusCycleRoot, setGlobalFocusedWindow, setGlobalFocusOwner, setGlobalPermanentFocusOwner, upFocusCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

PFocusManager

public PFocusManager(Phantom p)

Called when creating the Phantom instance.

Method Detail

run

public void run()

Focus a component later.

Specified by:

run in interface Runnable

windowDeactivated

public void windowDeactivated(WindowEvent e)

Checks for deactivation for single Alt-keystrokes to activate the menu bar.

Specified by:

windowDeactivated in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Specified by:

windowIconified in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Specified by:

windowClosed in interface WindowListener

windowOpened

public void windowOpened(WindowEvent e)

Specified by:

windowOpened in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Specified by:

windowActivated in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Specified by:

windowDeiconified in interface WindowListener

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

processKeyEvent2

public static void processKeyEvent2(Component c,
                                    KeyEvent e)

This method is called by JComponents when a key event occurs. JComponent gives key events to the focus manager first, then to key listeners, then to the keyboard UI dispatcher.

This method should look at the key event and change the focused component if the key event matches the receiver's focus manager hot keys. For example the default focus manager will change the focus if the key event matches TAB or Shift + TAB.

The focus manager should call consume() on e if e has been processed. c is the component that currently has the focus.

Note: FocusManager will receive KEY_PRESSED, KEY_RELEASED and KEY_TYPED key events. If one event is consumed, all other events type should be consumed.

All events for Phantom panels are consumed when the session is locked. Every key event is sent off to PPanel.processKeyPressed (when the key is pressed) and PPanel sends it off to the control in question.

This is a static method!

super_processKeyEvent

public void super_processKeyEvent(Component c,
                                  KeyEvent e)

Calls the method "super.processKeyEvent(c,e)", i.e. the method in DefaultFocusManager.

processKeyEvent

public void processKeyEvent(Component c,
                            KeyEvent e)

This method is called by JComponents when a key event occurs. JComponent gives key events to the focus manager first, then to key listeners, then to the keyboard UI dispatcher.

This method should look at the key event and change the focused component if the key event matches the receiver's focus manager hot keys. For example the default focus manager will change the focus if the key event matches TAB or Shift + TAB.

The focus manager should call consume() on e if e has been processed. c is the component that currently has the focus.

Note: FocusManager will receive KEY_PRESSED, KEY_RELEASED and KEY_TYPED key events. If one event is consumed, all other events type should be consumed.

All events for Phantom panels are consumed when the session is locked. Every key event is sent off to PPanel.processKeyPressed (when the key is pressed) and PPanel sends it off to the control in question.

Overrides:

processKeyEvent in class DefaultKeyboardFocusManager

clearSelectedMenuPath

public static void clearSelectedMenuPath()

Clears a selected menu path.

getPControl

public static PControl getPControl(Component c)

Gets the PControl instance of a component in a Phantom panel.

Returns:

null if the control is not a Phantom control.

focusNextComponent2

public static boolean focusNextComponent2(Component c)

Cause the focus manager to set the focus on the next focusable component. You can call this method to cause the focus manager to focus the next component. This is done typically for auto-tab functionality of if a static control such as static text or group box has its mnemonic key pressed, thus causing an auto-tab-like functionality.

This is a static method!

Returns:

true if a FocusManager is present, false otherwise.

super_focusNextComponent

public void super_focusNextComponent(Component c)

Calls the method "super.focusNextComponent(c)", i.e. the method in DefaultFocusManager.

focusNextComponent

public void focusNextComponent(Component c)

Cause the focus manager to set the focus on the next focusable component You can call this method to cause the focus manager to focus the next component.

Overrides:

focusNextComponent in class DefaultKeyboardFocusManager

super_focusPreviousComponent

public void super_focusPreviousComponent(Component c)

Calls the method "super.focusPreviousComponent(c)", i.e. the method in DefaultFocusManager.

focusPreviousComponent

public void focusPreviousComponent(Component c)

Cause the focus manager to set the focus on the previous focusable component You can call this method to cause the focus manager to focus the previous component.

Overrides:

focusPreviousComponent in class DefaultKeyboardFocusManager

focusControl

public static boolean focusControl(PControl pc)

Checks if the focus can be set to a component, and if so does it. This will also cause the control to be scrolled into viewable area if located inside a scroll pane with the appropriate scroll bars.

The Phantom setting "Skip tab stop" is not checked.

Returns:

true if the focus was set, false is failure.

focusControl

public static boolean focusControl(PControl pc,
                                   KeyEvent event)

Checks if the focus can be set to a component, and if so does it. This will also cause the control to be scrolled into viewable area if located inside a scroll pane with the appropriate scroll bars.

The Phantom setting "Skip tab stop" is not checked.

Returns:

true if the focus was set, false is failure.

focusControl

public static boolean focusControl(PControl pc,
                                   KeyEvent event,
                                   boolean checkForTabSkipped,
                                   boolean doit)

Checks if the focus can be set to a component, and if so does it. This will also cause the control to be scrolled into viewable area if located inside a scroll pane with the appropriate scroll bars.

The flag checkForTabSkipped can be used to check for the Phantom setting "Skip tab stop".

Returns:

true if the focus was set, false is failure.

focusControl

public static boolean focusControl(PControl pc,
                                   KeyEvent event,
                                   PControl pcPrevious,
                                   boolean checkForTabSkipped,
                                   boolean doit)

Checks if the focus can be set to a component, and if so does it. This will also cause the control to be scrolled into viewable area if located inside a scroll pane with the appropriate scroll bars.

The flag checkForTabSkipped can be used to check for the Phantom setting "Skip tab stop".

Before the actual focus change, the pcPrevious component (if not null) will be checked for implementing the FieldCheck interface. If it is, the method isDeFocusAllowed(pc) will be called. If this method returns false the focus change operation will be canceled. Note that this will only be done when doit=true. The return code of focusControl will be true even if the operation was canceled.

Returns:

true if the focus was set, false is failure.

setFocus

public static void setFocus(JComponent jc)

Sets focus to the component and bringing the frame/dialog window to the front.

Parameters:

jc - Component to focus.

compareTabOrder

public boolean compareTabOrder(Component a,
                               Component b)

Overridden to remove exception.

Overrides:

compareTabOrder in class DefaultFocusManager

getFirstComponent

public Component getFirstComponent(Container cnr)

Returns the first Component in the traversal cycle. This method is used to determine the next Component to focus when traversal wraps in the forward direction.

Overrides:

getFirstComponent in class DefaultFocusManager

Parameters:

cnr - The focus cycle root or focus traversal policy provider whose first Component is to be returned.

Returns:

The first Component in the traversal cycle of cnr, or null if no suitable Component can be found.

getLastComponent

public Component getLastComponent(Container cnr)

Returns the last Component in the traversal cycle. This method is used to determine the next Component to focus when traversal wraps in the reverse direction.

Overrides:

getLastComponent in class DefaultFocusManager

Parameters:

cnr - The focus cycle root or focus traversal policy provider whose last Component is to be returned

Returns:

The last Component in the traversal cycle of cnr, or null if no suitable Component can be found.

getComponentAfter

public Component getComponentAfter(Container cnr,
                                   Component comp)

Returns the Component that should receive the focus after aComponent. aContainer must be a focus cycle root of aComponent or a focus traversal policy provider.

Overrides:

getComponentAfter in class DefaultFocusManager

Parameters:

cnr - A focus cycle root of aComponent or focus traversal policy provider.

comp - A (possibly indirect) child of cnr, or cnr itself.

Returns:

The Component that should receive the focus after comp, or null if no suitable Component can be found.

getComponentBefore

public Component getComponentBefore(Container cnr,
                                    Component comp)

Returns the Component that should receive the focus before aComponent. aContainer must be a focus cycle root of aComponent or a focus traversal policy provider.

Overrides:

getComponentBefore in class DefaultFocusManager

Parameters:

cnr - A focus cycle root of aComponent or focus traversal policy provider.

comp - A (possibly indirect) child of cnr, or cnr itself.

Returns:

The Component that should receive the focus before comp, or null if no suitable Component can be found.