ilog.views.chart.servlet

Class IlvImageMapBuilder

java.lang.Object

ilog.views.chart.servlet.IlvImageMapBuilder

public class IlvImageMapBuilder
extends Object

The IlvImageMapBuilder class is used to generate client-side image maps from an IlvChart.

The provided methods generate strings that represent image map area tags. These strings have the following form:

  <area shape=... coords=... attributeList>
 

Each generated tag can be written within an image map definition inside an HTML file.

Since:

JViews 5.0

Constructor Summary

Constructors

Constructor and Description
IlvImageMapBuilder(IlvChart chart) Initializes a new builder to generate image map area tags for the specified chart.

Method Summary

Modifier and Type	Method and Description
IlvChart	getChart() Returns the chart with which the builder is associated.
String	getDataWindowTag(IlvDataWindow w, int yAxisIdx, IlvIMapAttributes attr, boolean chartOrigin) Generates an area tag corresponding to the specified data window.
String	getFooterTag(IlvIMapAttributes attr) Generates an area tag for the chart footer.
String	getHeaderTag(IlvIMapAttributes attr) Generates an area tag for the chart header.
String[]	getLegendItemTags(IlvIMapDefinition mapDef) Generates area tags for the legend items.
String	getLegendTag(IlvIMapAttributes attr) Generates an area tag for the chart legend.
String[]	getRendererTags(IlvIMapDefinition mapDef) Generates area tags for the chart renderers.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvImageMapBuilder

public IlvImageMapBuilder(IlvChart chart)

Initializes a new builder to generate image map area tags for the specified chart.

Method Detail

getChart

public final IlvChart getChart()

Returns the chart with which the builder is associated.

Since:

JViews 5.5

getFooterTag

public String getFooterTag(IlvIMapAttributes attr)

Generates an area tag for the chart footer.

Parameters:

attr - The attributes for the corresponding map area.

Returns:

The footer area tag, or null if there is no footer.

getHeaderTag

public String getHeaderTag(IlvIMapAttributes attr)

Generates an area tag for the chart header.

Parameters:

attr - The attributes for the corresponding map area.

Returns:

The header area tag, or null if there is no header.

getLegendTag

public String getLegendTag(IlvIMapAttributes attr)

Generates an area tag for the chart legend.

Parameters:

attr - The attributes for the corresponding map area.

Returns:

The legend area tag, or null if no legend has been added to the chart.

getLegendItemTags

public String[] getLegendItemTags(IlvIMapDefinition mapDef)

Generates area tags for the legend items.

Parameters:

mapDef - The map definition, which specifies how areas must be generated.

Returns:

An array of strings representing the area tags.

Since:

JViews 5.5

See Also:

IlvIMapArea.getTag()

getDataWindowTag

public String getDataWindowTag(IlvDataWindow w,
                               int yAxisIdx,
                               IlvIMapAttributes attr,
                               boolean chartOrigin)

Generates an area tag corresponding to the specified data window.

Parameters:

w - The considered data window.

yAxisIdx - The index of the chart y-axis.

attr - The attributes for the corresponding map area.

chartOrigin - A Boolean value indicating whether the chart is the origin of the image. If false, the origin of the image is the chart area component.

Returns:

The area tag.

getRendererTags

public String[] getRendererTags(IlvIMapDefinition mapDef)

Generates area tags for the chart renderers.

Parameters:

mapDef - The map definition, which specifies how areas must be generated.

Returns:

An array of strings representing the area tags.

See Also:

IlvIMapArea.getTag()