public class

ImageMapUtilities

extends Object
java.lang.Object
   ↳ org.jfree.chart.imagemap.ImageMapUtilities

Class Overview

Collection of utility methods related to producing image maps. Functionality was originally in ChartUtilities.

Summary

Public Constructors
ImageMapUtilities()
Public Methods
static String getImageMap(String name, ChartRenderingInfo info)
Creates an image map element that complies with the XHTML 1.0 specification.
static String getImageMap(String name, ChartRenderingInfo info, ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)
Creates an image map element that complies with the XHTML 1.0 specification.
static String htmlEscape(String input)
Returns a string that is equivalent to the input string, but with special characters converted to HTML escape sequences.
static String javascriptEscape(String input)
Returns a string that is equivalent to the input string, but with special characters converted to JavaScript escape sequences.
static void writeImageMap(PrintWriter writer, String name, ChartRenderingInfo info)
Writes an image map to an output stream.
static void writeImageMap(PrintWriter writer, String name, ChartRenderingInfo info, ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)
Writes an image map to an output stream.
static void writeImageMap(PrintWriter writer, String name, ChartRenderingInfo info, boolean useOverLibForToolTips)
Writes an image map to an output stream.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ImageMapUtilities ()

Public Methods

public static String getImageMap (String name, ChartRenderingInfo info)

Creates an image map element that complies with the XHTML 1.0 specification.

Parameters
name the map name (null not permitted).
info the chart rendering info (null not permitted).
Returns
  • The map element.

public static String getImageMap (String name, ChartRenderingInfo info, ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)

Creates an image map element that complies with the XHTML 1.0 specification.

Parameters
name the map name (null not permitted).
info the chart rendering info (null not permitted).
toolTipTagFragmentGenerator a generator for the HTML fragment that will contain the tooltip text (null not permitted if info contains tooltip information).
urlTagFragmentGenerator a generator for the HTML fragment that will contain the URL reference (null not permitted if info contains URLs).
Returns
  • The map tag.

public static String htmlEscape (String input)

Returns a string that is equivalent to the input string, but with special characters converted to HTML escape sequences.

Parameters
input the string to escape (null not permitted).
Returns
  • A string with characters escaped.

public static String javascriptEscape (String input)

Returns a string that is equivalent to the input string, but with special characters converted to JavaScript escape sequences.

Parameters
input the string to escape (null not permitted).
Returns
  • A string with characters escaped.

public static void writeImageMap (PrintWriter writer, String name, ChartRenderingInfo info)

Writes an image map to an output stream.

Parameters
writer the writer (null not permitted).
name the map name (null not permitted).
info the chart rendering info (null not permitted).
Throws
IOException if there are any I/O errors.

public static void writeImageMap (PrintWriter writer, String name, ChartRenderingInfo info, ToolTipTagFragmentGenerator toolTipTagFragmentGenerator, URLTagFragmentGenerator urlTagFragmentGenerator)

Writes an image map to an output stream.

Parameters
writer the writer (null not permitted).
name the map name (null not permitted).
info the chart rendering info (null not permitted).
toolTipTagFragmentGenerator a generator for the HTML fragment that will contain the tooltip text (null not permitted if info contains tooltip information).
urlTagFragmentGenerator a generator for the HTML fragment that will contain the URL reference (null not permitted if info contains URLs).
Throws
IOException if there are any I/O errors.

public static void writeImageMap (PrintWriter writer, String name, ChartRenderingInfo info, boolean useOverLibForToolTips)

Writes an image map to an output stream.

Parameters
writer the writer (null not permitted).
name the map name (null not permitted).
info the chart rendering info (null not permitted).
useOverLibForToolTips whether to use OverLIB for tooltips (http://www.bosrup.com/web/overlib/).
Throws
IOException if there are any I/O errors.