2362N/A * Copyright (c) 2000, 2003, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 2362N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 2362N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2362N/A * or visit www.oracle.com if you need additional information or have any 0N/A * A FocusTraversalPolicy that determines traversal order based on the order 0N/A * of child Components in a Container. From a particular focus cycle root, the 0N/A * policy makes a pre-order traversal of the Component hierarchy, and traverses 0N/A * a Container's children according to the ordering of the array returned by 0N/A * <code>Container.getComponents()</code>. Portions of the hierarchy that are 0N/A * not visible and displayable will not be searched. 0N/A * By default, ContainerOrderFocusTraversalPolicy implicitly transfers focus 0N/A * down-cycle. That is, during normal forward focus traversal, the Component 0N/A * traversed after a focus cycle root will be the focus-cycle-root's default 0N/A * Component to focus. This behavior can be disabled using the 0N/A * <code>setImplicitDownCycleTraversal</code> method. 0N/A * By default, methods of this class with return a Component only if it is 0N/A * visible, displayable, enabled, and focusable. Subclasses can modify this 0N/A * behavior by overriding the <code>accept</code> method. 0N/A * This policy takes into account <a 0N/A * if a focus traversal policy provider is encountered, its focus traversal 0N/A * policy is used to perform the search operation. 0N/A * @author David Mendenhall 0N/A * @see Container#getComponents 0N/A * JDK 1.4 serialVersionUID 0N/A * Used by getComponentAfter and getComponentBefore for efficiency. In 0N/A * order to maintain compliance with the specification of 0N/A * FocusTraversalPolicy, if traversal wraps, we should invoke 0N/A * getFirstComponent or getLastComponent. These methods may be overriden in 0N/A * subclasses to behave in a non-generic way. However, in the generic case, 0N/A * these methods will simply return the first or last Components of the 0N/A * sorted list, respectively. Since getComponentAfter and 0N/A * getComponentBefore have already built the list before determining 0N/A * that they need to invoke getFirstComponent or getLastComponent, the 0N/A * list should be reused if possible. 0N/A * We suppose to use getFocusTraversalCycle & getComponentIndex methods in order 0N/A * to divide the policy into two parts: 0N/A * 1) Making the focus traversal cycle. 0N/A * 2) Traversing the cycle. 0N/A * The 1st point assumes producing a list of components representing the focus 0N/A * traversal cycle. The two methods mentioned above should implement this logic. 0N/A * The 2nd point assumes implementing the common concepts of operating on the 0N/A * component. These concepts are described in the AWT Focus Spec and they are 0N/A * applied to the FocusTraversalPolicy in general. 0N/A * Thus, a descendant of this policy may wish to not reimplement the logic of 0N/A * the 2nd point but just override the implementation of the 1st one. 0N/A * A striking example of such a descendant is the javax.swing.SortingFocusTraversalPolicy. 0N/A * Checks if a new focus cycle takes place and returns a Component to traverse focus to. 0N/A * @param comp a possible focus cycle root or policy provider 0N/A * @param traversalDirection the direction of the traversal 0N/A * @return a Component to traverse focus to if {@code comp} is a root or provider 0N/A * and implicit down-cycle is set, otherwise {@code null} 0N/A " in the focus cycle root " +
cont);
0N/A * Returns the Component that should receive the focus after aComponent. 0N/A * aContainer must be a focus cycle root of aComponent or a focus traversal policy provider. 0N/A * By default, ContainerOrderFocusTraversalPolicy implicitly transfers 0N/A * focus down-cycle. That is, during normal forward focus traversal, the 0N/A * Component traversed after a focus cycle root will be the focus-cycle- 0N/A * root's default Component to focus. This behavior can be disabled using 0N/A * the <code>setImplicitDownCycleTraversal</code> method. 0N/A * traversal policy provider</a>, the focus is always transferred down-cycle. 0N/A * @param aContainer a focus cycle root of aComponent or a focus traversal policy provider 0N/A * @param aComponent a (possibly indirect) child of aContainer, or 0N/A * @return the Component that should receive the focus after aComponent, or 0N/A * null if no suitable Component can be found 0N/A * @throws IllegalArgumentException if aContainer is not a focus cycle 0N/A * root of aComponent or focus traversal policy provider, or if either aContainer or 0N/A * aComponent is null 0N/A // Before all the ckecks below we first see if it's an FTP provider or a focus cycle root. 0N/A // If it's the case just go down cycle (if it's set to "implicit"). 0N/A // See if the component is inside of policy provider. 0N/A // FTP knows how to find component after the given. We don't. 0N/A // Null result means that we overstepped the limit of the FTP's cycle. 0N/A // In that case we must quit the cycle, otherwise return the component found. 0N/A * Returns the Component that should receive the focus before aComponent. 0N/A * aContainer must be a focus cycle root of aComponent or a <a 0N/A * @param aContainer a focus cycle root of aComponent or focus traversal policy provider 0N/A * @param aComponent a (possibly indirect) child of aContainer, or 0N/A * @return the Component that should receive the focus before aComponent, 0N/A * or null if no suitable Component can be found 0N/A * @throws IllegalArgumentException if aContainer is not a focus cycle 0N/A * root of aComponent or focus traversal policy provider, or if either aContainer or 0N/A * aComponent is null 0N/A // See if the component is inside of policy provider. 0N/A // FTP knows how to find component after the given. We don't. 0N/A // Null result means that we overstepped the limit of the FTP's cycle. 0N/A // In that case we must quit the cycle, otherwise return the component found. 0N/A // If the provider is traversable it's returned. 0N/A * Returns the first Component in the traversal cycle. This method is used 0N/A * to determine the next Component to focus when traversal wraps in the 0N/A * forward direction. 0N/A * @param aContainer the focus cycle root or focus traversal policy provider whose first 0N/A * Component is to be returned 0N/A * @return the first Component in the traversal cycle of aContainer, 0N/A * or null if no suitable Component can be found 0N/A * @throws IllegalArgumentException if aContainer is null 0N/A * Returns the last Component in the traversal cycle. This method is used 0N/A * to determine the next Component to focus when traversal wraps in the 0N/A * reverse direction. 0N/A * @param aContainer the focus cycle root or focus traversal policy provider whose last 0N/A * Component is to be returned 0N/A * @return the last Component in the traversal cycle of aContainer, 0N/A * or null if no suitable Component can be found 0N/A * @throws IllegalArgumentException if aContainer is null 0N/A * Returns the default Component to focus. This Component will be the first 0N/A * to receive focus when traversing down into a new focus traversal cycle 0N/A * rooted at aContainer. The default implementation of this method 0N/A * returns the same Component as <code>getFirstComponent</code>. 0N/A * @param aContainer the focus cycle root or focus traversal policy provider whose default 0N/A * Component is to be returned 0N/A * @return the default Component in the traversal cycle of aContainer, 0N/A * or null if no suitable Component can be found 0N/A * @see #getFirstComponent 0N/A * @throws IllegalArgumentException if aContainer is null 0N/A * Sets whether this ContainerOrderFocusTraversalPolicy transfers focus 0N/A * down-cycle implicitly. If <code>true</code>, during normal forward focus 0N/A * traversal, the Component traversed after a focus cycle root will be the 0N/A * focus-cycle-root's default Component to focus. If <code>false</code>, 0N/A * the next Component in the focus traversal cycle rooted at the specified 0N/A * focus cycle root will be traversed instead. The default value for this 0N/A * property is <code>true</code>. 0N/A * @param implicitDownCycleTraversal whether this 0N/A * ContainerOrderFocusTraversalPolicy transfers focus down-cycle 0N/A * @see #getImplicitDownCycleTraversal 0N/A * @see #getFirstComponent 0N/A * Returns whether this ContainerOrderFocusTraversalPolicy transfers focus 0N/A * down-cycle implicitly. If <code>true</code>, during normal forward focus 0N/A * traversal, the Component traversed after a focus cycle root will be the 0N/A * focus-cycle-root's default Component to focus. If <code>false</code>, 0N/A * the next Component in the focus traversal cycle rooted at the specified 0N/A * focus cycle root will be traversed instead. 0N/A * @return whether this ContainerOrderFocusTraversalPolicy transfers focus 0N/A * down-cycle implicitly 0N/A * @see #setImplicitDownCycleTraversal 0N/A * @see #getFirstComponent 0N/A * Determines whether a Component is an acceptable choice as the new 0N/A * focus owner. By default, this method will accept a Component if and 0N/A * only if it is visible, displayable, enabled, and focusable. 0N/A * @param aComponent the Component whose fitness as a focus owner is to 0N/A * @return <code>true</code> if aComponent is visible, displayable, 0N/A * enabled, and focusable; <code>false</code> otherwise 0N/A // Verify that the Component is recursively enabled. Disabling a 0N/A // heavyweight Container disables its children, whereas disabling 0N/A // a lightweight Container does not.