bibliothek.gui.dock.focus

Class DockFocusTraversalPolicy

java.lang.Object

java.awt.FocusTraversalPolicy

bibliothek.gui.dock.focus.DockFocusTraversalPolicy

public class DockFocusTraversalPolicy
extends FocusTraversalPolicy

A FocusTraversalPolicy that uses the algorithms of a SimplifiedFocusTraversalPolicy to do its work. This policy ensures that only valid Components are selected, and it respects the constraints for nested policies.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
DockFocusTraversalPolicy(SimplifiedFocusTraversalPolicy policy, boolean circle) Creates a new policy.

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(Component component) Tells whether component can be focused or not.
protected Component	after(Component component) Searches the next Component which might gain the focus.
protected Component	before(Component component) Searches the previous Component which might gain the focus.
Component	getComponentAfter(Container container, Component component)
Component	getComponentBefore(Container container, Component component)
Component	getDefaultComponent(Container container)
Component	getFirstComponent(Container container)
protected FocusTraversalPolicy	getFocusTraversalPolicy(Container provider) Searches the FocusTraversalPolicy which should be used by provider.
Component	getLastComponent(Container container)
protected Container	getRootOrProvider(Component component) Searches the first parent of component that is either a focus cycle root or a policy provider.

Methods inherited from class java.awt.FocusTraversalPolicy

getInitialComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockFocusTraversalPolicy

public DockFocusTraversalPolicy(SimplifiedFocusTraversalPolicy policy,
                                boolean circle)

Creates a new policy.

Parameters:

policy - the delegate providing algorithms for this policy

circle - if true then this policy does not respect the exact description of the functionality of FocusTraversalPolicy in order to ensure that getComponentAfter( getComponentBefore( x )) == x and getComponentBefore( getComponentAfter( x )) == x.

Method Detail

accept

protected boolean accept(Component component)

Tells whether component can be focused or not.

Parameters:

component - some Component which might gain the focus.

Returns:

true if component is allowed to gain the focus, false otherwise

getComponentAfter

public Component getComponentAfter(Container container,
                                   Component component)

Specified by:

getComponentAfter in class FocusTraversalPolicy

after

protected Component after(Component component)

Searches the next Component which might gain the focus. This method searches recursively through the tree of Components, but does not loop.

Parameters:

component - the currently focused Component.

Returns:

the next Component which might gain the focus

getComponentBefore

public Component getComponentBefore(Container container,
                                    Component component)

Specified by:

getComponentBefore in class FocusTraversalPolicy

before

protected Component before(Component component)

Searches the previous Component which might gain the focus. This method searches recursively through the tree of Components, but does not loop.

Parameters:

component - the currently focused Component.

Returns:

the previous Component which might gain the focus

getDefaultComponent

public Component getDefaultComponent(Container container)

Specified by:

getDefaultComponent in class FocusTraversalPolicy

getFirstComponent

public Component getFirstComponent(Container container)

Specified by:

getFirstComponent in class FocusTraversalPolicy

getLastComponent

public Component getLastComponent(Container container)

Specified by:

getLastComponent in class FocusTraversalPolicy

getRootOrProvider

protected Container getRootOrProvider(Component component)

Searches the first parent of component that is either a focus cycle root or a policy provider.

Parameters:

component - some component

Returns:

some parent or null

getFocusTraversalPolicy

protected FocusTraversalPolicy getFocusTraversalPolicy(Container provider)

Searches the FocusTraversalPolicy which should be used by provider. This method searches for a focus cycle root or policy provider whose traversal policy is set.

Parameters:

provider - a focus cycle root or policy provider whose SimplifiedFocusTraversalPolicy is searched.

Returns:

the policy of provider or null