Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt

Class ContainerOrderFocusTraversalPolicy

Implemented Interfaces:
Serializable
Known Direct Subclasses:
DefaultFocusTraversalPolicy
public class ContainerOrderFocusTraversalPolicy
extends FocusTraversalPolicy
implements Serializable
ContainerOrderFocusTraversalPolicy defines a focus traversal order based on the order in which Components were packed in a Container. This policy performs a pre-order traversal of the Component hierarchy starting from a given focus cycle root. Portions of the hierarchy that are not visible and displayable are skipped. By default, this policy transfers focus down-cycle implicitly. That is, if a forward traversal is requested on a focus cycle root and the focus cycle root has focusable children, the focus will automatically be transfered down to the lower focus cycle. The default implementation of accept accepts only Components that are visible, displayable, enabled and focusable. Derived classes can override these acceptance criteria by overriding accept.
Since:
1.4
See Also:
Serialized Form

Constructor Summary

ContainerOrderFocusTraversalPolicy()
Creates the ContainerOrderFocusTraversalPolicy object.

Method Summary

protected boolean
accept(Component current)
Check whether the given Component is an acceptable target for the keyboard input focus.
Component
getComponentAfter(Container root, Component current)
Returns the Component that should receive the focus after current.
Component
getComponentBefore(Container root, Component current)
Returns the Component that should receive the focus before current.
Component
getDefaultComponent(Container root)
Returns the default Component of root that should receive the focus.
Component
getFirstComponent(Container root)
Returns the first Component of root that should receive the focus.
boolean
getImplicitDownCycleTraversal()
Check whether or not implicit down cycling is enabled.
Component
getLastComponent(Container root)
Returns the last Component of root that should receive the focus.
void
setImplicitDownCycleTraversal(boolean value)
Set whether or not implicit down cycling is enabled.

Methods inherited from class java.awt.FocusTraversalPolicy

getComponentAfter, getComponentBefore, getDefaultComponent, getFirstComponent, getInitialComponent, getLastComponent

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContainerOrderFocusTraversalPolicy

public ContainerOrderFocusTraversalPolicy()
Creates the ContainerOrderFocusTraversalPolicy object.

Method Details

accept

protected boolean accept(Component current)
Check whether the given Component is an acceptable target for the keyboard input focus.
Parameters:
current - the Component to check
Returns:
true if current is acceptable, false otherwise

getComponentAfter

public Component getComponentAfter(Container root,
                                   Component current)
Returns the Component that should receive the focus after current. root must be a focus cycle root of current.
Overrides:
getComponentAfter in interface FocusTraversalPolicy
Parameters:
root - a focus cycle root of current
current - a (possibly indirect) child of root, or root itself
Returns:
the next Component in the focus traversal order for root, or null if no acceptable Component exists.
Throws:
IllegalArgumentException - If root is not a focus cycle root of current, or if either root or current is null.

getComponentBefore

public Component getComponentBefore(Container root,
                                    Component current)
Returns the Component that should receive the focus before current. root must be a focus cycle root of current.
Overrides:
getComponentBefore in interface FocusTraversalPolicy
Parameters:
root - a focus cycle root of current
current - a (possibly indirect) child of root, or root itself
Returns:
the previous Component in the focus traversal order for root, or null if no acceptable Component exists.
Throws:
IllegalArgumentException - If root is not a focus cycle root of current, or if either root or current is null.

getDefaultComponent

public Component getDefaultComponent(Container root)
Returns the default Component of root that should receive the focus.
Overrides:
getDefaultComponent in interface FocusTraversalPolicy
Parameters:
root - a focus cycle root
Returns:
the default Component in the focus traversal order for root, or null if no acceptable Component exists.
Throws:
IllegalArgumentException - If root is null.

getFirstComponent

public Component getFirstComponent(Container root)
Returns the first Component of root that should receive the focus.
Overrides:
getFirstComponent in interface FocusTraversalPolicy
Parameters:
root - a focus cycle root
Returns:
the first Component in the focus traversal order for root, or null if no acceptable Component exists.
Throws:
IllegalArgumentException - If root is null.

getImplicitDownCycleTraversal

public boolean getImplicitDownCycleTraversal()
Check whether or not implicit down cycling is enabled. If it is, then initiating a forward focus traversal operation onto a focus cycle root, the focus will be implicitly transferred into the root container's focus cycle.
Returns:
true if the focus will be transferred down-cycle implicitly

getLastComponent

public Component getLastComponent(Container root)
Returns the last Component of root that should receive the focus.
Overrides:
getLastComponent in interface FocusTraversalPolicy
Parameters:
root - a focus cycle root
Returns:
the last Component in the focus traversal order for root, or null if no acceptable Component exists.
Throws:
IllegalArgumentException - If root is null.

setImplicitDownCycleTraversal

public void setImplicitDownCycleTraversal(boolean value)
Set whether or not implicit down cycling is enabled. If it is, then initiating a forward focus traversal operation onto a focus cycle root, the focus will be implicitly transferred into the root container's focus cycle.
Parameters:
value - the setting for implicit down cycling
ContainerOrderFocusTraversalPolicy.java -- Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About