javax.swing
Class LayoutFocusTraversalPolicy

java.lang.Object
  extended byjava.awt.FocusTraversalPolicy
      extended byjavax.swing.InternalFrameFocusTraversalPolicy
          extended byjavax.swing.SortingFocusTraversalPolicy
              extended byjavax.swing.LayoutFocusTraversalPolicy
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
LegacyLayoutFocusTraversalPolicy

public class LayoutFocusTraversalPolicy
extends SortingFocusTraversalPolicy
implements 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
Author:
David Mendenhall
See Also:
ComponentOrientation, Serialized Form

Field Summary
private static SwingDefaultFocusTraversalPolicy fitnessTestPolicy
           
 
Fields inherited from class javax.swing.SortingFocusTraversalPolicy
 
Constructor Summary
  LayoutFocusTraversalPolicy()
          Constructs a LayoutFocusTraversalPolicy.
(package private) LayoutFocusTraversalPolicy(Comparator c)
          Constructs a LayoutFocusTraversalPolicy with the passed in Comparator.
 
Method Summary
protected  boolean accept(Component aComponent)
          Determines whether the specified Component is an acceptable choice as the new focus owner.
 Component getComponentAfter(Container focusCycleRoot, Component aComponent)
          Returns the Component that should receive the focus after aComponent.
 Component getComponentBefore(Container focusCycleRoot, Component aComponent)
          Returns the Component that should receive the focus before aComponent.
 Component getFirstComponent(Container focusCycleRoot)
          Returns the first Component in the traversal cycle.
 Component getLastComponent(Container focusCycleRoot)
          Returns the last Component in the traversal cycle.
private  void readObject(ObjectInputStream in)
           
private  void writeObject(ObjectOutputStream out)
           
 
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
 

Field Detail

fitnessTestPolicy

private static final SwingDefaultFocusTraversalPolicy fitnessTestPolicy
Constructor Detail

LayoutFocusTraversalPolicy

public LayoutFocusTraversalPolicy()
Constructs a LayoutFocusTraversalPolicy.


LayoutFocusTraversalPolicy

LayoutFocusTraversalPolicy(Comparator c)
Constructs a LayoutFocusTraversalPolicy with the passed in Comparator.

Method Detail

getComponentAfter

public Component getComponentAfter(Container focusCycleRoot,
                                   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:
IllegalArgumentException - if focusCycleRoot is not a focus cycle root of aComponent, or if either focusCycleRoot or aComponent is null

getComponentBefore

public Component getComponentBefore(Container focusCycleRoot,
                                    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:
IllegalArgumentException - if focusCycleRoot is not a focus cycle root of aComponent, or if either focusCycleRoot or aComponent is null

getFirstComponent

public Component getFirstComponent(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:
IllegalArgumentException - if focusCycleRoot is null

getLastComponent

public Component getLastComponent(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:
IllegalArgumentException - if focusCycleRoot is null

accept

protected boolean accept(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(), ComboBoxUI.isFocusTraversable(javax.swing.JComboBox), JComponent.getInputMap(int), DefaultFocusTraversalPolicy.accept(java.awt.Component)

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException
Throws:
IOException

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Throws:
IOException
ClassNotFoundException