| |
|
| java.lang.Object
 java.awt.FocusTraversalPolicy
java.awt.ContainerOrderFocusTraversalPolicy
All known Subclasses: java.awt.DefaultFocusTraversalPolicy,
| ContainerOrderFocusTraversalPolicy | | public class ContainerOrderFocusTraversalPolicy extends FocusTraversalPolicy implements java.io.Serializable(Code) | | A FocusTraversalPolicy that determines traversal order based on the order
of child Components in a Container. From a particular focus cycle root, the
policy makes a pre-order traversal of the Component hierarchy, and traverses
a Container's children according to the ordering of the array returned by
Container.getComponents(). Portions of the hierarchy that are
not visible and displayable will not be searched.
By default, ContainerOrderFocusTraversalPolicy 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.
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.
author:
David Mendenhall
version:
1.15, 05/05/07
See Also: Container.getComponents
since:
1.4 |
| accept | | protected boolean accept(Component aComponent)(Code) | | 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.
Parameters:
aComponent - the Component whose fitness as a focus owner is tobe tested true if aComponent is visible, displayable,enabled, and focusable; false otherwise |
| getComponentAfter | | public Component getComponentAfter(Container aContainer, Component aComponent)(Code) | | 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, ContainerOrderFocusTraversalPolicy 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.
If aContainer is focus
traversal policy provider, the focus is always transferred down-cycle.
Parameters:
aContainer - a focus cycle root of aComponent or a focus traversal policy provider
Parameters:
aComponent - a (possibly indirect) child of aContainer, oraContainer itself the Component that should receive the focus after aComponent, ornull if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is not a focus cycleroot of aComponent or focus traversal policy provider, or if either aContainer oraComponent is null |
| getComponentBefore | | public Component getComponentBefore(Container aContainer, Component aComponent)(Code) | | 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.
Parameters:
aContainer - a focus cycle root of aComponent or focus traversal policy provider
Parameters:
aComponent - a (possibly indirect) child of aContainer, oraContainer itself the Component that should receive the focus before aComponent,or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is not a focus cycleroot of aComponent or focus traversal policy provider, or if either aContainer oraComponent is null |
| getDefaultComponent | | public Component getDefaultComponent(Container aContainer)(Code) | | 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.
Parameters:
aContainer - the focus cycle root or focus traversal policy provider whose defaultComponent is to be returned the default Component in the traversal cycle of aContainer,or null if no suitable Component can be found
See Also: ContainerOrderFocusTraversalPolicy.getFirstComponent
throws:
IllegalArgumentException - if aContainer is null |
| getFirstComponent | | public Component getFirstComponent(Container aContainer)(Code) | | 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.
Parameters:
aContainer - the focus cycle root or focus traversal policy provider whose firstComponent is to be returned the first Component in the traversal cycle of aContainer,or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is null |
| getImplicitDownCycleTraversal | | public boolean getImplicitDownCycleTraversal()(Code) | | Returns whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly. If true, during normal forward 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.
whether this ContainerOrderFocusTraversalPolicy transfers focusdown-cycle implicitly
See Also: ContainerOrderFocusTraversalPolicy.setImplicitDownCycleTraversal
See Also: ContainerOrderFocusTraversalPolicy.getFirstComponent |
| getLastComponent | | public Component getLastComponent(Container aContainer)(Code) | | 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.
Parameters:
aContainer - the focus cycle root or focus traversal policy provider whose lastComponent is to be returned the last Component in the traversal cycle of aContainer,or null if no suitable Component can be found
throws:
IllegalArgumentException - if aContainer is null |
| setImplicitDownCycleTraversal | | public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)(Code) | | Sets whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly. If true, during normal forward 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.
Parameters:
implicitDownCycleTraversal - whether thisContainerOrderFocusTraversalPolicy transfers focus down-cycleimplicitly
See Also: ContainerOrderFocusTraversalPolicy.getImplicitDownCycleTraversal
See Also: ContainerOrderFocusTraversalPolicy.getFirstComponent |
|
|
|