| |
|
| java.lang.Object
 java.awt.FocusTraversalPolicy
All known Subclasses: java.awt.ContainerOrderFocusTraversalPolicy,
| FocusTraversalPolicy | | abstract public class FocusTraversalPolicy (Code) | | A FocusTraversalPolicy defines the order in which Components with a
particular focus cycle root are traversed. Instances can apply the policy to
arbitrary focus cycle roots, allowing themselves to be shared across
Containers. They do not need to be reinitialized when the focus cycle roots
of a Component hierarchy change.
The core responsibility of a FocusTraversalPolicy is to provide algorithms
determining the next and previous Components to focus when traversing
forward or backward in a UI. Each FocusTraversalPolicy must also provide
algorithms for determining the first, last, and default Components in a
traversal cycle. First and last Components are used when normal forward and
backward traversal, respectively, wraps. The default Component is the first
to receive focus when traversing down into a new focus traversal cycle.
A FocusTraversalPolicy can optionally provide an algorithm for determining
a Window's initial Component. The initial Component is the first to receive
focus when a Window is first made visible.
FocusTraversalPolicy takes into account focus traversal
policy providers. When searching for first/last/next/previous Component,
if a focus traversal policy provider is encountered, its focus traversal
policy is used to perform the search operation.
Please see
How to Use the Focus Subsystem,
a section in The Java Tutorial, and the
Focus Specification
for more information.
author:
David Mendenhall
version:
1.15, 05/05/07
See Also: Container.setFocusTraversalPolicy
See Also: Container.getFocusTraversalPolicy
See Also: Container.setFocusCycleRoot
See Also: Container.isFocusCycleRoot
See Also: Container.setFocusTraversalPolicyProvider
See Also: Container.isFocusTraversalPolicyProvider
See Also: KeyboardFocusManager.setDefaultFocusTraversalPolicy
See Also: KeyboardFocusManager.getDefaultFocusTraversalPolicy
since:
1.4 |
| getComponentAfter | | abstract public Component getComponentAfter(Container aContainer, Component aComponent)(Code) | | 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.
Parameters:
aContainer - a focus cycle root of aComponent or focus traversalpolicy provider
Parameters:
aComponent - a (possibly indirect) child of aContainer, oraContainer itself the Component that should receive the focus after aComponent, ornull if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is not a focus cycleroot of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null |
| getComponentBefore | | abstract public Component getComponentBefore(Container aContainer, Component aComponent)(Code) | | 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.
Parameters:
aContainer - a focus cycle root of aComponent or focus traversalpolicy provider
Parameters:
aComponent - a (possibly indirect) child of aContainer, oraContainer itself the Component that should receive the focus before aComponent,or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is not a focus cycleroot of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null |
| getDefaultComponent | | abstract public Component getDefaultComponent(Container aContainer)(Code) | | Returns the default Component to focus. This Component will be the first
to receive focus when traversing down into a new focus traversal cycle
rooted at aContainer.
Parameters:
aContainer - the focus cycle root or focus traversal policyprovider whose default Component is to be returned the default Component in the traversal cycle of aContainer, or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is null |
| getFirstComponent | | abstract public Component getFirstComponent(Container aContainer)(Code) | | 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.
Parameters:
aContainer - the focus cycle root or focus traversal policy providerwhose first Component is to be returned the first Component in the traversal cycle of aContainer,or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is null |
| getInitialComponent | | public Component getInitialComponent(Window window)(Code) | | Returns the Component that should receive the focus when a Window is
made visible for the first time. Once the Window has been made visible
by a call to show() or setVisible(true), the
initial Component will not be used again. Instead, if the Window loses
and subsequently regains focus, or is made invisible or undisplayable
and subsequently made visible and displayable, the Window's most
recently focused Component will become the focus owner. The default
implementation of this method returns the default Component.
Parameters:
window - the Window whose initial Component is to be returned the Component that should receive the focus when window is madevisible for the first time, or null if no suitable Component canbe found
See Also: FocusTraversalPolicy.getDefaultComponent
See Also: Window.getMostRecentFocusOwner
throws:
IllegalArgumentException - if window is null |
| getLastComponent | | abstract public Component getLastComponent(Container aContainer)(Code) | | 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.
Parameters:
aContainer - the focus cycle root or focus traversal policyprovider whose last Component is to be returned the last Component in the traversal cycle of aContainer,or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is null |
|
|
|