ilog.views.sdm.servlet

Class IlvSDMImageMapAreaGenerator

java.lang.Object

ilog.views.servlet.IlvImageMapAreaGenerator

ilog.views.sdm.servlet.IlvSDMImageMapAreaGenerator

public class IlvSDMImageMapAreaGenerator
extends IlvImageMapAreaGenerator

An object used to generate an AREA element of an image map.

Since:

JViews 5.5

Field Summary

Fields inherited from class ilog.views.servlet.IlvImageMapAreaGenerator

CIRCLE_SHAPE, POLYGON_SHAPE, RECTANGLE_SHAPE

Constructor Summary

Constructors

Constructor and Description
IlvSDMImageMapAreaGenerator() Creates a new SDM image map generator.

Method Summary

Modifier and Type	Method and Description
String	generateALT(IlvManagerView view, IlvGraphic graphic) This method returns the ALT attribute of the area for the specified graphic object.
String	generateCOORDS(IlvManagerView view, IlvGraphic obj, IlvRect bounds, IlvTransformer t) This method returns the coordinates of the area for the specified graphic object.
String	generateHREF(IlvManagerView view, IlvGraphic graphic) This method returns the HREF attribute of the area for the specified graphic object.
String	getImageMapFunction() Returns the name of the function contained in the HREFs of the image map generated by this servlet.
int	getShape(IlvManagerView view, IlvGraphic obj, IlvTransformer t) This method returns the shape of the area for the specified graphic object.
void	setImageMapFunction(String function) Changes the name of the function contained in the HREFs of the image map generated by this servlet.

Methods inherited from class ilog.views.servlet.IlvImageMapAreaGenerator

generateONMOUSEOUT, generateONMOUSEOVER, generateTARGET, isGenerateManagerArea, setGenerateManagerArea, shouldGenerate

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSDMImageMapAreaGenerator

public IlvSDMImageMapAreaGenerator()

Creates a new SDM image map generator.

Method Detail

getShape

public int getShape(IlvManagerView view,
                    IlvGraphic obj,
                    IlvTransformer t)

This method returns the shape of the area for the specified graphic object. The default implementation returns IlvImageMapAreaGenerator.POLYGON_SHAPE for links or IlvImageMapAreaGenerator.RECTANGLE_SHAPE for nodes.

Overrides:

getShape in class IlvImageMapAreaGenerator

generateCOORDS

public String generateCOORDS(IlvManagerView view,
                             IlvGraphic obj,
                             IlvRect bounds,
                             IlvTransformer t)

This method returns the coordinates of the area for the specified graphic object. The default implementation returns coordinates corresponding to the bounding box of the object.

Overrides:

generateCOORDS in class IlvImageMapAreaGenerator

Parameters:

view - The manager view.

obj - The graphic object.

bounds - The bounding box.

t - The transformer.

generateHREF

public String generateHREF(IlvManagerView view,
                           IlvGraphic graphic)

This method returns the HREF attribute of the area for the specified graphic object.

The HREF can be specified in the style sheet using the property imageMapHRef.

If the HREF is not specified in the style sheet, the method returns a JavaScript call: javascript:select(id). The select function must be defined in the DHTML client. A different name for the JavaScript function can be specified in the style sheet using the property imageMapFunction. The default function can also be changed by calling setImageMapFunction(java.lang.String).

Overrides:

generateHREF in class IlvImageMapAreaGenerator

Parameters:

view - The manager view.

graphic - The graphic object.

setImageMapFunction

public void setImageMapFunction(String function)

Changes the name of the function contained in the HREFs of the image map generated by this servlet.

By default, the function name is select.

Parameters:

function - The new function name.

See Also:

generateHREF(ilog.views.IlvManagerView, ilog.views.IlvGraphic)

getImageMapFunction

public String getImageMapFunction()

Returns the name of the function contained in the HREFs of the image map generated by this servlet.

See Also:

setImageMapFunction(java.lang.String), generateHREF(ilog.views.IlvManagerView, ilog.views.IlvGraphic)

generateALT

public String generateALT(IlvManagerView view,
                          IlvGraphic graphic)

This method returns the ALT attribute of the area for the specified graphic object. The ALT attribute can be defined in the style sheet using the property imageMapAlt. If this property is not defined, the following fallbacks are attempted in turn: the name property, the toolTipText property, and finally the ID of the object.

Overrides:

generateALT in class IlvImageMapAreaGenerator

Parameters:

view - The manager view.

graphic - The graphic object.