org.jfree.chart.labels

Class CustomXYToolTipGenerator

java.lang.Object

org.jfree.chart.labels.CustomXYToolTipGenerator

All Implemented Interfaces:

Serializable, Cloneable, XYToolTipGenerator, PublicCloneable

public class CustomXYToolTipGenerator
extends Object
implements XYToolTipGenerator, Cloneable, PublicCloneable, Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomXYToolTipGenerator() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addToolTipSeries(List toolTips) Adds a list of tooltips for a series.
Object	clone() Returns an independent copy of the generator.
boolean	equals(Object obj) Tests if this object is equal to another.
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.
String	getToolTipText(int series, int item) Returns the tool tip text for an item.

Methods inherited from class java.lang.Object

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 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(List toolTips)

Adds a list of tooltips for a series.

Parameters:

toolTips - the list of tool tips.

generateToolTip

public 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.

clone

public Object clone()
             throws CloneNotSupportedException

Returns an independent copy of the generator.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - if cloning is not supported.

equals

public boolean equals(Object obj)

Tests if this object is equal to another.

Overrides:

equals in class Object

Parameters:

obj - the other object.

Returns:

A boolean.