OpenJDK 27 · javax.swing.SortingFocusTraversalPolicy

Modifier and Type	Field and Description
private static final int	BACKWARD_TRAVERSAL
private transient List<Component>	cachedCycle
private transient Container	cachedRoot Used by getComponentAfter and getComponentBefore for efficiency.
private Comparator<? super Component>	comparator
private static final SwingContainerOrderFocusTraversalPolicy	fitnessTestPolicy
private static final int	FORWARD_TRAVERSAL
private boolean	implicitDownCycleTraversal
private static final boolean	legacySortingFTPEnabled
private PlatformLogger	log

Access	Constructor and Description
protected	SortingFocusTraversalPolicy() Constructs a SortingFocusTraversalPolicy without a Comparator.
public	SortingFocusTraversalPolicy(Comparator<? super Component> the `Comparator` to sort by comparator) Constructs a SortingFocusTraversalPolicy with the specified Comparator.

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if aComponent is visible, displayable, enabled, and focusable; `false` otherwise accept(Component the Component whose fitness as a focus owner is to be tested aComponent) Determines whether a Component is an acceptable choice as the new focus owner.
private void	enumerateAndSortCycle(Container focusCycleRoot, List<Component> cycle)
private void	enumerateCycle(Container container, List<Component> cycle)
protected Comparator<? super Component>	Returns: the Comparator which will be used for sorting getComparator() Returns the Comparator which will be used to sort the Components in a focus traversal cycle.
public Component	Returns: the Component that should receive the focus after aComponent, or null if no suitable Component can be found getComponentAfter(Container a focus cycle root of aComponent or a focus traversal policy provider aContainer, Component a (possibly indirect) child of aContainer, or aContainer itself aComponent) Implements abstract java.awt.FocusTraversalPolicy.getComponentAfter. Returns the Component that should receive the focus after aComponent.
public Component	Returns: the Component that should receive the focus before aComponent, or null if no suitable Component can be found getComponentBefore(Container a focus cycle root of aComponent or a focus traversal policy provider aContainer, Component a (possibly indirect) child of aContainer, or aContainer itself aComponent) Implements abstract java.awt.FocusTraversalPolicy.getComponentBefore. Returns the Component that should receive the focus before aComponent.
private Component	getComponentDownCycle(Component comp, int traversalDirection)
private int	getComponentIndex(List<Component> cycle, Component aComponent)
public Component	Returns: the default Component in the traversal cycle of aContainer, or null if no suitable Component can be found getDefaultComponent(Container a focus cycle root of aComponent or a focus traversal policy provider whose default Component is to be returned aContainer) Implements abstract java.awt.FocusTraversalPolicy.getDefaultComponent. Returns the default Component to focus.
public Component	Returns: the first Component in the traversal cycle of aContainer, or null if no suitable Component can be found getFirstComponent(Container a focus cycle root of aComponent or a focus traversal policy provider whose first Component is to be returned aContainer) Implements abstract java.awt.FocusTraversalPolicy.getFirstComponent. Returns the first Component in the traversal cycle.
private List<Component>	getFocusTraversalCycle(Container aContainer)
public boolean	Returns: whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly getImplicitDownCycleTraversal() Returns whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly.
public Component	Returns: the last Component in the traversal cycle of aContainer, or null if no suitable Component can be found getLastComponent(Container a focus cycle root of aComponent or a focus traversal policy provider whose last Component is to be returned aContainer) Implements abstract java.awt.FocusTraversalPolicy.getLastComponent. Returns the last Component in the traversal cycle.
pack-priv Container	getTopmostProvider(Container focusCycleRoot, Component aComponent)
private void	legacySort(List<Component> l, Comparator<? super Component> c)
private <T> void	mergeSort(T[] src, T[] dest, int low, int high, int off, Comparator<? super T> c)
protected void	setComparator(Comparator<? super Component> the Comparator which will be used for sorting comparator) Sets the Comparator which will be used to sort the Components in a focus traversal cycle.
public void	setImplicitDownCycleTraversal(boolean whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly implicitDownCycleTraversal) Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly.

Inherited from javax.swing.InternalFrameFocusTraversalPolicy:: getInitialComponent

BACKWARD_TRAVERSAL	back to summary
private static final int BACKWARD_TRAVERSAL

cachedCycle	back to summary
private transient List<Component> cachedCycle

cachedRoot	back to summary
private transient Container cachedRoot Used by getComponentAfter and getComponentBefore for efficiency. In order to maintain compliance with the specification of FocusTraversalPolicy, if traversal wraps, we should invoke getFirstComponent or getLastComponent. These methods may be overridden in subclasses to behave in a non-generic way. However, in the generic case, these methods will simply return the first or last Components of the sorted list, respectively. Since getComponentAfter and getComponentBefore have already built the sorted list before determining that they need to invoke getFirstComponent or getLastComponent, the sorted list should be reused if possible.

comparator	back to summary
private Comparator<? super Component> comparator

fitnessTestPolicy	back to summary
private static final SwingContainerOrderFocusTraversalPolicy fitnessTestPolicy

FORWARD_TRAVERSAL	back to summary
private static final int FORWARD_TRAVERSAL

implicitDownCycleTraversal	back to summary
private boolean implicitDownCycleTraversal

legacySortingFTPEnabled	back to summary
private static final boolean legacySortingFTPEnabled

log	back to summary
private PlatformLogger log

SortingFocusTraversalPolicy	back to summary
protected SortingFocusTraversalPolicy() Constructs a SortingFocusTraversalPolicy without a Comparator. Subclasses must set the Comparator using `setComparator` before installing this FocusTraversalPolicy on a focus cycle root or KeyboardFocusManager.

SortingFocusTraversalPolicy	back to summary
public SortingFocusTraversalPolicy(Comparator<? super Component> comparator) Constructs a SortingFocusTraversalPolicy with the specified Comparator. Parameters comparator:Comparator<? super Component> the `Comparator` to sort by

Method Detail

accept back to summary

accept	back to summary
protected boolean accept(Component aComponent) 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. Parameters aComponent:Component the Component whose fitness as a focus owner is to be tested Returns:boolean `true` if aComponent is visible, displayable, enabled, and focusable; `false` otherwise

protected boolean accept(Component aComponent)

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.

Parameters

aComponent:Component: the Component whose fitness as a focus owner is to be tested

Returns:boolean

true if aComponent is visible, displayable, enabled, and focusable; false otherwise

enumerateAndSortCycle	back to summary
private void enumerateAndSortCycle(Container focusCycleRoot, List<Component> cycle)

enumerateCycle	back to summary
private void enumerateCycle(Container container, List<Component> cycle) Annotations @SuppressWarnings:deprecation

getComparator	back to summary
protected Comparator<? super Component> getComparator() Returns the Comparator which will be used to sort the Components in a focus traversal cycle. Returns:Comparator<? super Component> the Comparator which will be used for sorting

getComparator

back to summary

protected Comparator<? super Component> getComparator()

Returns the Comparator which will be used to sort the Components in a focus traversal cycle.

Returns:Comparator<? super Component>: the Comparator which will be used for sorting

getComponentAfter back to summary

getComponentAfter	back to summary
public Component getComponentAfter(Container aContainer, Component aComponent) Implements abstract java.awt.FocusTraversalPolicy.getComponentAfter. 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, 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. Parameters aContainer:Container a focus cycle root of aComponent or a focus traversal policy provider aComponent:Component a (possibly indirect) child of aContainer, or aContainer itself Returns:Component the Component that should receive the focus after aComponent, or null if no suitable Component can be found Exceptions IllegalArgumentException: if aContainer is not a focus cycle root of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null

public Component getComponentAfter(Container aContainer, Component aComponent)

Implements abstract java.awt.FocusTraversalPolicy.getComponentAfter.

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, 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.

Parameters

aContainer:Container: a focus cycle root of aComponent or a focus traversal policy provider
aComponent:Component: a (possibly indirect) child of aContainer, or aContainer itself

Returns:Component

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

Exceptions

IllegalArgumentException:: if aContainer is not a focus cycle root of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null

getComponentBefore back to summary

getComponentBefore	back to summary
public Component getComponentBefore(Container aContainer, Component aComponent) Implements abstract java.awt.FocusTraversalPolicy.getComponentBefore. 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. 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. Parameters aContainer:Container a focus cycle root of aComponent or a focus traversal policy provider aComponent:Component a (possibly indirect) child of aContainer, or aContainer itself Returns:Component the Component that should receive the focus before aComponent, or null if no suitable Component can be found Exceptions IllegalArgumentException: if aContainer is not a focus cycle root of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null

public Component getComponentBefore(Container aContainer, Component aComponent)

Implements abstract java.awt.FocusTraversalPolicy.getComponentBefore.

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.

If aContainer is focus traversal policy provider, the focus is always transferred down-cycle.

Parameters

aContainer:Container: a focus cycle root of aComponent or a focus traversal policy provider
aComponent:Component: a (possibly indirect) child of aContainer, or aContainer itself

Returns:Component

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

Exceptions

IllegalArgumentException:: if aContainer is not a focus cycle root of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null

getComponentDownCycle	back to summary
private Component getComponentDownCycle(Component comp, int traversalDirection)

getComponentIndex	back to summary
private int getComponentIndex(List<Component> cycle, Component aComponent)

getDefaultComponent back to summary

getDefaultComponent	back to summary
public Component getDefaultComponent(Container aContainer) Implements abstract java.awt.FocusTraversalPolicy.getDefaultComponent. 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`. Parameters aContainer:Container a focus cycle root of aComponent or a focus traversal policy provider whose default Component is to be returned Returns:Component the default Component in the traversal cycle of aContainer, or null if no suitable Component can be found Exceptions IllegalArgumentException: if aContainer is null See Also `getFirstComponent`

public Component getDefaultComponent(Container aContainer)

Implements abstract java.awt.FocusTraversalPolicy.getDefaultComponent.

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.

Parameters

aContainer:Container: a focus cycle root of aComponent or a focus traversal policy provider whose default Component is to be returned

Returns:Component

the default Component in the traversal cycle of aContainer, or null if no suitable Component can be found

Exceptions

IllegalArgumentException:: if aContainer is null

See Also

getFirstComponent

getFirstComponent	back to summary
public Component getFirstComponent(Container aContainer) Implements abstract java.awt.FocusTraversalPolicy.getFirstComponent. 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:Container a focus cycle root of aComponent or a focus traversal policy provider whose first Component is to be returned Returns:Component the first Component in the traversal cycle of aContainer, or null if no suitable Component can be found Exceptions IllegalArgumentException: if aContainer is null

getFirstComponent

back to summary

public Component getFirstComponent(Container aContainer)

Implements abstract java.awt.FocusTraversalPolicy.getFirstComponent.

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:Container: a focus cycle root of aComponent or a focus traversal policy provider whose first Component is to be returned

Returns:Component

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

Exceptions

IllegalArgumentException:: if aContainer is null

getFocusTraversalCycle	back to summary
private List<Component> getFocusTraversalCycle(Container aContainer)

getImplicitDownCycleTraversal back to summary

getImplicitDownCycleTraversal	back to summary
public boolean getImplicitDownCycleTraversal() Returns whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly. If `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. Returns:boolean whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly See Also `setImplicitDownCycleTraversal`, `getFirstComponent`

public boolean getImplicitDownCycleTraversal()

Returns whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly. If 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.

Returns:boolean: whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly
See Also: setImplicitDownCycleTraversal, getFirstComponent

getLastComponent	back to summary
public Component getLastComponent(Container aContainer) Implements abstract java.awt.FocusTraversalPolicy.getLastComponent. 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:Container a focus cycle root of aComponent or a focus traversal policy provider whose last Component is to be returned Returns:Component the last Component in the traversal cycle of aContainer, or null if no suitable Component can be found Exceptions IllegalArgumentException: if aContainer is null

getLastComponent

back to summary

public Component getLastComponent(Container aContainer)

Implements abstract java.awt.FocusTraversalPolicy.getLastComponent.

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:Container: a focus cycle root of aComponent or a focus traversal policy provider whose last Component is to be returned

Returns:Component

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

Exceptions

IllegalArgumentException:: if aContainer is null

getTopmostProvider	back to summary
pack-priv Container getTopmostProvider(Container focusCycleRoot, Component aComponent)

legacySort	back to summary
private void legacySort(List<Component> l, Comparator<? super Component> c)

mergeSort	back to summary
private <T> void mergeSort(T[] src, T[] dest, int low, int high, int off, Comparator<? super T> c)

setComparator	back to summary
protected void setComparator(Comparator<? super Component> comparator) Sets the Comparator which will be used to sort the Components in a focus traversal cycle. Parameters comparator:Comparator<? super Component> the Comparator which will be used for sorting

setComparator

back to summary

protected void setComparator(Comparator<? super Component> comparator)

Sets the Comparator which will be used to sort the Components in a focus traversal cycle.

Parameters

comparator:Comparator<? super Component>: the Comparator which will be used for sorting

setImplicitDownCycleTraversal back to summary

setImplicitDownCycleTraversal	back to summary
public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal) Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly. If `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`. Parameters implicitDownCycleTraversal:boolean whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly See Also `getImplicitDownCycleTraversal`, `getFirstComponent`

public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)

Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly. If 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.

Parameters

implicitDownCycleTraversal:boolean: whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly

public Class SortingFocusTraversalPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail