org.jfree.chart.tooltips
Class CustomXYToolTipGenerator

java.lang.Object
  |
  +--org.jfree.chart.tooltips.CustomXYToolTipGenerator

All Implemented Interfaces:

java.io.Serializable, ToolTipGenerator, XYToolTipGenerator

public class CustomXYToolTipGenerator

extends java.lang.Object

implements XYToolTipGenerator, java.io.Serializable

A tool tip generator that stores custom tooltips. The dataset passed into the generateToolTip method is ignored.

Author:

Richard Atkinson

See Also:

Serialized Form

Constructor Summary

CustomXYToolTipGenerator()
Default constructor.

Method Summary

void	addToolTipSeries(java.util.List toolTips) Adds a list of tooltips for a series.
boolean	equals(java.lang.Object o) Tests if this object is equal to another.
java.lang.String	generateToolTip(XYDataset data, int series, int item) Generates a tool tip text item for a particular item within a series.
int	getListCount() Returns the number of tool tip lists stored by the renderer.
int	getToolTipCount(int list) Returns the number of tool tips in a given list.
java.lang.String	getToolTipText(int series, int item) Returns the tool tip text for an item.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomXYToolTipGenerator

public CustomXYToolTipGenerator()

Default constructor.

Method Detail

getListCount

public int getListCount()

Returns the number of tool tip lists stored by the renderer.

Returns:

The list count.

getToolTipCount

public int getToolTipCount(int list)

Returns the number of tool tips in a given list.

Parameters:

list - the list index (zero based).

Returns:

The tooltip count.

getToolTipText

public java.lang.String getToolTipText(int series,
                                       int item)

Returns the tool tip text for an item.

Parameters:

series - the series index.

item - the item index.

Returns:

The tool tip text.

addToolTipSeries

public void addToolTipSeries(java.util.List toolTips)

Adds a list of tooltips for a series.

Parameters:

toolTips - the list of tool tips.

generateToolTip

public java.lang.String generateToolTip(XYDataset data,
                                        int series,
                                        int item)

Generates a tool tip text item for a particular item within a series.

Specified by:

generateToolTip in interface XYToolTipGenerator

Parameters:

data - the dataset (ignored in this implementation).

series - the series (zero-based index).

item - the item (zero-based index).

Returns:

the tooltip text.

equals

public boolean equals(java.lang.Object o)

Tests if this object is equal to another.

Overrides:

equals in class java.lang.Object

Parameters:

o - the other object.

Returns:

A boolean.