ilog.views.chart.servlet

Class IlvDefaultChartHitmapDefinition

java.lang.Object

ilog.views.chart.servlet.IlvChartHitmapDefinition

ilog.views.chart.servlet.IlvDefaultChartHitmapDefinition

public class IlvDefaultChartHitmapDefinition
extends IlvChartHitmapDefinition

This class defines a default way for constructing a hitmap and the hitmap infos of a chart.

You can create subclasses of this class in order to customize the interactive effects on a chart, like tooltips, highlights or other effects in the browser.

Since:

JViews 8.7

Constructor Summary

Constructors

Constructor and Description
IlvDefaultChartHitmapDefinition()

Method Summary

Modifier and Type	Method and Description
IlvHitmapInfoGenerator	createHitmapInfoGenerator(String infoType, IlvChartHitmap hitmap) Creates a IlvHitmapInfoGenerator instance according to the hitmap information type.
void	drawIntoHitmap(IlvChart chart, IlvChartHitmapAccumulator accumulator) Draws interactive effects for the entire chart into the hitmap.
void	drawIntoHitmap(IlvChart chart, IlvChartRenderer renderer, IlvChartHitmapAccumulator accumulator) Draws interactive effects for a given renderer into the hitmap.
void	drawIntoHitmap(IlvChart chart, IlvScale scale, IlvChartHitmapAccumulator accumulator) Draws interactive effects for a given scale into the hitmap.
void	drawIntoHitmap(IlvLegend legend, IlvChartHitmapAccumulator accumulator) Draws interactive effects for the legend into the hitmap.
IlvIMapAttributes	getAttributes(IlvChart chart, IlvScale scale) Returns the interactive effects attributes for the given scale.
IlvIMapAttributes	getAttributes(IlvChart chart, IlvSingleChartRenderer renderer, IlvDataSet ds) Returns the interactive effects attributes for a series of data points in the given data set.
IlvIMapAttributes	getAttributes(IlvChart chart, IlvSingleChartRenderer renderer, IlvDataSetPoint dp) Returns the interactive effects attributes for the specified data point.
IlvIMapAttributes	getAttributes(IlvChart chart, IlvTreemapChartRenderer renderer, IlvTreeListModel model, TreePath path) Returns the interactive effects attributes for the specified tree model element.
IlvIMapAttributes	getAttributes(IlvLegendItem item) Returns the interactive effects attributes for the specified legend item.
String	getToolTipAsHTML(IlvIMapAttributes attributes) Formats the given attributes as a tooltip.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultChartHitmapDefinition

public IlvDefaultChartHitmapDefinition()

Method Detail

drawIntoHitmap

public void drawIntoHitmap(IlvChart chart,
                           IlvChartHitmapAccumulator accumulator)

Draws interactive effects for the entire chart into the hitmap.

The default implementation iterates over the renderers of the given chart.

Specified by:

drawIntoHitmap in class IlvChartHitmapDefinition

drawIntoHitmap

public void drawIntoHitmap(IlvChart chart,
                           IlvScale scale,
                           IlvChartHitmapAccumulator accumulator)

Draws interactive effects for a given scale into the hitmap.

The default implementation invokes IlvScale.drawIntoHitmap(IlvChartHitmapDefinition, IlvChartHitmapAccumulator). The default behavior is that the scale of the chart will be highlighted. In case you do not want to highlight the scale, you can override this method.

Specified by:

drawIntoHitmap in class IlvChartHitmapDefinition

Parameters:

chart - A chart.

scale - A scale of this chart.

accumulator - The object that accumulates objects in the hitmap.

Since:

JViews 8.8

drawIntoHitmap

public void drawIntoHitmap(IlvChart chart,
                           IlvChartRenderer renderer,
                           IlvChartHitmapAccumulator accumulator)

Draws interactive effects for a given renderer into the hitmap.

The default implementation invokes IlvChartRenderer.drawIntoHitmap(IlvChartHitmapDefinition, IlvChartHitmapAccumulator).

Specified by:

drawIntoHitmap in class IlvChartHitmapDefinition

Parameters:

chart - A chart.

renderer - A renderer that is attached to this chart.

accumulator - The object that accumulates objects in the hitmap.

getAttributes

public IlvIMapAttributes getAttributes(IlvChart chart,
                                       IlvScale scale)

Returns the interactive effects attributes for the given scale.

Specified by:

getAttributes in class IlvChartHitmapDefinition

Since:

JViews 8.8

getAttributes

public IlvIMapAttributes getAttributes(IlvChart chart,
                                       IlvSingleChartRenderer renderer,
                                       IlvDataSet ds)

Returns the interactive effects attributes for a series of data points in the given data set.

Specified by:

getAttributes in class IlvChartHitmapDefinition

Since:

JViews 8.8

getAttributes

public IlvIMapAttributes getAttributes(IlvChart chart,
                                       IlvSingleChartRenderer renderer,
                                       IlvDataSetPoint dp)

Returns the interactive effects attributes for the specified data point.

Specified by:

getAttributes in class IlvChartHitmapDefinition

getAttributes

public IlvIMapAttributes getAttributes(IlvChart chart,
                                       IlvTreemapChartRenderer renderer,
                                       IlvTreeListModel model,
                                       TreePath path)

Returns the interactive effects attributes for the specified tree model element.

Specified by:

getAttributes in class IlvChartHitmapDefinition

Parameters:

chart - The chart

renderer - the tree map chart renderer

model - Tree model.

path - A tree path starting at the tree model root and ending at the specific tree model node.

Returns:

a IlvIMapAttributes instance.

drawIntoHitmap

public void drawIntoHitmap(IlvLegend legend,
                           IlvChartHitmapAccumulator accumulator)

Draws interactive effects for the legend into the hitmap.

The default implementation invokes IlvLegend.drawIntoHitmap(IlvChartHitmapDefinition, IlvChartHitmapAccumulator).

Specified by:

drawIntoHitmap in class IlvChartHitmapDefinition

Parameters:

legend - The legend of a chart.

accumulator - The object that accumulates objects in the hitmap.

getAttributes

public IlvIMapAttributes getAttributes(IlvLegendItem item)

Returns the interactive effects attributes for the specified legend item.

Specified by:

getAttributes in class IlvChartHitmapDefinition

getToolTipAsHTML

public String getToolTipAsHTML(IlvIMapAttributes attributes)

Formats the given attributes as a tooltip.

Specified by:

getToolTipAsHTML in class IlvChartHitmapDefinition

createHitmapInfoGenerator

public IlvHitmapInfoGenerator createHitmapInfoGenerator(String infoType,
                                                        IlvChartHitmap hitmap)

Creates a IlvHitmapInfoGenerator instance according to the hitmap information type.

Specified by:

createHitmapInfoGenerator in class IlvChartHitmapDefinition

Parameters:

infoType - The hitmap information type. One of IlvHitmapConstants.TOOLTIP_TYPE, IlvHitmapConstants.NAVIGATION_TYPE, IlvHitmapConstants.CURSOR_TYPE.

hitmap - the chart hitmap

Returns:

a IlvHitmapInfo instance.

Since:

JViews 8.8

See Also:

IlvAbstractChartHitmapInfoGenerator, IlvAbstractChartTooltipInfoGenerator, IlvAbstractChartNavigationInfoGenerator