javax.swing
Class LayoutFocusTraversalPolicy

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.FocusTraversalPolicy sample code for java.awt.FocusTraversalPolicy definition code for java.awt.FocusTraversalPolicy 
      extended by javax.swing.InternalFrameFocusTraversalPolicy sample code for javax.swing.InternalFrameFocusTraversalPolicy definition code for javax.swing.InternalFrameFocusTraversalPolicy 
          extended by javax.swing.SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy 
              extended by javax.swing.LayoutFocusTraversalPolicy
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class LayoutFocusTraversalPolicy
extends SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy
implements Serializable sample code for java.io.Serializable definition code for 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 sample code for java.awt.ComponentOrientation definition code for java.awt.ComponentOrientation , Serialized Form

Constructor Summary
LayoutFocusTraversalPolicy sample code for javax.swing.LayoutFocusTraversalPolicy.LayoutFocusTraversalPolicy() definition code for javax.swing.LayoutFocusTraversalPolicy.LayoutFocusTraversalPolicy() ()
          Constructs a LayoutFocusTraversalPolicy.
 
Method Summary
protected  boolean accept sample code for javax.swing.LayoutFocusTraversalPolicy.accept(java.awt.Component) definition code for javax.swing.LayoutFocusTraversalPolicy.accept(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  aComponent)
          Determines whether the specified Component is an acceptable choice as the new focus owner.
 Component sample code for java.awt.Component definition code for java.awt.Component getComponentAfter sample code for javax.swing.LayoutFocusTraversalPolicy.getComponentAfter(java.awt.Container, java.awt.Component) definition code for javax.swing.LayoutFocusTraversalPolicy.getComponentAfter(java.awt.Container, java.awt.Component) (Container sample code for java.awt.Container definition code for java.awt.Container  aContainer, Component sample code for java.awt.Component definition code for java.awt.Component  aComponent)
          Returns the Component that should receive the focus after aComponent.
 Component sample code for java.awt.Component definition code for java.awt.Component getComponentBefore sample code for javax.swing.LayoutFocusTraversalPolicy.getComponentBefore(java.awt.Container, java.awt.Component) definition code for javax.swing.LayoutFocusTraversalPolicy.getComponentBefore(java.awt.Container, java.awt.Component) (Container sample code for java.awt.Container definition code for java.awt.Container  aContainer, Component sample code for java.awt.Component definition code for java.awt.Component  aComponent)
          Returns the Component that should receive the focus before aComponent.
 Component sample code for java.awt.Component definition code for java.awt.Component getFirstComponent sample code for javax.swing.LayoutFocusTraversalPolicy.getFirstComponent(java.awt.Container) definition code for javax.swing.LayoutFocusTraversalPolicy.getFirstComponent(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  aContainer)
          Returns the first Component in the traversal cycle.
 Component sample code for java.awt.Component definition code for java.awt.Component getLastComponent sample code for javax.swing.LayoutFocusTraversalPolicy.getLastComponent(java.awt.Container) definition code for javax.swing.LayoutFocusTraversalPolicy.getLastComponent(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  aContainer)
          Returns the last Component in the traversal cycle.
 
Methods inherited from class javax.swing.SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy
getComparator sample code for javax.swing.SortingFocusTraversalPolicy.getComparator() definition code for javax.swing.SortingFocusTraversalPolicy.getComparator() , getDefaultComponent sample code for javax.swing.SortingFocusTraversalPolicy.getDefaultComponent(java.awt.Container) definition code for javax.swing.SortingFocusTraversalPolicy.getDefaultComponent(java.awt.Container) , getImplicitDownCycleTraversal sample code for javax.swing.SortingFocusTraversalPolicy.getImplicitDownCycleTraversal() definition code for javax.swing.SortingFocusTraversalPolicy.getImplicitDownCycleTraversal() , setComparator sample code for javax.swing.SortingFocusTraversalPolicy.setComparator(java.util.Comparator) definition code for javax.swing.SortingFocusTraversalPolicy.setComparator(java.util.Comparator) , setImplicitDownCycleTraversal sample code for javax.swing.SortingFocusTraversalPolicy.setImplicitDownCycleTraversal(boolean) definition code for javax.swing.SortingFocusTraversalPolicy.setImplicitDownCycleTraversal(boolean)
 
Methods inherited from class javax.swing.InternalFrameFocusTraversalPolicy sample code for javax.swing.InternalFrameFocusTraversalPolicy definition code for javax.swing.InternalFrameFocusTraversalPolicy
getInitialComponent sample code for javax.swing.InternalFrameFocusTraversalPolicy.getInitialComponent(javax.swing.JInternalFrame) definition code for javax.swing.InternalFrameFocusTraversalPolicy.getInitialComponent(javax.swing.JInternalFrame)
 
Methods inherited from class java.awt.FocusTraversalPolicy sample code for java.awt.FocusTraversalPolicy definition code for java.awt.FocusTraversalPolicy
getInitialComponent sample code for java.awt.FocusTraversalPolicy.getInitialComponent(java.awt.Window) definition code for java.awt.FocusTraversalPolicy.getInitialComponent(java.awt.Window)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

LayoutFocusTraversalPolicy sample code for javax.swing.LayoutFocusTraversalPolicy() definition code for javax.swing.LayoutFocusTraversalPolicy()

public LayoutFocusTraversalPolicy()
Constructs a LayoutFocusTraversalPolicy.

Method Detail

getComponentAfter sample code for javax.swing.LayoutFocusTraversalPolicy.getComponentAfter(java.awt.Container, java.awt.Component) definition code for javax.swing.LayoutFocusTraversalPolicy.getComponentAfter(java.awt.Container, java.awt.Component)

public Component sample code for java.awt.Component definition code for java.awt.Component  getComponentAfter(Container sample code for java.awt.Container definition code for java.awt.Container  aContainer,
                                   Component sample code for java.awt.Component definition code for java.awt.Component  aComponent)
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.

Overrides:
getComponentAfter sample code for javax.swing.SortingFocusTraversalPolicy.getComponentAfter(java.awt.Container, java.awt.Component) definition code for javax.swing.SortingFocusTraversalPolicy.getComponentAfter(java.awt.Container, java.awt.Component) in class SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy
Parameters:
aContainer - a focus cycle root of aComponent or a focus traversal policy provider
aComponent - a (possibly indirect) child of aContainer, or aContainer itself
Returns:
the Component that should receive the focus after aComponent, or null if no suitable Component can be found
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.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 sample code for javax.swing.LayoutFocusTraversalPolicy.getComponentBefore(java.awt.Container, java.awt.Component) definition code for javax.swing.LayoutFocusTraversalPolicy.getComponentBefore(java.awt.Container, java.awt.Component)

public Component sample code for java.awt.Component definition code for java.awt.Component  getComponentBefore(Container sample code for java.awt.Container definition code for java.awt.Container  aContainer,
                                    Component sample code for java.awt.Component definition code for java.awt.Component  aComponent)
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.

Overrides:
getComponentBefore sample code for javax.swing.SortingFocusTraversalPolicy.getComponentBefore(java.awt.Container, java.awt.Component) definition code for javax.swing.SortingFocusTraversalPolicy.getComponentBefore(java.awt.Container, java.awt.Component) in class SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy
Parameters:
aContainer - a focus cycle root of aComponent or a focus traversal policy provider
aComponent - a (possibly indirect) child of aContainer, or aContainer itself
Returns:
the Component that should receive the focus before aComponent, or null if no suitable Component can be found
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.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 sample code for javax.swing.LayoutFocusTraversalPolicy.getFirstComponent(java.awt.Container) definition code for javax.swing.LayoutFocusTraversalPolicy.getFirstComponent(java.awt.Container)

public Component sample code for java.awt.Component definition code for java.awt.Component  getFirstComponent(Container sample code for java.awt.Container definition code for java.awt.Container  aContainer)
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 sample code for javax.swing.SortingFocusTraversalPolicy.getFirstComponent(java.awt.Container) definition code for javax.swing.SortingFocusTraversalPolicy.getFirstComponent(java.awt.Container) in class SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy
Parameters:
aContainer - a focus cycle root of aComponent or a focus traversal policy provider whose first Component is to be returned
Returns:
the first Component in the traversal cycle of aContainer, or null if no suitable Component can be found
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if aContainer is null

getLastComponent sample code for javax.swing.LayoutFocusTraversalPolicy.getLastComponent(java.awt.Container) definition code for javax.swing.LayoutFocusTraversalPolicy.getLastComponent(java.awt.Container)

public Component sample code for java.awt.Component definition code for java.awt.Component  getLastComponent(Container sample code for java.awt.Container definition code for java.awt.Container  aContainer)
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 sample code for javax.swing.SortingFocusTraversalPolicy.getLastComponent(java.awt.Container) definition code for javax.swing.SortingFocusTraversalPolicy.getLastComponent(java.awt.Container) in class SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.SortingFocusTraversalPolicy
Parameters:
aContainer - a focus cycle root of aComponent or a focus traversal policy provider whose last Component is to be returned
Returns:
the last Component in the traversal cycle of aContainer, or null if no suitable Component can be found
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if aContainer is null

accept sample code for javax.swing.LayoutFocusTraversalPolicy.accept(java.awt.Component) definition code for javax.swing.LayoutFocusTraversalPolicy.accept(java.awt.Component)

protected boolean accept(Component sample code for java.awt.Component definition code for 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 sample code for javax.swing.SortingFocusTraversalPolicy.accept(java.awt.Component) definition code for javax.swing.SortingFocusTraversalPolicy.accept(java.awt.Component) in class SortingFocusTraversalPolicy sample code for javax.swing.SortingFocusTraversalPolicy definition code for javax.swing.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() sample code for java.awt.Component.isVisible() definition code for java.awt.Component.isVisible() , Component.isDisplayable() sample code for java.awt.Component.isDisplayable() definition code for java.awt.Component.isDisplayable() , Component.isEnabled() sample code for java.awt.Component.isEnabled() definition code for java.awt.Component.isEnabled() , Component.isFocusable() sample code for java.awt.Component.isFocusable() definition code for java.awt.Component.isFocusable() , ComboBoxUI.isFocusTraversable(javax.swing.JComboBox) sample code for javax.swing.plaf.ComboBoxUI.isFocusTraversable(javax.swing.JComboBox) definition code for javax.swing.plaf.ComboBoxUI.isFocusTraversable(javax.swing.JComboBox) , JComponent.getInputMap(int) sample code for javax.swing.JComponent.getInputMap(int) definition code for javax.swing.JComponent.getInputMap(int) , DefaultFocusTraversalPolicy.accept(java.awt.Component) sample code for java.awt.DefaultFocusTraversalPolicy.accept(java.awt.Component) definition code for java.awt.DefaultFocusTraversalPolicy.accept(java.awt.Component)