org.tentackle.swing

Class FormFocusTraversalPolicy

java.lang.Object

java.awt.FocusTraversalPolicy

javax.swing.InternalFrameFocusTraversalPolicy

javax.swing.SortingFocusTraversalPolicy

org.tentackle.swing.FormFocusTraversalPolicy

public class FormFocusTraversalPolicy
extends SortingFocusTraversalPolicy

Keyboard focus traversal policy for Tentackle forms.

Code mostly copied from LayoutFocusTraversalPolicy because of package-scope constructor. Extended to focus only on Tentackle-components, provide form wrap events and support for FocusTraversalGroups.

Author:

harald

Constructor Summary

Constructors

Constructor and Description
FormFocusTraversalPolicy() Creates the default layout policy.
FormFocusTraversalPolicy(Comparator<? super Component> layoutComparator) Creates a traversal policy for a given comparator.

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(Component component) Determines whether the specified Component is an acceptable choice as the new focus owner.
Component	getComponentAfter(Container container, Component component) Returns the Component that should receive the focus after component.
Component	getComponentBefore(Container container, Component component) Returns the Component that should receive the focus before component.
Component	getFirstComponent(Container container) Returns the first Component in the traversal cycle.
Component	getLastComponent(Container container) Returns the last Component in the traversal cycle.

Methods inherited from class javax.swing.SortingFocusTraversalPolicy

getComparator, getDefaultComponent, getImplicitDownCycleTraversal, setComparator, setImplicitDownCycleTraversal

Methods inherited from class javax.swing.InternalFrameFocusTraversalPolicy

getInitialComponent

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

FormFocusTraversalPolicy

public FormFocusTraversalPolicy(Comparator<? super Component> layoutComparator)

Creates a traversal policy for a given comparator.

Parameters:

layoutComparator - the layout comparator

FormFocusTraversalPolicy

public FormFocusTraversalPolicy()

Creates the default layout policy.

See Also:

FormLayoutComparator

Method Detail

accept

protected boolean accept(Component component)

Determines whether the specified Component is an acceptable choice as the new focus owner. This method performs the following sequence of operations:

1. Checks whether component is visible, displayable, enabled, and focusable. If any of these properties is false, this method returns false.
2. If component is an instance of JTable, returns true.
3. If component is an instance of JComboBox, then returns the value of component.getUI().isFocusTraversable(component).
4. If component is a JComponent with a JComponent.WHEN_FOCUSED InputMap that is neither null nor empty, returns true.
5. Returns the value of DefaultFocusTraversalPolicy.accept(component).

Overrides:

accept in class SortingFocusTraversalPolicy

Parameters:

component - the Component whose fitness as a focus owner is to be tested

Returns:

true if component is a valid choice for a focus owner; otherwise false

Overridden to accept only FormComponents, FormButtons, FormTables and JPasswordFields

See Also:

Component.isVisible(), Component.isDisplayable(), Component.isEnabled(), Component.isFocusable(), ComboBoxUI.isFocusTraversable(javax.swing.JComboBox), JComponent.getInputMap(int), DefaultFocusTraversalPolicy.accept(java.awt.Component)

getComponentAfter

public Component getComponentAfter(Container container,
                                   Component component)

Returns the Component that should receive the focus after component. container must be a focus cycle root of component.

By default, FormFocusTraversalPolicy 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 container is focus traversal policy provider, the focus is always transferred down-cycle.

Overrides:

getComponentAfter in class SortingFocusTraversalPolicy

Parameters:

container - a focus cycle root of component or a focus traversal policy provider

component - a (possibly indirect) child of container, or container itself

Returns:

the Component that should receive the focus after component, or null if no suitable Component can be found

Throws:

IllegalArgumentException - if container is not a focus cycle root of component or a focus traversal policy provider, or if either container or component is null

getComponentBefore

public Component getComponentBefore(Container container,
                                    Component component)

Returns the Component that should receive the focus before component. container must be a focus cycle root of component.

By default, LayoutFocusTraversalPolicy 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 container is focus traversal policy provider, the focus is always transferred down-cycle.

Overrides:

getComponentBefore in class SortingFocusTraversalPolicy

Parameters:

container - a focus cycle root of component or a focus traversal policy provider

component - a (possibly indirect) child of container, or container itself

Returns:

the Component that should receive the focus before component, or null if no suitable Component can be found

Throws:

IllegalArgumentException - if container is not a focus cycle root of component or a focus traversal policy provider, or if either container or component is null

getFirstComponent

public Component getFirstComponent(Container container)

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.

Overrides:

getFirstComponent in class SortingFocusTraversalPolicy

Parameters:

container - a focus cycle root of component or a focus traversal policy provider whose first Component is to be returned

Returns:

the first Component in the traversal cycle of container, or null if no suitable Component can be found

Throws:

IllegalArgumentException - if container is null

getLastComponent

public Component getLastComponent(Container container)

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.

Overrides:

getLastComponent in class SortingFocusTraversalPolicy

Parameters:

container - a focus cycle root of component or a focus traversal policy provider whose last Component is to be returned

Returns:

the last Component in the traversal cycle of container, or null if no suitable Component can be found

Throws:

IllegalArgumentException - if container is null