Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
public class: SortingFocusTraversalPolicy [javadoc | source]
java.lang.Object
   java.awt.FocusTraversalPolicy
      javax.swing.InternalFrameFocusTraversalPolicy
         javax.swing.SortingFocusTraversalPolicy

Direct Known Subclasses:
    LegacyLayoutFocusTraversalPolicy, LayoutFocusTraversalPolicy

A FocusTraversalPolicy that determines traversal order by sorting the Components of a focus traversal cycle based on a given Comparator. Portions of the Component hierarchy that are not visible and displayable will not be included.

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

By default, methods of this class with return a Component only if it is visible, displayable, enabled, and focusable. Subclasses can modify this behavior by overriding the accept method.

This policy takes into account focus traversal policy providers. When searching for first/last/next/previous Component, if a focus traversal policy provider is encountered, its focus traversal policy is used to perform the search operation.

Constructor:
 protected SortingFocusTraversalPolicy() 
 public SortingFocusTraversalPolicy(Comparator<Component> comparator) 
    Constructs a SortingFocusTraversalPolicy with the specified Comparator.
Method from javax.swing.SortingFocusTraversalPolicy Summary:
accept,   getComparator,   getComponentAfter,   getComponentBefore,   getDefaultComponent,   getFirstComponent,   getImplicitDownCycleTraversal,   getLastComponent,   getTopmostProvider,   setComparator,   setImplicitDownCycleTraversal
Methods from javax.swing.InternalFrameFocusTraversalPolicy:
getInitialComponent
Methods from java.awt.FocusTraversalPolicy:
getComponentAfter,   getComponentBefore,   getDefaultComponent,   getFirstComponent,   getInitialComponent,   getLastComponent
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.SortingFocusTraversalPolicy Detail:
 protected boolean accept(Component aComponent) 
    Determines whether a Component is an acceptable choice as the new focus owner. By default, this method will accept a Component if and only if it is visible, displayable, enabled, and focusable.
 protected Comparator<Component> getComparator() 
    Returns the Comparator which will be used to sort the Components in a focus traversal cycle.
 public Component getComponentAfter(Container aContainer,
    Component aComponent) 
    Returns the Component that should receive the focus after aComponent. aContainer must be a focus cycle root of aComponent or a focus traversal policy provider.

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

 public Component getComponentBefore(Container aContainer,
    Component aComponent) 
    Returns the Component that should receive the focus before aComponent. aContainer must be a focus cycle root of aComponent or a focus traversal policy provider.

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

 public Component getDefaultComponent(Container aContainer) 
    Returns the default Component to focus. This Component will be the first to receive focus when traversing down into a new focus traversal cycle rooted at aContainer. The default implementation of this method returns the same Component as getFirstComponent.
 public Component getFirstComponent(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.
 public boolean getImplicitDownCycleTraversal() 
    Returns whether this SortingFocusTraversalPolicy transfers focus down- cycle implicitly. If true, during normal focus traversal, the Component traversed after a focus cycle root will be the focus-cycle-root's default Component to focus. If false, the next Component in the focus traversal cycle rooted at the specified focus cycle root will be traversed instead.
 public Component getLastComponent(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.
 Container getTopmostProvider(Container focusCycleRoot,
    Component aComponent) 
 protected  void setComparator(Comparator<Component> comparator) 
    Sets the Comparator which will be used to sort the Components in a focus traversal cycle.
 public  void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal) 
    Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle implicitly. If true, during normal focus traversal, the Component traversed after a focus cycle root will be the focus- cycle-root's default Component to focus. If false, the next Component in the focus traversal cycle rooted at the specified focus cycle root will be traversed instead. The default value for this property is true.