public class

CustomXYToolTipGenerator

extends Object
implements Serializable Cloneable XYToolTipGenerator
java.lang.Object
   ↳ org.jfree.chart.labels.CustomXYToolTipGenerator

Class Overview

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

Summary

Public Constructors
CustomXYToolTipGenerator()
Default constructor.
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.jfree.chart.labels.XYToolTipGenerator

Public Constructors

public CustomXYToolTipGenerator ()

Default constructor.

Public Methods

public void addToolTipSeries (List toolTips)

Adds a list of tooltips for a series.

Parameters
toolTips the list of tool tips.

public Object clone ()

Returns an independent copy of the generator.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

public boolean equals (Object obj)

Tests if this object is equal to another.

Parameters
obj the other object.
Returns
  • A boolean.

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.

public int getListCount ()

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

Returns
  • The list count.

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.

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.