LayoutFocusTraversalPolicy
public class SortingFocusTraversalPolicy extends InternalFrameFocusTraversalPolicy
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.
Comparator
Modifier | Constructor | Description |
---|---|---|
protected |
SortingFocusTraversalPolicy() |
Constructs a SortingFocusTraversalPolicy without a Comparator.
|
|
SortingFocusTraversalPolicy(Comparator<? super Component> comparator) |
Constructs a SortingFocusTraversalPolicy with the specified Comparator.
|
Modifier and Type | Method | Description |
---|---|---|
protected boolean |
accept(Component aComponent) |
Determines whether a Component is an acceptable choice as the new
focus owner.
|
protected Comparator<? super Component> |
getComparator() |
Returns the Comparator which will be used to sort the Components in a
focus traversal cycle.
|
Component |
getComponentAfter(Container aContainer,
Component aComponent) |
Returns the Component that should receive the focus after aComponent.
|
Component |
getComponentBefore(Container aContainer,
Component aComponent) |
Returns the Component that should receive the focus before aComponent.
|
Component |
getDefaultComponent(Container aContainer) |
Returns the default Component to focus.
|
Component |
getFirstComponent(Container aContainer) |
Returns the first Component in the traversal cycle.
|
boolean |
getImplicitDownCycleTraversal() |
Returns whether this SortingFocusTraversalPolicy transfers focus down-
cycle implicitly.
|
Component |
getLastComponent(Container aContainer) |
Returns the last Component in the traversal cycle.
|
protected void |
setComparator(Comparator<? super Component> comparator) |
Sets the Comparator which will be used to sort the Components in a
focus traversal cycle.
|
void |
setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal) |
Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle
implicitly.
|
getInitialComponent
getInitialComponent
protected SortingFocusTraversalPolicy()
setComparator
before installing this FocusTraversalPolicy on a focus cycle root or
KeyboardFocusManager.public SortingFocusTraversalPolicy(Comparator<? super Component> comparator)
comparator
- the Comparator
to sort bypublic Component getComponentAfter(Container aContainer, Component aComponent)
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.
getComponentAfter
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provideraComponent
- a (possibly indirect) child of aContainer, or
aContainer itselfIllegalArgumentException
- if aContainer is not a focus cycle
root of aComponent or a focus traversal policy provider, or if either aContainer or
aComponent is nullpublic Component getComponentBefore(Container aContainer, Component aComponent)
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.
getComponentBefore
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provideraComponent
- a (possibly indirect) child of aContainer, or
aContainer itselfIllegalArgumentException
- if aContainer is not a focus cycle
root of aComponent or a focus traversal policy provider, or if either aContainer or
aComponent is nullpublic Component getFirstComponent(Container aContainer)
getFirstComponent
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provider whose
first Component is to be returnedIllegalArgumentException
- if aContainer is nullpublic Component getLastComponent(Container aContainer)
getLastComponent
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provider whose
last Component is to be returnedIllegalArgumentException
- if aContainer is nullpublic Component getDefaultComponent(Container aContainer)
getFirstComponent
.getDefaultComponent
in class FocusTraversalPolicy
aContainer
- a focus cycle root of aComponent or a focus traversal policy provider whose
default Component is to be returnedIllegalArgumentException
- if aContainer is nullgetFirstComponent(java.awt.Container)
public void setImplicitDownCycleTraversal(boolean implicitDownCycleTraversal)
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
.implicitDownCycleTraversal
- whether this
SortingFocusTraversalPolicy transfers focus down-cycle implicitlygetImplicitDownCycleTraversal()
,
getFirstComponent(java.awt.Container)
public boolean getImplicitDownCycleTraversal()
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.setImplicitDownCycleTraversal(boolean)
,
getFirstComponent(java.awt.Container)
protected void setComparator(Comparator<? super Component> comparator)
comparator
- the Comparator which will be used for sortingprotected Comparator<? super Component> getComparator()
protected boolean accept(Component aComponent)
aComponent
- the Component whose fitness as a focus owner is to
be testedtrue
if aComponent is visible, displayable,
enabled, and focusable; false
otherwise Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps