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 will 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.
Container#getComponents
| Modifier and Type | Field and Description |
|---|---|
| private final int | |
| private transient List | |
| private transient Container | cachedRoot
Used by getComponentAfter and getComponentBefore for efficiency. |
| private final int | |
| private boolean | |
| private static final PlatformLogger | |
| private static final long | serialVersionUID
Use serialVersionUID from JDK 1.4 for interoperability. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected boolean | |
| private void | |
| public Component | Returns: the Component that should receive the focus after aComponent, or null if no suitable Component can be founda focus cycle root of aComponent or a focus traversal policy provider aContainer, Component a (possibly indirect) child of aContainer, or
aContainer itself aComponent)Implements abstract java. Returns the Component that should receive the focus after aComponent. |
| public Component | Returns: the Component that should receive the focus before aComponent, or null if no suitable Component can be founda focus cycle root of aComponent or focus traversal policy provider aContainer, Component a (possibly indirect) child of aContainer, or
aContainer itself aComponent)Implements abstract java. Returns the Component that should receive the focus before aComponent. |
| private Component | |
| private int | |
| public Component | Returns: the default Component in the traversal cycle of aContainer, or null if no suitable Component can be foundthe focus cycle root or focus traversal policy provider whose default
Component is to be returned aContainer)Implements abstract java. Returns the default Component to focus. |
| public Component | Returns: the first Component in the traversal cycle of aContainer, or null if no suitable Component can be foundthe focus cycle root or focus traversal policy provider whose first
Component is to be returned aContainer)Implements abstract java. Returns the first Component in the traversal cycle. |
| private List | |
| public boolean | Returns: whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitlyReturns whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly. |
| public Component | Returns: the last Component in the traversal cycle of aContainer, or null if no suitable Component can be foundthe focus cycle root or focus traversal policy provider whose last
Component is to be returned aContainer)Implements abstract java. Returns the last Component in the traversal cycle. |
| private Container | |
| public void | setImplicitDownCycleTraversal(boolean
whether this
ContainerOrderFocusTraversalPolicy transfers focus down-cycle
implicitly implicitDownCycleTraversal)Sets whether this ContainerOrderFocusTraversalPolicy transfers focus down-cycle implicitly. |
| BACKWARD_TRAVERSAL | back to summary |
|---|---|
| private final int BACKWARD_TRAVERSAL | |
| cachedCycle | back to summary |
|---|---|
| private transient List<Component> cachedCycle | |
| cachedRoot | back to summary |
|---|---|
| private transient Container cachedRoot Used by getComponentAfter and getComponentBefore for efficiency. In order to maintain compliance with the specification of FocusTraversalPolicy, if traversal wraps, we should invoke getFirstComponent or getLastComponent. These methods may be overridden in subclasses to behave in a non-generic way. However, in the generic case, these methods will simply return the first or last Components of the sorted list, respectively. Since getComponentAfter and getComponentBefore have already built the list before determining that they need to invoke getFirstComponent or getLastComponent, the list should be reused if possible. | |
| FORWARD_TRAVERSAL | back to summary |
|---|---|
| private final int FORWARD_TRAVERSAL | |
| implicitDownCycleTraversal | back to summary |
|---|---|
| private boolean implicitDownCycleTraversal | |
| log | back to summary |
|---|---|
| private static final PlatformLogger log | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Use serialVersionUID from JDK 1.4 for interoperability. | |
| ContainerOrderFocusTraversalPolicy | back to summary |
|---|---|
| public ContainerOrderFocusTraversalPolicy() Constructs a | |
| accept | back to summary |
|---|---|
| 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.
| |
| enumerateCycle | back to summary |
|---|---|
| private void enumerateCycle(Container container, List<Component> cycle) | |
| getComponentAfter | back to summary |
|---|---|
| public Component getComponentAfter(Container aContainer, Component aComponent) Implements abstract java. 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 If aContainer is focus traversal policy provider, the focus is always transferred down-cycle.
| |
| getComponentBefore | back to summary |
|---|---|
| public Component getComponentBefore(Container aContainer, Component aComponent) Implements abstract java. 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.
| |
| getComponentDownCycle | back to summary |
|---|---|
| private Component getComponentDownCycle(Component comp, int traversalDirection) | |
| getComponentIndex | back to summary |
|---|---|
| private int getComponentIndex(List<Component> cycle, Component aComponent) | |
| getDefaultComponent | back to summary |
|---|---|
| public Component getDefaultComponent(Container aContainer) Implements abstract java. 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 | back to summary |
|---|---|
| public Component getFirstComponent(Container aContainer) Implements abstract java. 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.
| |
| getFocusTraversalCycle | back to summary |
|---|---|
| private List | |
| getImplicitDownCycleTraversal | back to summary |
|---|---|
| public boolean getImplicitDownCycleTraversal() Returns whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly. If
| |
| getLastComponent | back to summary |
|---|---|
| public Component getLastComponent(Container aContainer) Implements abstract java. 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.
| |
| getTopmostProvider | back to summary |
|---|---|
| private Container getTopmostProvider(Container focusCycleRoot, Component aComponent) | |
| setImplicitDownCycleTraversal | back to summary |
|---|---|
| public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal) Sets whether this ContainerOrderFocusTraversalPolicy transfers focus
down-cycle implicitly. If
| |