/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* 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.
* <p>
* 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
* <code>setImplicitDownCycleTraversal</code> method.
* <p>
* 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 <code>accept</code> method.
* <p>
* This policy takes into account <a
* href="../../java/awt/doc-files/FocusSpec.html#FocusTraversalPolicyProviders">focus traversal
* if a focus traversal policy provider is encountered, its focus traversal
* policy is used to perform the search operation.
*
* @author David Mendenhall
*
* @see java.util.Comparator
* @since 1.4
*/
public class SortingFocusTraversalPolicy
{
private boolean implicitDownCycleTraversal = true;
/**
* 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 overriden 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 sorted list before determining
* that they need to invoke getFirstComponent or getLastComponent, the
* sorted list should be reused if possible.
*/
// Delegate our fitness test to ContainerOrder so that we only have to
// code the algorithm once.
private static final SwingContainerOrderFocusTraversalPolicy
/**
* Constructs a SortingFocusTraversalPolicy without a Comparator.
* Subclasses must set the Comparator using <code>setComparator</code>
* before installing this FocusTraversalPolicy on a focus cycle root or
* KeyboardFocusManager.
*/
protected SortingFocusTraversalPolicy() {
}
/**
* Constructs a SortingFocusTraversalPolicy with the specified Comparator.
*/
this.comparator = comparator;
}
return cycle;
}
int index;
try {
} catch (ClassCastException e) {
}
return -1;
}
if (index < 0) {
// Fix for 5070991.
// A workaround for a transitivity problem caused by ROW_TOLERANCE,
// because of that the component may be missed in the binary search.
// Try to search it again directly.
}
return index;
}
if (focusCycleRoot.isShowing()) {
}
}
return;
}
if (!cont.isFocusCycleRoot() &&
{
continue;
}
}
}
}
if (aCont.isFocusTraversalPolicyProvider()) {
}
}
return null;
}
return ftp;
}
/*
* Checks if a new focus cycle takes place and returns a Component to traverse focus to.
* @param comp a possible focus cycle root or policy provider
* @param traversalDirection the direction of the traversal
* @return a Component to traverse focus to if {@code comp} is a root or provider
* and implicit down-cycle is set, otherwise {@code null}
*/
if (cont.isFocusCycleRoot()) {
if (getImplicitDownCycleTraversal()) {
" in the focus cycle root " + cont);
}
} else {
return null;
}
} else if (cont.isFocusTraversalPolicyProvider()) {
}
}
}
return retComp;
}
/**
* 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.
* <p>
* 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
* <code>setImplicitDownCycleTraversal</code> method.
* <p>
* If aContainer is <a href="../../java/awt/doc-files/FocusSpec.html#FocusTraversalPolicyProviders">focus
* traversal policy provider</a>, the focus is always transferred down-cycle.
*
* @param aContainer a focus cycle root of aComponent or a focus traversal policy provider
* @param aComponent a (possibly indirect) child of aContainer, or
* aContainer itself
* @return the Component that should receive the focus after aComponent, or
* null if no suitable Component can be found
* @throws IllegalArgumentException if aContainer is not a focus cycle
* root of aComponent or a focus traversal policy provider, or if either aContainer or
* aComponent is null
*/
}
throw new IllegalArgumentException("aContainer and aComponent cannot be null");
}
throw new IllegalArgumentException("aContainer should be focus cycle root or focus traversal policy provider");
throw new IllegalArgumentException("aContainer is not a focus cycle root of aComponent");
}
// Before all the ckecks below we first see if it's an FTP provider or a focus cycle root.
// If it's the case just go down cycle (if it's set to "implicit").
return comp;
}
// See if the component is inside of policy provider.
}
// FTP knows how to find component after the given. We don't.
// Null result means that we overstepped the limit of the FTP's cycle.
// In that case we must quit the cycle, otherwise return the component found.
return afterComp;
}
}
if (log.isLoggable(PlatformLogger.FINE)) log.fine("### Cycle is " + cycle + ", component is " + aComponent);
if (index < 0) {
}
return getFirstComponent(aContainer);
}
return comp;
return comp;
}
}
if (aContainer.isFocusCycleRoot()) {
this.cachedRoot = aContainer;
this.cachedCycle = cycle;
this.cachedRoot = null;
this.cachedCycle = null;
return comp;
}
return null;
}
/**
* 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.
* <p>
* 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
* <code>setImplicitDownCycleTraversal</code> method.
* <p>
* If aContainer is <a href="../../java/awt/doc-files/FocusSpec.html#FocusTraversalPolicyProviders">focus
* traversal policy provider</a>, the focus is always transferred down-cycle.
*
* @param aContainer a focus cycle root of aComponent or a focus traversal policy provider
* @param aComponent a (possibly indirect) child of aContainer, or
* aContainer itself
* @return 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 cycle
* root of aComponent or a focus traversal policy provider, or if either aContainer or
* aComponent is null
*/
throw new IllegalArgumentException("aContainer and aComponent cannot be null");
}
throw new IllegalArgumentException("aContainer should be focus cycle root or focus traversal policy provider");
throw new IllegalArgumentException("aContainer is not a focus cycle root of aComponent");
}
// See if the component is inside of policy provider.
}
// FTP knows how to find component after the given. We don't.
// Null result means that we overstepped the limit of the FTP's cycle.
// In that case we must quit the cycle, otherwise return the component found.
if (beforeComp != null) {
return beforeComp;
}
// If the provider is traversable it's returned.
if (accept(aComponent)) {
return aComponent;
}
}
if (log.isLoggable(PlatformLogger.FINE)) log.fine("### Cycle is " + cycle + ", component is " + aComponent);
if (index < 0) {
}
return getLastComponent(aContainer);
}
return tryComp;
return comp;
}
}
if (aContainer.isFocusCycleRoot()) {
this.cachedRoot = aContainer;
this.cachedCycle = cycle;
this.cachedRoot = null;
this.cachedCycle = null;
return comp;
}
return null;
}
/**
* 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.
*
* @param aContainer a focus cycle root of aComponent or a focus traversal policy provider whose
* first Component is to be returned
* @return the first Component in the traversal cycle of aContainer,
* or null if no suitable Component can be found
* @throws IllegalArgumentException if aContainer is null
*/
if (aContainer == null) {
throw new IllegalArgumentException("aContainer cannot be null");
}
if (this.cachedRoot == aContainer) {
cycle = this.cachedCycle;
} else {
}
return null;
}
return comp;
} else if (comp != aContainer &&
{
return comp;
}
}
return null;
}
/**
* 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.
*
* @param aContainer a focus cycle root of aComponent or a focus traversal policy provider whose
* last Component is to be returned
* @return the last Component in the traversal cycle of aContainer,
* or null if no suitable Component can be found
* @throws IllegalArgumentException if aContainer is null
*/
if (aContainer == null) {
throw new IllegalArgumentException("aContainer cannot be null");
}
if (this.cachedRoot == aContainer) {
cycle = this.cachedCycle;
} else {
}
return null;
}
return comp;
if (cont.isFocusTraversalPolicyProvider()) {
}
}
}
return null;
}
/**
* 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 <code>getFirstComponent</code>.
*
* @param aContainer a focus cycle root of aComponent or a focus traversal policy provider whose
* default Component is to be returned
* @return the default Component in the traversal cycle of aContainer,
* or null if no suitable Component can be found
* @see #getFirstComponent
* @throws IllegalArgumentException if aContainer is null
*/
return getFirstComponent(aContainer);
}
/**
* Sets whether this SortingFocusTraversalPolicy transfers focus down-cycle
* implicitly. If <code>true</code>, during normal focus traversal,
* the Component traversed after a focus cycle root will be the focus-
* cycle-root's default Component to focus. If <code>false</code>, 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 <code>true</code>.
*
* @param implicitDownCycleTraversal whether this
* SortingFocusTraversalPolicy transfers focus down-cycle implicitly
* @see #getImplicitDownCycleTraversal
* @see #getFirstComponent
*/
}
/**
* Returns whether this SortingFocusTraversalPolicy transfers focus down-
* cycle implicitly. If <code>true</code>, during normal focus
* traversal, the Component traversed after a focus cycle root will be the
* focus-cycle-root's default Component to focus. If <code>false</code>,
* the next Component in the focus traversal cycle rooted at the specified
* focus cycle root will be traversed instead.
*
* @return whether this SortingFocusTraversalPolicy transfers focus down-
* cycle implicitly
* @see #setImplicitDownCycleTraversal
* @see #getFirstComponent
*/
public boolean getImplicitDownCycleTraversal() {
return implicitDownCycleTraversal;
}
/**
* Sets the Comparator which will be used to sort the Components in a
* focus traversal cycle.
*
* @param comparator the Comparator which will be used for sorting
*/
this.comparator = comparator;
}
/**
* Returns the Comparator which will be used to sort the Components in a
* focus traversal cycle.
*
* @return the Comparator which will be used for sorting
*/
return comparator;
}
/**
* 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.
*
* @param aComponent the Component whose fitness as a focus owner is to
* be tested
* @return <code>true</code> if aComponent is visible, displayable,
* enabled, and focusable; <code>false</code> otherwise
*/
}
}
// Create our own subclass and change accept to public so that we can call
// accept.
{
return super.accept(aComponent);
}
}