ilog.views.chart.servlet

Class IlvDefaultChartTooltipInfoGenerator

java.lang.Object

ilog.views.chart.servlet.IlvAbstractChartHitmapInfoGenerator

ilog.views.chart.servlet.IlvAbstractChartTooltipInfoGenerator

ilog.views.chart.servlet.IlvDefaultChartTooltipInfoGenerator

All Implemented Interfaces:

IlvHitmapInfoGenerator

public class IlvDefaultChartTooltipInfoGenerator
extends IlvAbstractChartTooltipInfoGenerator

The default generator for tooltip information in a chart. It returns information for the rendering of tooltips. It is based on an instance of IlvChartHitmapDefinition.

Since:

JViews 8.8

Constructor Summary

Constructors

Constructor and Description
IlvDefaultChartTooltipInfoGenerator(IlvChartHitmapDefinition definition, IlvChartHitmap hitmap) Creates an instance, parameterized by a given IlvChartHitmapAccumulator object and bound to a given IlvChartHitmapAccumulator instance.

Method Summary

Modifier and Type	Method and Description
IlvChartHitmapDefinition	getHitmapDefinition() Returns the hitmap definition.
String	getToolTipAsHTML(int region, IlvIMapAttributes attributes) Formats the given attributes as a tooltip.

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

getRegionInfo

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

IlvDefaultChartTooltipInfoGenerator

public IlvDefaultChartTooltipInfoGenerator(IlvChartHitmapDefinition definition,
                                           IlvChartHitmap hitmap)

Creates an instance, parameterized by a given IlvChartHitmapAccumulator object and bound to a given IlvChartHitmapAccumulator instance.

Parameters:

definition - The IlvChartHitmapDefinition object.

hitmap - An already filled IlvChartHitmap.

Method Detail

getHitmapDefinition

public IlvChartHitmapDefinition getHitmapDefinition()

Returns the hitmap definition. It specifies, among other things, how to format given attributes as a tooltip.

getToolTipAsHTML

public String getToolTipAsHTML(int region,
                               IlvIMapAttributes attributes)

Formats the given attributes as a tooltip.

This method delegates to the given IlvChartHitmapDefinition instance.

Specified by:

getToolTipAsHTML in class IlvAbstractChartTooltipInfoGenerator

Parameters:

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

attributes - A specification of interactions.