ilog.views.chart.servlet

Class IlvChartHitmapAccumulator

java.lang.Object

ilog.views.chart.servlet.IlvChartHitmap

ilog.views.chart.servlet.IlvChartHitmapAccumulator

public class IlvChartHitmapAccumulator
extends IlvChartHitmap

This class accumulates a hitmap, plus hitmap info for the tooltip interactor. Hitmap info for other purposes (highlighting, keyboard navigation, cursor, etc.) is not handled by this class.

An instance of this class is created at the beginning of the processing of a hitmap request, and is used to accumulate the tooltip and extensions for interactive effects.

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

Since:

JViews 8.7

See Also:

IlvChartServletSupport.HITMAP_REQUEST

Field Summary

Fields inherited from class ilog.views.chart.servlet.IlvChartHitmap

JViewsExtensions, JViewsToolTips

Method Summary

Modifier and Type	Method and Description
void	addHitmapAttribute(IlvChartAreaAccessible element, IlvIMapAttributes attribute) Add a hitmap IlvIMapAttributes attribute into the hitmap accumulator.
void	addRegionToGroup(int subRegion) Adds a given region to the current region, turning it into a group.
void	addRegionToGroup(int region, int subRegion) Adds a given region to another region, turning it into a group.
void	addToolTip(IlvIMapAttributes tooltip) Deprecated. Replaced by addHitmapAttribute(ilog.views.chart.accessibility.IlvChartAreaAccessible, ilog.views.chart.servlet.IlvIMapAttributes) method.
IlvChartAreaAccessible	getElementOfRegion(int region) Returns the chart area element that is associated to a given region.
Graphics2D	getGraphics() Returns a graphic context.
int[]	getGroupedRegions(int region) For a group region, returns the regions that are part of the group.
IlvIMapAttributes	getRegionAttributes(int region) Returns the interactive effects that are associated to a given region.
int	getRegionOfElement(IlvChartAreaAccessible element) Returns the index denoting the region that is associated with a given chart area element.
int	getRegionsCount() Returns the number of hitmap regions stored in this accumulator.
void	nextRegion() Starts a new region in the hitmap, with unchanged coordinate system.
void	nextRegion(IlvChart chart) Starts a new region in the hitmap, with an offset that corresponds to the chart's drawing rectangle.
void	nextRegion(int xOffset, int yOffset) Starts a new region in the hitmap, with an offset in the coordinate system compared to the origin of the hitmap.
void	setGraphics(Graphics2D gc) Sets the Graphic2D object.

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

getExtensions, getToolTips

Methods inherited from class java.lang.Object

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

Method Detail

getGraphics

public final Graphics2D getGraphics()

Returns a graphic context. Drawing into this graphic context produces a shape that gives rise to an object in the hitmap.

setGraphics

public void setGraphics(Graphics2D gc)

Sets the Graphic2D object.

Since:

JViews 8.8

nextRegion

public void nextRegion()

Starts a new region in the hitmap, with unchanged coordinate system.

Since:

JViews 8.8

nextRegion

public void nextRegion(int xOffset,
                       int yOffset)

Starts a new region in the hitmap, with an offset in the coordinate system compared to the origin of the hitmap.

Since:

JViews 8.8

nextRegion

public void nextRegion(IlvChart chart)

Starts a new region in the hitmap, with an offset that corresponds to the chart's drawing rectangle.

Since:

JViews 8.8

addRegionToGroup

public void addRegionToGroup(int subRegion)

Adds a given region to the current region, turning it into a group. Note that grouping is not recursive, therefore if the sub-region is itself a group, you have to recurse through its sub-regions explicitly and call addRegionToGroup for each.

Parameters:

subRegion - The index of the region that is to be added to the current region.

Since:

JViews 8.8

addRegionToGroup

public void addRegionToGroup(int region,
                             int subRegion)

Adds a given region to another region, turning it into a group. Note that grouping is not recursive, therefore if the sub-region is itself a group, you have to recurse through its sub-regions explicitly and call addRegionToGroup for each.

Parameters:

region - The index of the region that becomes a group.

subRegion - The index of the region that is to be added to region.

Since:

JViews 8.8

addToolTip

@Deprecated
public void addToolTip(IlvIMapAttributes tooltip)

Deprecated. Replaced by addHitmapAttribute(ilog.views.chart.accessibility.IlvChartAreaAccessible, ilog.views.chart.servlet.IlvIMapAttributes) method.

Adds IlvIMapAttributes object into the tooltip vector.

Parameters:

tooltip - An IlvIMapAttributes attribute that specifies a tooltip.

addHitmapAttribute

public void addHitmapAttribute(IlvChartAreaAccessible element,
                               IlvIMapAttributes attribute)

Add a hitmap IlvIMapAttributes attribute into the hitmap accumulator.

Parameters:

element - An element of the chart area, or null.

attribute - An IlvIMapAttributes attribute that specifies interactions, or null.

Since:

JViews 8.8

getRegionsCount

public int getRegionsCount()

Returns the number of hitmap regions stored in this accumulator.

Specified by:

getRegionsCount in class IlvChartHitmap

Since:

JViews 8.8

getGroupedRegions

public 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.

Specified by:

getGroupedRegions in class IlvChartHitmap

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.

Since:

JViews 8.8

getElementOfRegion

public IlvChartAreaAccessible getElementOfRegion(int region)

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

Specified by:

getElementOfRegion in class IlvChartHitmap

Parameters:

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

Returns:

A chart area element or null.

Since:

JViews 8.8

getRegionOfElement

public int getRegionOfElement(IlvChartAreaAccessible element)

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

Specified by:

getRegionOfElement in class IlvChartHitmap

Parameters:

element - A chart area element.

Returns:

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

Since:

JViews 8.8

getRegionAttributes

public IlvIMapAttributes getRegionAttributes(int region)

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

Specified by:

getRegionAttributes in class IlvChartHitmap

Parameters:

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

Returns:

Its attributes for interactive effects.

Since:

JViews 8.8