ilog.views.util.hitmap

Class IlvNavigationInfo

java.lang.Object

ilog.views.util.hitmap.IlvNavigationInfo

public class IlvNavigationInfo
extends Object

This class encodes how the keyboard navigation within a component will react when a certain region (such as a graphic object) has the focus and the user presses one of the four arrow keys (up, down, left, right arrows).

Regions are encoded as positive integers according to a hitmap. The integer 0 means "no effect".

Since:

JViews 8.8

See Also:

IlvHitmapConstants.NAVIGATION_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
int	downTarget The new focused region after the user presses the down-arrow key, or 0 if that key has no effect.
int	leftTarget The new focused region after the user presses the left-arrow key, or 0 if that key has no effect.
int	rightTarget The new focused region after the user presses the right-arrow key, or 0 if that key has no effect.
int	upTarget The new focused region after the user presses the up-arrow key, or 0 if that key has no effect.

Constructor Summary

Constructors

Constructor and Description
IlvNavigationInfo(int prevTarget, int nextTarget) Creates a keyboard navigation info that encodes the targets for the up-arrow key (acting as "previous item") and the down-arrow key (acting as "next item").
IlvNavigationInfo(int upTarget, int downTarget, int leftTarget, int rightTarget) Creates a keyboard navigation info that encodes the targets for all four arrow keys.

Method Summary

Modifier and Type	Method and Description
String	toString() Converts this navigation info to the form that can be used in the hitmap info.

Methods inherited from class java.lang.Object

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

Field Detail

upTarget

public int upTarget

The new focused region after the user presses the up-arrow key, or 0 if that key has no effect.

downTarget

public int downTarget

The new focused region after the user presses the down-arrow key, or 0 if that key has no effect.

leftTarget

public int leftTarget

The new focused region after the user presses the left-arrow key, or 0 if that key has no effect.

rightTarget

public int rightTarget

The new focused region after the user presses the right-arrow key, or 0 if that key has no effect.

Constructor Detail

IlvNavigationInfo

public IlvNavigationInfo(int prevTarget,
                         int nextTarget)

Creates a keyboard navigation info that encodes the targets for the up-arrow key (acting as "previous item") and the down-arrow key (acting as "next item").

Parameters:

prevTarget - The new focused region after the user presses the up-arrow key, or 0 if that key has no effect.

nextTarget - The new focused region after the user presses the down-arrow key, or 0 if that key has no effect.

IlvNavigationInfo

public IlvNavigationInfo(int upTarget,
                         int downTarget,
                         int leftTarget,
                         int rightTarget)

Creates a keyboard navigation info that encodes the targets for all four arrow keys.

Parameters:

upTarget - The new focused region after the user presses the up-arrow key, or 0 if that key has no effect.

downTarget - The new focused region after the user presses the down-arrow key, or 0 if that key has no effect.

leftTarget - The new focused region after the user presses the left-arrow key, or 0 if that key has no effect.

rightTarget - The new focused region after the user presses the right-arrow key, or 0 if that key has no effect.

Method Detail

toString

public String toString()

Converts this navigation info to the form that can be used in the hitmap info.

Overrides:

toString in class Object

Returns:

A string of the form "[u,d,l,r]".