java.lang.Objectjava.awt.FocusTraversalPolicy
javax.swing.InternalFrameFocusTraversalPolicy
javax.swing.SortingFocusTraversalPolicy
public class SortingFocusTraversalPolicy
A FocusTraversalPolicy that determines traversal order by sorting the Components of a focus traversal cycle based on a given Comparator. Portions of the Component hierarchy that are not visible and displayable will not be included.
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
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.
Constructor Summary | |
---|---|
protected |
SortingFocusTraversalPolicy
() Constructs a SortingFocusTraversalPolicy without a Comparator. |
SortingFocusTraversalPolicy
(
Comparator
<? super
Component
> comparator) Constructs a SortingFocusTraversalPolicy with the specified Comparator. |
Method Summary | |
---|---|
protected boolean |
accept
(
Component
aComponent) Determines whether a Component is an acceptable choice as the new focus owner. |
protected Comparator <? super Component > |
getComparator
() Returns the Comparator which will be used to sort the Components in a focus traversal cycle. |
Component |
getComponentAfter
(
Container
aContainer,
Component
aComponent) Returns the Component that should receive the focus after aComponent. |
Component |
getComponentBefore
(
Container
aContainer,
Component
aComponent) Returns the Component that should receive the focus before aComponent. |
Component |
getDefaultComponent
(
Container
aContainer) Returns the default Component to focus. |
Component |
getFirstComponent
(
Container
aContainer) Returns the first Component in the traversal cycle. |
boolean |
getImplicitDownCycleTraversal
() Returns whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly. |
Component |
getLastComponent
(
Container
aContainer) Returns the last Component in the traversal cycle. |
protected void |
setComparator
(
Comparator
<? super
Component
> comparator) Sets the Comparator which will be used to sort the Components in a focus traversal cycle. |
void |
setImplicitDownCycleTraversal
(boolean implicitDownCycleTraversal) Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly. |
Methods inherited from class javax.swing. InternalFrameFocusTraversalPolicy |
---|
getInitialComponent |
Methods inherited from class java.awt. FocusTraversalPolicy |
---|
getInitialComponent |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Constructor Detail |
---|
protected SortingFocusTraversalPolicy()
public SortingFocusTraversalPolicy(Comparator<? super Component> comparator)
Method Detail |
---|
public 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
focus traversal policy provider
, the focus is always transferred down-cycle.
public 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
focus traversal policy provider
, the focus is always transferred down-cycle.
public Component getFirstComponent(Container aContainer)
public Component getLastComponent(Container aContainer)
public Component getDefaultComponent(Container aContainer)
public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)
public boolean getImplicitDownCycleTraversal()
protected void setComparator(Comparator<? super Component> comparator)
protected Comparator<? super Component> getComparator()
protected boolean accept(Component aComponent)