ilog.views.chart.servlet

Class IlvChartHitmap

java.lang.Object

ilog.views.chart.servlet.IlvChartHitmap

Direct Known Subclasses:

IlvChartHitmapAccumulator

public abstract class IlvChartHitmap
extends Object

This class contains a hitmap, plus hitmap info for the tooltip interactor. Hitmap info for other purposes (highlighting, keyboard navigation, cursor, etc.) can be associated to the regions in this class; but this info is not stored in this class.

You are not supposed to invoke the methods in this class directly.

Since:

JViews 8.8

See Also:

IlvChartServletSupport.HITMAP_REQUEST

Field Summary

Fields

Modifier and Type	Field and Description
static String	JViewsExtensions Deprecated.
static String	JViewsToolTips Deprecated.

Constructor Summary

Constructors

Constructor and Description
IlvChartHitmap()

Method Summary

Modifier and Type	Method and Description
abstract IlvChartAreaAccessible	getElementOfRegion(int region) Returns the chart area element that is associated to a given region.
String	getExtensions() Deprecated. This method is internal.
abstract int[]	getGroupedRegions(int region) For a group region, returns the regions that are part of the group.
abstract IlvIMapAttributes	getRegionAttributes(int region) Returns the interactive effects that are associated to a given region.
abstract int	getRegionOfElement(IlvChartAreaAccessible element) Returns the index denoting the region that is associated with a given chart area element.
abstract int	getRegionsCount() Returns the number of hitmap regions.
String	getToolTips(IlvChartHitmapDefinition definition) Deprecated. Replaced by IlvAbstractChartHitmapInfoGenerator.buildInformation(String)

Methods inherited from class java.lang.Object

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

Field Detail

JViewsToolTips

@Deprecated
public static final String JViewsToolTips

Deprecated.

The string used to identify the tooltip data sent to the clients.

See Also:

Constant Field Values

JViewsExtensions

@Deprecated
public static final String JViewsExtensions

Deprecated.

The string used to identify the extensions for tooltip interactor.

See Also:

Constant Field Values

Constructor Detail

IlvChartHitmap

public IlvChartHitmap()

Method Detail

getRegionsCount

public abstract int getRegionsCount()

Returns the number of hitmap regions.

getGroupedRegions

public abstract int[] getGroupedRegions(int region)

For a group region, returns the regions that are part of the group. Such regions are highlighted together with the group region.

Parameters:

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

Returns:

A non-empty array of region indices, or null for none.

getElementOfRegion

public abstract IlvChartAreaAccessible getElementOfRegion(int region)

Returns the chart area element that is associated to a given region.

Parameters:

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

Returns:

A chart area element or null.

getRegionOfElement

public abstract int getRegionOfElement(IlvChartAreaAccessible element)

Returns the index denoting the region that is associated with a given chart area element.

Parameters:

element - A chart area element.

Returns:

An index denoting a region (a positive integer), or 0 for none.

getRegionAttributes

public abstract IlvIMapAttributes getRegionAttributes(int region)

Returns the interactive effects that are associated to a given region.

Parameters:

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

Returns:

Its attributes for interactive effects.

getToolTips

@Deprecated
public final String getToolTips(IlvChartHitmapDefinition definition)

Deprecated. Replaced by IlvAbstractChartHitmapInfoGenerator.buildInformation(String)

Renders the tooltips of the entire view. The return format is like this:

    jviews_tooltips=[
    "Tooltip for the 1st region.",
    "Tooltip for the 2nd region.",
    "Tooltip for the 3rd region in HTML format."];
 

As you can see, the HTML format is supported.

Returns:

The tooltips for the entire view.

getExtensions

@Deprecated
public final String getExtensions()

Deprecated. This method is internal.

Gets the extensions for tooltip interactor.

Returns:

the extensions.