IlvHitmapDefinition (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.servlet.IlvHitmapDefinition

All Implemented Interfaces:

IlvHitmapConstants
```
public class IlvHitmapDefinition
extends Object
implements IlvHitmapConstants
```
This class generates hitmap relation information such as tooltips. Programmers can override this class to customize the tooltips generated for graphic objects. See IlvManagerServlet for how to install customized hitinfo manager.
This class is designed to be used in the following way:
1. Call init(IlvManagerView) before rendering the hitmap.
2. Call addGraphic(IlvGraphic) to add graphic objects their hitmap information and tooltips will be generated.
3. Call renderHitmap() to render the hitmap for all the graphic objects added.
4. Call dispose() to release resources allocated.
When customizing the tooltip generation, you need to override the getTooltip(IlvGraphic) method to return the customized tooltip. Since JViews 8.8, we introduce a new hitmap information structure, so we can call registerHitmapInfoGenerator(String, IlvHitmapInfoGenerator) to extend the hitmap information. There is a default abstract hitmap infor implementation IlvAbstractHitmapInfoGenerator. We can define a subclass of IlvAbstractHitmapInfoGenerator to customize hitmap information.
Since:

JViews 8.7

Field Summary
- 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

IlvHitmapDefinition()
Creates a hitmap definition.

Constructors
Constructor and Description
`IlvHitmapDefinition()` Creates a hitmap definition.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addGraphic(IlvGraphic graphic)` Adds a graphic object to the managed list.
`protected IlvHitmapInfoGenerator`	`createHitmapInfoGenerator(String infoType)` Returns the object that will build the hitmap information for the given hitmap information type.
`void`	`dispose()` Releases the resources used when rendering the hitmap.
`String`	`getDefinition()` Deprecated.
`String`	`getDefinition(StringTokenizer typeToken)` Gets the hitmap definition, according to the type token to append the hitmap informations.
`protected String`	`getExtension(IlvGraphic graphic)` You can override this method to create javascript function, this function will be called by tooltip mouse down event.
`String`	`getExtensions()` Returns the extensions for hitmap.
`Vector<IlvGraphic>`	`getGraphics()` Returns the vector of the managed graphic objects
`String[]`	`getHitmapLayers()` Gets the layers that will generate hitmap.
`IlvManagerView`	`getManagerView()` Returns the manager view.
`protected String`	`getTooltip(IlvGraphic graphic)` Deprecated. replaced by `IlvTooltipInfoGenerator.getRegionInfo(ilog.views.IlvGraphic, java.lang.String)`
`void`	`init(IlvManagerView view)` Initializes a hitmap definition for the given view.
`void`	`init(IlvManagerView view, int dx, int dy)` Initializes a hitmap definition for the given view and delta X, delta Y.
`void`	`registerHitmapInfoGenerator(String infoType, IlvHitmapInfoGenerator generator)` Registers a hitmap info generator to be used for a given hitmap information type.
`void`	`renderHitmap()` Renders the hitmap for the graphic objects.
`void`	`renderHitmap(int deltaX, int deltaY)` Renders the hitmap for the graphic objects with delta X and delta Y.
`void`	`setHitmapLayers(String[] hitmapLayers)` Sets the layers that will generate hitmap.
`void`	`setManagerView(IlvManagerView view)` Sets the manager view.
`boolean`	`shouldRender(IlvGraphic graphic)` Tells whether the hitmap should be rendered for a given graphic object.
`void`	`unregisterHitmapInfoGenerator(String infoType)` Remove the hitmap information handler according to `infoType`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvHitmapDefinition
```
public IlvHitmapDefinition()
```
    Creates a hitmap definition.
- Method Detail
  - registerHitmapInfoGenerator
```
public void registerHitmapInfoGenerator(String infoType,
                                        IlvHitmapInfoGenerator generator)
```
    Registers a hitmap info generator to be used for a given hitmap information type. This method is usually called in the init method of servlet.
    Code example:
```
 IlvHitmapDefinition hitmapDefinition = getServletSupport().getHitmapSupport().getHitmapDefinition();
 hitmapDefinition.registerHitmapInfoGenerator(IlvHitmapConstants.TOOLTIP_TYPE, new MyTooltipInfoGenerator(hitmapDefinition));
 
```
    Parameters:
    
    infoType - 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
    
    See Also:
    
    unregisterHitmapInfoGenerator(String)
  - unregisterHitmapInfoGenerator
```
public void unregisterHitmapInfoGenerator(String infoType)
```
    Remove the hitmap information handler according to infoType
    
    Parameters:
    
    infoType - The hitmap information type.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    registerHitmapInfoGenerator(String, IlvHitmapInfoGenerator)
  - init
```
public void init(IlvManagerView view)
```
    Initializes a hitmap definition for the given view.
    
    Parameters:
    
    view - The manager view.
  - init
```
public void init(IlvManagerView view,
                 int dx,
                 int dy)
```
    Initializes a hitmap definition for the given view and delta X, delta Y.
    
    Parameters:
    
    view - The IlvManagerView object.
    
    dx - The delta X pixel.
    
    dy - The delta Y pixel.
    
    Since:
    
    JViews 8.8
  - addGraphic
```
public void addGraphic(IlvGraphic graphic)
```
    Adds a graphic object to the managed list.
    
    Parameters:
    
    graphic - The graphic object to add.
  - getGraphics
```
public Vector<IlvGraphic> getGraphics()
```
    Returns the vector of the managed graphic objects
    
    Returns:
    
    The vector of the managed graphic objects. Programmers should not modify the returned vector.
  - getManagerView
```
public IlvManagerView getManagerView()
```
    Returns the manager view.
    
    Returns:
    
    The manager view.
  - setManagerView
```
public void setManagerView(IlvManagerView view)
```
    Sets the manager view.
    
    Parameters:
    
    view - The manager view.
  - shouldRender
```
public boolean shouldRender(IlvGraphic graphic)
```
    Tells whether the hitmap should be rendered for a given graphic object. If returns false the hitmap support will simply imgnore this graphic object. Nothing will be generated for this graphic object. For example, it is not recommended to generate hitmap information for background graphic objects.
    This method will be called by the hitmap generator for each visible graphic object.The default inplementaion return always true. Programmers can override this method to tell whether the hitmap should be generated.
    
    Parameters:
    
    graphic - The graphic object check.
    
    Returns:
    
    Whether the hitmap should be rendered for the graphic object.
  - renderHitmap
```
public void renderHitmap()
```
    Renders the hitmap for the graphic objects.
  - renderHitmap
```
public void renderHitmap(int deltaX,
                         int deltaY)
```
    Renders the hitmap for the graphic objects with delta X and delta Y.
    
    Parameters:
    
    deltaX - The delta X.
    
    deltaY - The delta Y.
    
    Since:
    
    JViews 8.8
  - getDefinition
```
@Deprecated
public String getDefinition()
```
    Deprecated.
    
    Returns the encoded hitmap and also the tooltips.
    
    Returns:
    
    the encoded hitmap and also the tooltips.
  - getDefinition
```
public String getDefinition(StringTokenizer typeToken)
```
    Gets the hitmap definition, according to the type token to append the hitmap informations. For example, tooltip, cusor, group etc.
    
    Parameters:
    
    typeToken - The type token.
    
    Returns:
    
    the hitmap definition String object.
    
    Since:
    
    JViews 8.8
  - createHitmapInfoGenerator
```
protected IlvHitmapInfoGenerator createHitmapInfoGenerator(String infoType)
```
    Returns the object that will build the hitmap information for the given hitmap information type.
    The default return value is null.
    You can override this method when you add new hitmap information types.
    For specifying the hitmap information generator that is used for a given information type, you can use the registerHitmapInfoGenerator(String, IlvHitmapInfoGenerator) method.
    
    Parameters:
    
    infoType - The hitmap information type.
    
    Returns:
    
    An IlvHitmapInfoGenerator object.
    
    Since:
    
    JViews 8.8
  - getExtensions
```
public String getExtensions()
```
    Returns the extensions for hitmap. The tooltip interactor will use this information to deal with mouse down events.
    
    Since:
    
    JViews 8.8
  - getExtension
```
protected String getExtension(IlvGraphic graphic)
```
    You can override this method to create javascript function, this function will be called by tooltip mouse down event.
    
    Parameters:
    
    graphic - The IlvGraphic object.
    
    Returns:
    
    extension of hitmap, default value is a blank string.
    
    Since:
    
    JViews 8.8
  - dispose
```
public void dispose()
```
    Releases the resources used when rendering the hitmap.
  - getTooltip
```
@Deprecated
protected String getTooltip(IlvGraphic graphic)
```
    Deprecated. replaced by IlvTooltipInfoGenerator.getRegionInfo(ilog.views.IlvGraphic, java.lang.String)
    
    Gets the tooltip for the the graphic object.
    
    Parameters:
    
    graphic - The graphic.
    
    Returns:
    
    the tooltip of the IlvGraphic object.
  - setHitmapLayers
```
public void setHitmapLayers(String[] hitmapLayers)
```
    Sets the layers that will generate hitmap.
    
    Parameters:
    
    hitmapLayers - The array of layers.
    
    Since:
    
    JViews 8.8
  - getHitmapLayers
```
public String[] getHitmapLayers()
```
    Gets the layers that will generate hitmap.
    
    Returns:
    
    The array of layers that will generate hitmap.
    
    Since:
    
    JViews 8.8

Class IlvHitmapDefinition

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvHitmapDefinition

Method Detail

registerHitmapInfoGenerator

unregisterHitmapInfoGenerator

init

init

addGraphic

getGraphics

getManagerView

setManagerView

shouldRender

renderHitmap

renderHitmap

getDefinition

getDefinition

createHitmapInfoGenerator

getExtensions

getExtension

dispose

getTooltip

setHitmapLayers

getHitmapLayers