netcharts.pro.util
Class NFImageMapCreator

java.lang.Object
  |
  +--netcharts.pro.util.NFImageMapCreator

public class NFImageMapCreator

extends java.lang.Object

Used to generate an HTML image map based upon a collection of NFServerGeneratedImage.MapElement instances.

Field Summary

static java.lang.String	DEFAULT_HREF Default href that is used when no user specified href or default href is specified.
static java.lang.String	HREF_REPLACE The text in the onMouseOver or onMouseOut String that will be replaced by the url value.
static java.lang.String	INDEX_REPLACE The text in the onMouseOver or onMouseOut String that will be replaced by the selectedItemIndex value of the MapElement.
static java.lang.String	LABEL_REPLACE The text in the onMouseOver or onMouseOut String that will be replaced by the label value in createImageMap.
static java.lang.String	PARAM_REPLACE The text in the onMouseOver or onMouseOut String that will be replaced by the selectedItemParam value of the MapElement.
static java.lang.String	TARGET_REPLACE The text in the onMouseOver or onMouseOut String that will be replaced by the target value.

Constructor Summary

NFImageMapCreator()

Method Summary

static java.lang.String	createImageMap(NFServerGeneratedImage.MapElement[] mapElements, java.lang.String mapName, java.lang.String onMouseOver, java.lang.String onMouseOut, java.lang.String defaultHref) Creates an image map using the given parameters.
static java.lang.String	createImageMap(NFServerGeneratedImage.MapElement[] mapElements, java.lang.String mapName, java.lang.String onMouseOver, java.lang.String onMouseOut, java.lang.String alt, java.lang.String defaultHref) Creates an image map using the given parameters.

Methods inherited from class java.lang.Object

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

Field Detail

LABEL_REPLACE

public static final java.lang.String LABEL_REPLACE

The text in the onMouseOver or onMouseOut String that will be replaced by the label value in createImageMap.

HREF_REPLACE

public static final java.lang.String HREF_REPLACE

The text in the onMouseOver or onMouseOut String that will be replaced by the url value.

TARGET_REPLACE

public static final java.lang.String TARGET_REPLACE

The text in the onMouseOver or onMouseOut String that will be replaced by the target value.

INDEX_REPLACE

public static final java.lang.String INDEX_REPLACE

The text in the onMouseOver or onMouseOut String that will be replaced by the selectedItemIndex value of the MapElement.

PARAM_REPLACE

public static final java.lang.String PARAM_REPLACE

The text in the onMouseOver or onMouseOut String that will be replaced by the selectedItemParam value of the MapElement.

DEFAULT_HREF

public static final java.lang.String DEFAULT_HREF

Default href that is used when no user specified href or default href is specified.

Constructor Detail

NFImageMapCreator

public NFImageMapCreator()

Method Detail

createImageMap

public static java.lang.String createImageMap(NFServerGeneratedImage.MapElement[] mapElements,
                                              java.lang.String mapName,
                                              java.lang.String onMouseOver,
                                              java.lang.String onMouseOut,
                                              java.lang.String defaultHref)

Creates an image map using the given parameters.

Parameters:

mapElements - Array of MapElement objects. MapElements contain a shape that specifies coordinates for the area tag in the image map. It also provides target, href, label information.

mapName - The name of the image map.

onMouseOver - String containing javascript to run on the onMouseOver event of the area tag.

onMouseOut - String containing javascript to run on the onMouseOut event of the area tag.

createImageMap

public static java.lang.String createImageMap(NFServerGeneratedImage.MapElement[] mapElements,
                                              java.lang.String mapName,
                                              java.lang.String onMouseOver,
                                              java.lang.String onMouseOut,
                                              java.lang.String alt,
                                              java.lang.String defaultHref)

Creates an image map using the given parameters.

Parameters:

mapElements - Array of MapElement objects. MapElements contain a shape that specifies coordinates for the area tag in the image map. It also provides target, href, label information.

mapName - The name of the image map.

onMouseOver - String containing javascript to run on the onMouseOver event of the area tag.

onMouseOut - String containing javascript to run on the onMouseOut event of the area tag.

alt - String containing text for alt and title attributes of the area tag.

defaultHref - Href to use if one isn't defined for the area tag.