OpenJDK 27 · javax.swing.LayoutFocusTraversalPolicy · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final SwingDefaultFocusTraversalPolicy	fitnessTestPolicy Hides javax.swing.SortingFocusTraversalPolicy.fitnessTestPolicy.

Access	Constructor and Description
public	LayoutFocusTraversalPolicy() Constructs a LayoutFocusTraversalPolicy.
pack-priv	LayoutFocusTraversalPolicy(Comparator<? super Component> c) Constructs a LayoutFocusTraversalPolicy with the passed in `Comparator`.

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` if `aComponent` is a valid choice for a focus owner; otherwise `false` accept(Component the `Component` whose fitness as a focus owner is to be tested aComponent) Overrides javax.swing.SortingFocusTraversalPolicy.accept. Determines whether the specified `Component` is an acceptable choice as the new focus owner.
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) Overrides javax.swing.SortingFocusTraversalPolicy.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) Overrides javax.swing.SortingFocusTraversalPolicy.getComponentBefore. Returns the Component that should receive the focus before aComponent.
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) Overrides javax.swing.SortingFocusTraversalPolicy.getFirstComponent. Returns the first Component in the traversal cycle.
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) Overrides javax.swing.SortingFocusTraversalPolicy.getLastComponent. Returns the last Component in the traversal cycle.
private void	readObject(ObjectInputStream in)
private void	writeObject(ObjectOutputStream out)

Inherited from javax.swing.SortingFocusTraversalPolicy:: getComparator getDefaultComponent getImplicitDownCycleTraversal getTopmostProvider setComparator setImplicitDownCycleTraversal

fitnessTestPolicy	back to summary
private static final SwingDefaultFocusTraversalPolicy fitnessTestPolicy Hides javax.swing.SortingFocusTraversalPolicy.fitnessTestPolicy.

LayoutFocusTraversalPolicy	back to summary
public LayoutFocusTraversalPolicy() Constructs a LayoutFocusTraversalPolicy.

LayoutFocusTraversalPolicy	back to summary
pack-priv LayoutFocusTraversalPolicy(Comparator<? super Component> c) Constructs a LayoutFocusTraversalPolicy with the passed in `Comparator`.

Method Detail

accept back to summary

accept	back to summary
protected boolean accept(Component aComponent) Overrides javax.swing.SortingFocusTraversalPolicy.accept. Determines whether the specified `Component` is an acceptable choice as the new focus owner. This method performs the following sequence of operations: Checks whether `aComponent` is visible, displayable, enabled, and focusable. If any of these properties is `false`, this method returns `false`. If `aComponent` is an instance of `JTable`, returns `true`. If `aComponent` is an instance of `JComboBox`, then returns the value of `aComponent.getUI().isFocusTraversable(aComponent)`. If `aComponent` is a `JComponent` with a `JComponent.WHEN_FOCUSED` `InputMap` that is neither `null` nor empty, returns `true`. Returns the value of `DefaultFocusTraversalPolicy.accept(aComponent)`. Parameters aComponent:Component the `Component` whose fitness as a focus owner is to be tested Returns:boolean `true` if `aComponent` is a valid choice for a focus owner; otherwise `false` See Also `java.awt.Component#isVisible`, `java.awt.Component#isDisplayable`, `java.awt.Component#isEnabled`, `java.awt.Component#isFocusable`, `javax.swing.plaf.ComboBoxUI#isFocusTraversable`, `javax.swing.JComponent#getInputMap`, `java.awt.DefaultFocusTraversalPolicy#accept`

protected boolean accept(Component aComponent)

Overrides javax.swing.SortingFocusTraversalPolicy.accept.

Determines whether the specified Component is an acceptable choice as the new focus owner. This method performs the following sequence of operations:

Checks whether aComponent is visible, displayable, enabled, and focusable. If any of these properties is false, this method returns false.
If aComponent is an instance of JTable, returns true.
If aComponent is an instance of JComboBox, then returns the value of aComponent.getUI().isFocusTraversable(aComponent).
If aComponent is a JComponent with a JComponent.WHEN_FOCUSED InputMap that is neither null nor empty, returns true.
Returns the value of DefaultFocusTraversalPolicy.accept(aComponent).

Parameters

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

Returns:boolean

true if aComponent is a valid choice for a focus owner; otherwise false

getComponentAfter back to summary

getComponentAfter	back to summary
public Component getComponentAfter(Container aContainer, Component aComponent) Overrides javax.swing.SortingFocusTraversalPolicy.getComponentAfter. Returns the Component that should receive the focus after aComponent. aContainer must be a focus cycle root of aComponent. By default, LayoutFocusTraversalPolicy 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)

Overrides javax.swing.SortingFocusTraversalPolicy.getComponentAfter.

Returns the Component that should receive the focus after aComponent. aContainer must be a focus cycle root of aComponent.

By default, LayoutFocusTraversalPolicy 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) Overrides javax.swing.SortingFocusTraversalPolicy.getComponentBefore. Returns the Component that should receive the focus before aComponent. aContainer must be a focus cycle root of aComponent. By default, LayoutFocusTraversalPolicy 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)

Overrides javax.swing.SortingFocusTraversalPolicy.getComponentBefore.

Returns the Component that should receive the focus before aComponent. aContainer must be a focus cycle root of aComponent.

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

getFirstComponent	back to summary
public Component getFirstComponent(Container aContainer) Overrides javax.swing.SortingFocusTraversalPolicy.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)

Overrides javax.swing.SortingFocusTraversalPolicy.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

getLastComponent	back to summary
public Component getLastComponent(Container aContainer) Overrides javax.swing.SortingFocusTraversalPolicy.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)

Overrides javax.swing.SortingFocusTraversalPolicy.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

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Annotations @Serial @SuppressWarnings:unchecked

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Annotations @Serial

public Class LayoutFocusTraversalPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail