oracle.ord.media.chart.types
Class ImageMapDesc

java.lang.Object
  |
  +--oracle.ord.media.chart.types.ImageMapDesc

public class ImageMapDesc

extends java.lang.Object

ImageMap objects are used to define the attributes of HTML image maps generated by Chart Builder, and are supplied as parameters to setEnableImageMapCS(). A number of attributes are configurable, including the name of the image map, the choice of mouse event handlers, and the configuration of paths and extensions for sequenced HyperLinks.

The following image map event handlers can be selected:

• href
  
• onMouseOut
  
• onMouseOver
  
• onClick
  

The following example shows how to use an ImageMapDesc to define the attributes of an image map:

 
PieChart PieCh = new PieChart();
...

ImageMapDesc desc = new ImageMapDesc();
desc.setMapName("imports");

desc.getHrefDesc().setHyperLinkPrefix("images/");
desc.getHrefDesc().setTarget("_blank");

PieCh.setEnableImageMapCS(desc);

PieCh.drawBuffer(g2); 
char imageMap[] = PieCh.getImageMapCS();

Given that the pie chart has three slices, the resulting image map would be generated:

 
< map name="imports">
< area shape=poly coords=... href=images/imports0.html target=_blank >
< area shape=poly coords=... href=images/imports1.html target=_blank >
< area shape=poly coords=... href=images/imports2.html target=_blank >
</map>

For detailed examples, see the online tutorials.

See Also:

AxisChart.setEnableImageMapCS(ImageMapDesc), PieChart.setEnableImageMapCS(ImageMapDesc), SequencedHyperLinkDesc

Constructor Summary

ImageMapDesc()

Method Summary

java.lang.String	getFixedHref() Get the fixed href.
SequencedHyperLinkDesc	getHrefDesc() Get the href descriptor.
boolean	getIsFixedHref() Return true if the href is fixed.
java.lang.String	getMapName() Get the map name.
SequencedHyperLinkDesc	getOnClickDesc() Get the onClick descriptor.
SequencedHyperLinkDesc	getOnMouseOutDesc() Get the onMouseOut descriptor.
SequencedHyperLinkDesc	getOnMouseOverDesc() Get the onMouseOver descriptor.
java.lang.String	getReplacementImageName() Get the replacement image name.
void	setFixedHref(java.lang.String anchor) Set the fixed href.
void	setMapName(java.lang.String mapName) Set the name of the image map in the generated text.
void	setReplacementImageName(java.lang.String imageName) Set the name of the replacement image for the onMouseOver and onClick expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageMapDesc

public ImageMapDesc()

Method Detail

setMapName

public void setMapName(java.lang.String mapName)

Set the name of the image map in the generated text. For example, the mapName would be used in the following generated text: < map name = "mapName" >

Parameters:

mapName - Name of map in the generated text.

setReplacementImageName

public void setReplacementImageName(java.lang.String imageName)

Set the name of the replacement image for the onMouseOver and onClick expression. The replacement image is a named image. Often, the initial version of this image is on the page prior to any mouseover or mouse click. For example:

 
 Coupled image:
    < IMG NAME="expanded" SRC="monthly/US_Unemployment5.gif" align=left hspace=5 >

 Mouse Over Events cause a replacement:
    onMouseover = document.images['expanded'].src = 'monthly/US_Unemployment0.gif'" 
 

Parameters:

imageName - Name of the image in the generated onMouseOver or onClick expression.

setFixedHref

public void setFixedHref(java.lang.String anchor)

Set the fixed href.

getMapName

public java.lang.String getMapName()

Get the map name.

getReplacementImageName

public java.lang.String getReplacementImageName()

Get the replacement image name.

getFixedHref

public java.lang.String getFixedHref()

Get the fixed href.

getIsFixedHref

public boolean getIsFixedHref()

Return true if the href is fixed.

getHrefDesc

public SequencedHyperLinkDesc getHrefDesc()

Get the href descriptor.

getOnMouseOverDesc

public SequencedHyperLinkDesc getOnMouseOverDesc()

Get the onMouseOver descriptor.

getOnMouseOutDesc

public SequencedHyperLinkDesc getOnMouseOutDesc()

Get the onMouseOut descriptor.

getOnClickDesc

public SequencedHyperLinkDesc getOnClickDesc()

Get the onClick descriptor.