java.lang.Object | ||
↳ | java.awt.FocusTraversalPolicy | |
↳ | java.awt.ContainerOrderFocusTraversalPolicy |
Known Direct Subclasses |
A FocusTraversalPolicy that determines traversal order based on the order
of child Components in a Container. From a particular focus cycle root, the
policy makes a pre-order traversal of the Component hierarchy, and traverses
a Container's children according to the ordering of the array returned by
Container.getComponents()
. Portions of the hierarchy that are
not visible and displayable will not be searched.
By default, ContainerOrderFocusTraversalPolicy implicitly transfers focus
down-cycle. That is, during normal forward focus traversal, the Component
traversed after a focus cycle root will be the focus-cycle-root's default
Component to focus. This behavior can be disabled using the
setImplicitDownCycleTraversal
method.
By default, methods of this class with return a Component only if it is
visible, displayable, enabled, and focusable. Subclasses can modify this
behavior by overriding the accept
method.
This policy 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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the Component that should receive the focus after aComponent.
| |||||||||||
Returns the Component that should receive the focus before aComponent.
| |||||||||||
Returns the default Component to focus.
| |||||||||||
Returns the first Component in the traversal cycle.
| |||||||||||
Returns whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly.
| |||||||||||
Returns the last Component in the traversal cycle.
| |||||||||||
Sets whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Determines whether a Component is an acceptable choice as the new
focus owner.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.FocusTraversalPolicy
| |||||||||||
From class
java.lang.Object
|
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.
By default, ContainerOrderFocusTraversalPolicy implicitly transfers
focus down-cycle. That is, during normal forward focus traversal, the
Component traversed after a focus cycle root will be the focus-cycle-
root's default Component to focus. This behavior can be disabled using
the setImplicitDownCycleTraversal
method.
If aContainer is focus traversal policy provider, the focus is always transferred down-cycle.
aContainer | a focus cycle root of aComponent or a focus traversal policy provider |
---|---|
aComponent | a (possibly indirect) child of aContainer, or aContainer itself |
IllegalArgumentException | if aContainer is not a focus cycle root of aComponent or focus traversal policy provider, or if either aContainer or aComponent is null |
---|
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.
aContainer | a focus cycle root of aComponent or focus traversal policy provider |
---|---|
aComponent | a (possibly indirect) child of aContainer, or aContainer itself |
IllegalArgumentException | if aContainer is not a focus cycle root of aComponent or focus traversal policy provider, or if either aContainer or aComponent is null |
---|
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. The default implementation of this method
returns the same Component as getFirstComponent
.
aContainer | the focus cycle root or focus traversal policy provider whose default Component is to be returned |
---|
IllegalArgumentException | if aContainer is null |
---|
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.
aContainer | the focus cycle root or focus traversal policy provider whose first Component is to be returned |
---|
IllegalArgumentException | if aContainer is null |
---|
Returns whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly. If true
, during normal forward focus
traversal, the Component traversed after a focus cycle root will be the
focus-cycle-root's default Component to focus. If false
,
the next Component in the focus traversal cycle rooted at the specified
focus cycle root will be traversed instead.
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.
aContainer | the focus cycle root or focus traversal policy provider whose last Component is to be returned |
---|
IllegalArgumentException | if aContainer is null |
---|
Sets whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly. If true
, during normal forward focus
traversal, the Component traversed after a focus cycle root will be the
focus-cycle-root's default Component to focus. If false
,
the next Component in the focus traversal cycle rooted at the specified
focus cycle root will be traversed instead. The default value for this
property is true
.
implicitDownCycleTraversal | whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly |
---|
Determines whether a Component is an acceptable choice as the new focus owner. By default, this method will accept a Component if and only if it is visible, displayable, enabled, and focusable.
aComponent | the Component whose fitness as a focus owner is to be tested |
---|
true
if aComponent is visible, displayable,
enabled, and focusable; false
otherwise