ilog.views.servlet

Class IlvCursorInfoGenerator

java.lang.Object

ilog.views.servlet.IlvAbstractHitmapInfoGenerator

ilog.views.servlet.IlvCursorInfoGenerator

All Implemented Interfaces:

IlvHitmapConstants, IlvHitmapInfoGenerator

public class IlvCursorInfoGenerator
extends IlvAbstractHitmapInfoGenerator
implements IlvHitmapConstants

This class defines information about which cursor to show over each region or graphic object.

Since:

JViews 8.8

See Also:

IlvHitmapConstants.CURSOR_TYPE

Field Summary

Fields inherited from class ilog.views.servlet.IlvAbstractHitmapInfoGenerator

hitmapDefinition

Fields inherited from interface ilog.views.util.hitmap.IlvHitmapConstants

COLON, CURSOR_TYPE, EXTENSIONS, GROUP_TYPE, HIT_INFO, JVIEWS_CURSOR_PROPERTY, JVIEWS_GROUP_PROPERTY, JVIEWS_HITINFOS, JViewsExtensions, JViewsTooltips, NAVIGATION_TYPE, REQUEST_TYPE, RIGHT_BRACE, TOOLTIP_TYPE

Constructor Summary

Constructors

Constructor and Description
IlvCursorInfoGenerator(IlvHitmapDefinition hitmapDefinition) The constructor.

Method Summary

Modifier and Type	Method and Description
String	buildInformation(String infoType) Builds the hitmap information for the given information type.
protected String	getRegionInfo(IlvGraphic graphic, String infoType) Gets hitmap information for the region of an individual IlvGraphic object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvCursorInfoGenerator

public IlvCursorInfoGenerator(IlvHitmapDefinition hitmapDefinition)

The constructor.

Parameters:

hitmapDefinition - the IlvHitmapDefinition instance.

Method Detail

buildInformation

public String buildInformation(String infoType)

Builds the hitmap information for the given information type. Overridden to wrap the getRegionInfo(IlvGraphic, String) results as strings, rather than as JSON objects.

Specified by:

buildInformation in interface IlvHitmapInfoGenerator

Overrides:

buildInformation in class IlvAbstractHitmapInfoGenerator

Returns:

The hitmap information of the given type, containing the region infos for all regions and that type.

getRegionInfo

protected String getRegionInfo(IlvGraphic graphic,
                               String infoType)

Gets hitmap information for the region of an individual IlvGraphic object. This method fetches the IlvHitmapConstants.JVIEWS_CURSOR_PROPERTY property value.

Specified by:

getRegionInfo in class IlvAbstractHitmapInfoGenerator

Parameters:

graphic - The IlvGraphic object.

infoType - The type of hitmap information.

Returns:

The hitmap information for the region of the graphic object.