ilog.views.chart.servlet

Class IlvChartHitmapSupport

java.lang.Object

ilog.views.chart.servlet.IlvChartHitmapSupport

public class IlvChartHitmapSupport
extends Object

This class generates hitmaps and related information. This class is designed to work with IlvChartServletSupport.

Since:

JViews 8.7

Constructor Summary

Constructors

Constructor and Description
IlvChartHitmapSupport(IlvChartServletSupport support) Creates a IlvChartHitmapSupport.

Method Summary

Modifier and Type	Method and Description
protected IlvChartServletSupport	getChartServletSupport() Returns the image generating servlet support.
IlvChartHitmap	getHitmap() Gets the hitmap object.
IlvChartHitmapDefinition	getHitmapDefinition() Returns the hitmap definition used by this object.
JComponent	getViewComponent() Gets the view component.
void	handleRequest(jakarta.servlet.http.HttpServletResponse response, int width, int height, String compName) Handles a hitmap request.
void	registerHitmapInfoGenerator(String type, IlvAbstractChartHitmapInfoGenerator generator) Registers a hitmap info generator to be used for a given hitmap information type.
void	setHitmapDefinition(IlvChartHitmapDefinition definition) Sets the hitmap definition used by this object.
void	setHitmapDefinitionClassName(String className) Sets the classname of the hitmap definition.
void	setViewComponent(JComponent viewComp) Sets the view component.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartHitmapSupport

public IlvChartHitmapSupport(IlvChartServletSupport support)

Creates a IlvChartHitmapSupport.

Parameters:

support - The chart servlet support.

Method Detail

getChartServletSupport

protected IlvChartServletSupport getChartServletSupport()

Returns the image generating servlet support.

Returns:

The IlvChartServletSupport instance.

getHitmapDefinition

public IlvChartHitmapDefinition getHitmapDefinition()

Returns the hitmap definition used by this object.

See Also:

setHitmapDefinition(IlvChartHitmapDefinition)

setHitmapDefinition

public void setHitmapDefinition(IlvChartHitmapDefinition definition)

Sets the hitmap definition used by this object.

See Also:

getHitmapDefinition(), setHitmapDefinitionClassName(String)

setHitmapDefinitionClassName

public void setHitmapDefinitionClassName(String className)

Sets the classname of the hitmap definition. The class should extend IlvChartHitmapDefinition.

Parameters:

className - The class name of the hitmap definition.

See Also:

setHitmapDefinition(ilog.views.chart.servlet.IlvChartHitmapDefinition)

getHitmap

public IlvChartHitmap getHitmap()

Gets the hitmap object.

Returns:

the IlvChartHitmap object.

Since:

JViews 8.8

getViewComponent

public JComponent getViewComponent()

Gets the view component.

Returns:

the view component IlvChart or IlvLegend.

setViewComponent

public void setViewComponent(JComponent viewComp)

Sets the view component.

Parameters:

viewComp - the IlvChart or IlvLegend component.

handleRequest

public void handleRequest(jakarta.servlet.http.HttpServletResponse response,
                          int width,
                          int height,
                          String compName)
                   throws IOException,
                          jakarta.servlet.ServletException

Handles a hitmap request.

Parameters:

response - The HTTP servlet response

width - The width of the hitmap in pixels

height - The height of the hitmap in pixels

compName - The chart component

Throws:

IOException

jakarta.servlet.ServletException

registerHitmapInfoGenerator

public void registerHitmapInfoGenerator(String type,
                                        IlvAbstractChartHitmapInfoGenerator generator)

Registers a hitmap info generator to be used for a given hitmap information type.

Parameters:

type - A hitmap information type, such as IlvHitmapConstants.TOOLTIP_TYPE, IlvHitmapConstants.GROUP_TYPE, IlvHitmapConstants.CURSOR_TYPE, or IlvHitmapConstants.NAVIGATION_TYPE.

generator - A hitmap info generator.

Since:

JViews 8.8