ilog.views.chart.servlet

Class IlvAbstractChartNavigationInfoGenerator

java.lang.Object

ilog.views.chart.servlet.IlvAbstractChartHitmapInfoGenerator

ilog.views.chart.servlet.IlvAbstractChartNavigationInfoGenerator

All Implemented Interfaces:

IlvHitmapInfoGenerator

Direct Known Subclasses:

IlvDefaultChartNavigationInfoGenerator

public abstract class IlvAbstractChartNavigationInfoGenerator
extends IlvAbstractChartHitmapInfoGenerator

A specialized class of hitmap information generator. It returns information for keyboard navigation among the elements of a chart.

Since:

JViews 8.8

See Also:

IlvHitmapConstants.NAVIGATION_TYPE

Constructor Summary

Constructors

Constructor and Description
IlvAbstractChartNavigationInfoGenerator(IlvChartHitmap hitmap) Creates an instance, bound to a given hitmap.

Method Summary

Modifier and Type	Method and Description
abstract IlvNavigationInfo	getNavigationInfo(int region, IlvChartAreaAccessible element) Returns the navigation information for the given region.
protected String	getRegionInfo(int region, String infoType) Gets the individual information for a region.

Methods inherited from class ilog.views.chart.servlet.IlvAbstractChartHitmapInfoGenerator

buildInformation, getHitmap

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvAbstractChartNavigationInfoGenerator

public IlvAbstractChartNavigationInfoGenerator(IlvChartHitmap hitmap)

Creates an instance, bound to a given hitmap.

Parameters:

hitmap - An already filled IlvChartHitmap.

Method Detail

getRegionInfo

protected String getRegionInfo(int region,
                               String infoType)

Gets the individual information for a region.

Specified by:

getRegionInfo in class IlvAbstractChartHitmapInfoGenerator

Parameters:

region - The index denoting a region, an integer in the range 1 .. hitmap.getRegionsCount().

infoType - the hitmap information type.

Returns:

the information for the region

getNavigationInfo

public abstract IlvNavigationInfo getNavigationInfo(int region,
                                                    IlvChartAreaAccessible element)

Returns the navigation information for the given region. This is an object of the form {u,d,l,r} where each of u, d, l, r is either the index of a region (a positive integer) or 0. The u field denotes the new focused region after the user presses the up-arrow key. The d field denotes the new focused region after the user presses the down-arrow key. The l field denotes the new focused region after the user presses the left-arrow key. The r field denotes the new focused region after the user presses the right-arrow key.

Parameters:

region - The index denoting a region, an integer in the range 1 .. hitmap.getRegionsCount().

element - The chart area element that is associated to the region, or null if none.

Returns:

A keyboard navigation info.