ContainerOrderFocusTraversalPolicy JDK 1.6)

Description

public class ContainerOrderFocusTraversalPolicy

A FocusTraversalPolicy that determines traversal order based on the order of child Components in a Container.

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.

See also: Container.getComponents()

Methods

Hide/Show inherited methods

protected boolean accept (Component aComponent)

Determines whether a Component is an acceptable choice as the new focus owner.

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.
Returns: true if aComponent is visible, displayable, enabled, and focusable; false otherwise
Parameters:
- aComponent - the Component whose fitness as a focus owner is to be tested

public Component getComponentAfter (Container aContainer, Component aComponent) [Specified in FocusTraversalPolicy]

Returns the Component that should receive the focus after aComponent.

public Component getComponentBefore (Container aContainer, Component aComponent) [Specified in FocusTraversalPolicy]

Returns the Component that should receive the focus before aComponent.

public Component getDefaultComponent (Container aContainer) [Specified in FocusTraversalPolicy]

Returns the default Component to focus.

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.
Returns: the default Component in the traversal cycle of aContainer, or null if no suitable Component can be found
Parameters:
- aContainer - the focus cycle root or focus traversal policy provider whose default Component is to be returned
Throws:
- IllegalArgumentException - if aContainer is null
See Also: ContainerOrderFocusTraversalPolicy.getFirstComponent(java.awt.Container),

public Component getFirstComponent (Container aContainer) [Specified in FocusTraversalPolicy]

Returns the first Component in the traversal cycle.

public boolean getImplicitDownCycleTraversal ()

Returns whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly.

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.
Returns: whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly
See Also: ContainerOrderFocusTraversalPolicy.setImplicitDownCycleTraversal(boolean), ContainerOrderFocusTraversalPolicy.getFirstComponent(java.awt.Container),

public Component getInitialComponent (Window window) [Inherited From FocusTraversalPolicy]

Returns the Component that should receive the focus when a Window is made visible for the first time.

Returns the Component that should receive the focus when a Window is
made visible for the first time. Once the Window has been made visible
by a call to show() or setVisible(true), the
initial Component will not be used again. Instead, if the Window loses
and subsequently regains focus, or is made invisible or undisplayable
and subsequently made visible and displayable, the Window's most
recently focused Component will become the focus owner. The default
implementation of this method returns the default Component.
Returns: the Component that should receive the focus when window is made visible for the first time, or null if no suitable Component can be found
Parameters:
- window - the Window whose initial Component is to be returned
Throws:
- IllegalArgumentException - if window is null
See Also: FocusTraversalPolicy.getDefaultComponent(java.awt.Container), Window.getMostRecentFocusOwner(),

public Component getLastComponent (Container aContainer) [Specified in FocusTraversalPolicy]

Returns the last Component in the traversal cycle.

public void setImplicitDownCycleTraversal (boolean implicitDownCycleTraversal)

Sets whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly.

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 this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly
See Also: ContainerOrderFocusTraversalPolicy.getImplicitDownCycleTraversal(), ContainerOrderFocusTraversalPolicy.getFirstComponent(java.awt.Container),