edu.wisc.ssec.mcidasv.util

Class FocusTraveller

java.lang.Object

java.awt.FocusTraversalPolicy

edu.wisc.ssec.mcidasv.util.FocusTraveller

public class FocusTraveller
extends java.awt.FocusTraversalPolicy

Abstraction of FocusTraversalPolicy that allows for easy creation of the traversal policy.

Note that the "delta" parameter of both cycle(Component, int) and indexCycle(int, int) can be any positive or negative integer. Both methods compute indices using the wonders of modular arithmetic.

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.Component[]	components Components to traverse, stored in the desired traversal order.

Constructor Summary

Constructors

Constructor and Description
FocusTraveller(java.util.Collection<java.awt.Component> componentsToTraverse) Creates the FocusTraversalPolicy for the given components.
FocusTraveller(java.awt.Component... componentsToTraverse) Creates the FocusTraversalPolicy.

Method Summary

Modifier and Type	Method and Description
private java.awt.Component	cycle(java.awt.Component currentComponent, int delta) Cycles through components.
java.awt.Component	getComponentAfter(java.awt.Container container, java.awt.Component component) Gets the next component after component.
java.awt.Component	getComponentBefore(java.awt.Container container, java.awt.Component component) Gets the component before component.
java.awt.Component	getDefaultComponent(java.awt.Container container) Not used.
java.awt.Component	getFirstComponent(java.awt.Container container) Gets the first component.
java.awt.Component	getLastComponent(java.awt.Container container) Gets the last component.
private int	indexCycle(int index, int delta) Cycles through valid index values.

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

Field Detail

components

private final java.awt.Component[] components

Components to traverse, stored in the desired traversal order.

Constructor Detail

FocusTraveller

public FocusTraveller(java.awt.Component... componentsToTraverse)

Creates the FocusTraversalPolicy.

Parameters:

componentsToTraverse - Components to traverse, in the desired order. Cannot be null.

FocusTraveller

public FocusTraveller(java.util.Collection<java.awt.Component> componentsToTraverse)

Creates the FocusTraversalPolicy for the given components.

Parameters:

componentsToTraverse - Components to traverse. Cannot be null.

Method Detail

indexCycle

private int indexCycle(int index,
                       int delta)

Cycles through valid index values.

Parameters:

index - Current index.

delta - Index of next component, relative to index.

Returns:

Next index value.

cycle

private java.awt.Component cycle(java.awt.Component currentComponent,
                                 int delta)

Cycles through components.

Parameters:

currentComponent - Cannot be null.

delta - Index of next component, relative to currentComponent.

Returns:

The "next" component in the traversal order.

getComponentAfter

public java.awt.Component getComponentAfter(java.awt.Container container,
                                            java.awt.Component component)

Gets the next component after component.

Specified by:

getComponentAfter in class java.awt.FocusTraversalPolicy

Parameters:

container - Ignored.

component - Cannot be null.

Returns:

Next component after component.

getComponentBefore

public java.awt.Component getComponentBefore(java.awt.Container container,
                                             java.awt.Component component)

Gets the component before component.

Specified by:

getComponentBefore in class java.awt.FocusTraversalPolicy

Parameters:

container - Ignored.

component - Cannot be null.

Returns:

The Component before component in traversal order.

getFirstComponent

public java.awt.Component getFirstComponent(java.awt.Container container)

Gets the first component.

Specified by:

getFirstComponent in class java.awt.FocusTraversalPolicy

Parameters:

container - Ignored.

Returns:

The first Component in traversal order.

getLastComponent

public java.awt.Component getLastComponent(java.awt.Container container)

Gets the last component.

Specified by:

getLastComponent in class java.awt.FocusTraversalPolicy

Parameters:

container - Ignored.

Returns:

The last Component in traversal order.

getDefaultComponent

public java.awt.Component getDefaultComponent(java.awt.Container container)

Not used. See getFirstComponent(Container).

Specified by:

getDefaultComponent in class java.awt.FocusTraversalPolicy

Parameters:

container - Ignored.

Returns:

The first Component in traversal order.