LayoutFocusTraversalPolicy
public class SortingFocusTraversalPolicy extends InternalFrameFocusTraversalPolicy
By default, SortingFocusTraversalPolicy implicitly transfers focus down- cycle. That is, during normal 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.
Modifier | Constructor | Description |
---|---|---|
protected |
Constructs a SortingFocusTraversalPolicy without a Comparator. |
|
Constructs a SortingFocusTraversalPolicy with the specified Comparator. |
Modifier and Type | Method | Description |
---|---|---|
protected boolean |
accept |
Determines whether a Component is an acceptable choice as the new focus owner. |
protected Comparator |
getComparator() |
Returns the Comparator which will be used to sort the Components in a focus traversal cycle. |
Component |
getComponentAfter |
Returns the Component that should receive the focus after aComponent. |
Component |
getComponentBefore |
Returns the Component that should receive the focus before aComponent. |
Component |
getDefaultComponent |
Returns the default Component to focus. |
Component |
getFirstComponent |
Returns the first Component in the traversal cycle. |
boolean |
getImplicitDownCycleTraversal() |
Returns whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly. |
Component |
getLastComponent |
Returns the last Component in the traversal cycle. |
protected void |
setComparator |
Sets the Comparator which will be used to sort the Components in a focus traversal cycle. |
void |
setImplicitDownCycleTraversal |
Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly. |
getInitialComponent
getInitialComponent
protected SortingFocusTraversalPolicy()
setComparator
before installing this FocusTraversalPolicy on a focus cycle root or KeyboardFocusManager.public SortingFocusTraversalPolicy(Comparator<? super Component> comparator)
comparator
- the Comparator
to sort bypublic Component getComponentAfter(Container aContainer, Component aComponent)
By default, SortingFocusTraversalPolicy implicitly transfers focus down- cycle. That is, during normal 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.
getComponentAfter
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provideraComponent
- a (possibly indirect) child of aContainer, or aContainer itselfIllegalArgumentException
- if aContainer is not a focus cycle root of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is nullpublic Component getComponentBefore(Container aContainer, Component aComponent)
By default, SortingFocusTraversalPolicy implicitly transfers focus down- cycle. That is, during normal 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.
getComponentBefore
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provideraComponent
- a (possibly indirect) child of aContainer, or aContainer itselfIllegalArgumentException
- if aContainer is not a focus cycle root of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is nullpublic Component getFirstComponent(Container aContainer)
getFirstComponent
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provider whose first Component is to be returnedIllegalArgumentException
- if aContainer is nullpublic Component getLastComponent(Container aContainer)
getLastComponent
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provider whose last Component is to be returnedIllegalArgumentException
- if aContainer is nullpublic Component getDefaultComponent(Container aContainer)
getFirstComponent
.getDefaultComponent
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provider whose default Component is to be returnedIllegalArgumentException
- if aContainer is nullpublic void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)
true
, during normal 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 SortingFocusTraversalPolicy transfers focus down-cycle implicitlypublic boolean getImplicitDownCycleTraversal()
true
, during normal 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.protected void setComparator(Comparator<? super Component> comparator)
comparator
- the Comparator which will be used for sortingprotected Comparator<? super Component> getComparator()
protected boolean accept(Component aComponent)
aComponent
- the Component whose fitness as a focus owner is to be testedtrue
if aComponent is visible, displayable, enabled, and focusable; false
otherwise
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/SortingFocusTraversalPolicy.html