Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

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. All columns in a row are fully traversed before proceeding to the next row.

Since:

1.4

Constructor Summary

LayoutFocusTraversalPolicy()
Constructs a LayoutFocusTraversalPolicy.

Method Summary

protected boolean	accept(java.awt.Component aComponent) Determines whether the specified 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 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.

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.

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 the specified Component is an acceptable choice as the new focus owner. This method performs the following sequence of operations:

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

Overrides:

accept in class SortingFocusTraversalPolicy

Parameters:

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

Returns:

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

See Also:

Component.isVisible(), Component.isDisplayable(), Component.isEnabled(), Component.isFocusable(), javax.swing.plaf.ComboBoxUI#isFocusTraversable, JComponent.getInputMap(int), DefaultFocusTraversalPolicy.accept(java.awt.Component)