javax.swing
Class LayoutFocusTraversalPolicy

java.lang.Object
  |
  +--java.awt.FocusTraversalPolicy
        |
        +--javax.swing.InternalFrameFocusTraversalPolicy
              |
              +--javax.swing.SortingFocusTraversalPolicy
                    |
                    +--javax.swing.LayoutFocusTraversalPolicy

All Implemented Interfaces:

java.io.Serializable

public class LayoutFocusTraversalPolicy

extends SortingFocusTraversalPolicy

implements java.io.Serializable

A SortingFocusTraversalPolicy which sorts Components based on their size, position, and orientation. Based on their size and position, Components are roughly categorized into rows and columns. For a Container with horizontal orientation, columns run left-to-right or right-to-left, and rows run top- to-bottom. For a Container with vertical orientation, columns run top-to- bottom and rows run left-to-right or right-to-left. See ComponentOrientation for more information. All columns in a row are fully traversed before proceeding to the next row.

Since:

1.4

See Also:

ComponentOrientation

Constructor Summary

LayoutFocusTraversalPolicy()
Constructs a LayoutFocusTraversalPolicy.

Method Summary

protected boolean	accept(java.awt.Component aComponent) Determines whether a Component is an acceptable choice as the new focus owner.
java.awt.Component	getComponentAfter(java.awt.Container focusCycleRoot, java.awt.Component aComponent) Returns the Component that should receive the focus after aComponent.
java.awt.Component	getComponentBefore(java.awt.Container focusCycleRoot, java.awt.Component aComponent) Returns the Component that should receive the focus before aComponent.
java.awt.Component	getFirstComponent(java.awt.Container focusCycleRoot) Returns the first Component in the traversal cycle.
java.awt.Component	getLastComponent(java.awt.Container focusCycleRoot) Returns the last Component in the traversal cycle.

Methods inherited from class javax.swing.SortingFocusTraversalPolicy

getComparator, getDefaultComponent, getImplicitDownCycleTraversal, setComparator, setImplicitDownCycleTraversal

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

LayoutFocusTraversalPolicy

public LayoutFocusTraversalPolicy()

Constructs a LayoutFocusTraversalPolicy.

Method Detail

getComponentAfter

public java.awt.Component getComponentAfter(java.awt.Container focusCycleRoot,
                                            java.awt.Component aComponent)

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

By default, LayoutFocusTraversalPolicy 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.

Overrides:

getComponentAfter in class SortingFocusTraversalPolicy

Parameters:

focusCycleRoot - a focus cycle root of aComponent

aComponent - a (possibly indirect) child of focusCycleRoot, or focusCycleRoot itself

Returns:

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

Throws:

java.lang.IllegalArgumentException - if focusCycleRoot is not a focus cycle root of aComponent, or if either focusCycleRoot or aComponent is null

getComponentBefore

public java.awt.Component getComponentBefore(java.awt.Container focusCycleRoot,
                                             java.awt.Component aComponent)

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

Overrides:

getComponentBefore in class SortingFocusTraversalPolicy

Parameters:

focusCycleRoot - a focus cycle root of aComponent

aComponent - a (possibly indirect) child of focusCycleRoot, or focusCycleRoot itself

Returns:

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

Throws:

java.lang.IllegalArgumentException - if focusCycleRoot is not a focus cycle root of aComponent, or if either focusCycleRoot or aComponent is null

getFirstComponent

public java.awt.Component getFirstComponent(java.awt.Container focusCycleRoot)

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.

Overrides:

getFirstComponent in class SortingFocusTraversalPolicy

Parameters:

focusCycleRoot - the focus cycle root whose first Component is to be returned

Returns:

the first Component in the traversal cycle when focusCycleRoot is the focus cycle root, or null if no suitable Component can be found

Throws:

java.lang.IllegalArgumentException - if focusCycleRoot is null

getLastComponent

public java.awt.Component getLastComponent(java.awt.Container focusCycleRoot)

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.

Overrides:

getLastComponent in class SortingFocusTraversalPolicy

Parameters:

focusCycleRoot - the focus cycle root whose last Component is to be returned

Returns:

the last Component in the traversal cycle when focusCycleRoot is the focus cycle root, or null if no suitable Component can be found

Throws:

java.lang.IllegalArgumentException - if focusCycleRoot is null

accept

protected boolean accept(java.awt.Component aComponent)

Determines whether a Component is an acceptable choice as the new focus owner. By default, this method will accept a Component only if it is visible, displayable, enabled, and focusable. If the Component is a JComponent, it must also have a non-null, non-empty InputMap.

Overrides:

accept in class SortingFocusTraversalPolicy

Parameters:

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

Returns:

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