org.jfree.chart.labels

Class CustomXYToolTipGenerator

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.
Constructor Summary
CustomXYToolTipGenerator()
Default constructor.
Method Summary
voidaddToolTipSeries(List toolTips)
Adds a list of tooltips for a series.
Objectclone()
Returns an independent copy of the generator.
booleanequals(Object obj)
Tests if this object is equal to another.
StringgenerateToolTip(XYDataset data, int series, int item)
Generates a tool tip text item for a particular item within a series.
intgetListCount()
Returns the number of tool tip lists stored by the renderer.
intgetToolTipCount(int list)
Returns the number of tool tips in a given list.
StringgetToolTipText(int series, int item)
Returns the tool tip text for an item.

Constructor Detail

CustomXYToolTipGenerator

public CustomXYToolTipGenerator()
Default constructor.

Method Detail

addToolTipSeries

public void addToolTipSeries(List toolTips)
Adds a list of tooltips for a series.

Parameters: toolTips the list of tool tips.

clone

public Object clone()
Returns an independent copy of the generator.

Returns: A clone.

Throws: CloneNotSupportedException if cloning is not supported.

equals

public boolean equals(Object obj)
Tests if this object is equal to another.

Parameters: obj the other object.

Returns: A boolean.

generateToolTip

public String generateToolTip(XYDataset data, int series, int item)
Generates a tool tip text item for a particular item within a series.

Parameters: data the dataset (ignored in this implementation). series the series (zero-based index). item the item (zero-based index).

Returns: The tooltip text.

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.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.